sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

No space before fullstop and comma

Browse source 
No parse errors in examples


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@191272 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2005-07-23 11:08:37 +00:00
parent 2af11f173a
commit 1a9b341bc9
5 changed files with 49 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
reference/sdo/reference.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<reference id="ref.sdo">
<title>SDO Functions</title>
@ -65,11 +65,10 @@
</para>
<para>
SDO
<link linkend="ref.sdo-das-xml">XML Data Access Service</link>
, which is built as part of this extension, requires libxml2
<link linkend="ref.sdo-das-xml">XML Data Access Service</link>,
which is built as part of this extension, requires libxml2
(Tested with libxml2 2.6.19) which can be downloaded from
<ulink url='&url.libxml;'>&url.libxml;</ulink>
.
<ulink url='&url.libxml;'>&url.libxml;</ulink>.
</para>
</section>
@ -95,8 +94,7 @@
</para>
<para>
Note, if you built your PHP installation in a different location, using
<filename>--prefix</filename>
,
<filename>--prefix</filename>,
then you will need to adjust the
<command>./configure</command>
steps below accordingly.
@ -128,8 +126,7 @@
<step>
<para>
The following step is required to ensure
<command>g++</command>
, and NOT
<command>g++</command>, and NOT
<command>gcc</command>
is used to build the the libraries.
</para>
@ -140,8 +137,7 @@
change the line which says
<command>CC="gcc"</command>
to
<command>CC="g++"</command>
.
<command>CC="g++"</command>.
</para>
</step>
<step>
@ -161,8 +157,8 @@
<step>
<para>
Run
<command>phpize</command>
, which will set up the environment to compile both SDO and the
<command>phpize</command>,
which will set up the environment to compile both SDO and the
XML Data Access Service.
</para>
</step>
@ -473,7 +469,7 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
<![CDATA[
<?php
foreach ($company as $name => $value) {
...
// ...
}
?>
]]>
@ -502,7 +498,7 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
<![CDATA[
<?php
foreach ($company->departments as $department) {
...
// ...
}
?>
]]>
@ -510,8 +506,7 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
<para>
Each iteration will assign the next department in the
list to the variable
<command>$department</command>
.
<command>$department</command>.
</para>
</example>
</para>
@ -680,7 +675,7 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
<programlisting role="php" id="sdo.examples.unsetrefdo">
<![CDATA[
<?php
if (isset($company->employeeOfTheMonth) {
if (isset($company->employeeOfTheMonth)) {
unset($company->employeeOfTheMonth);
}
?>
@ -821,8 +816,7 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
(shown in the table above).
The following examples assume the letter instance has been
loaded into a data object referenced by the variable
<command>$letter</command>
.
<command>$letter</command>.
<example>
<title>Getting the SDO_Sequence interface</title>
<para>
@ -878,7 +872,7 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
<![CDATA[
<?php
foreach ($letter->getSequence() as $value) {
...
// ...
}
?>
]]>
@ -1174,9 +1168,7 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
The interface through which a Data Access Service can access
a data object's
<link linkend='sdo.class.sdodas-changesummary'>
SDO_DAS_ChangeSummary
</link>
.
SDO_DAS_ChangeSummary</link>.
The change summary is used by the Data Access Service to check for
conflicts when applying changes back to a data source.
</para>

19
reference/sdo_das_xml/reference.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<reference id="ref.sdo-das-xml">
<title>SDO XML Data Access Service Functions</title>
@ -18,8 +18,7 @@
the data graph, the data object, XPath and property expressions,
and so on.
If you are not familiar with these ideas, you might want to look first at
<link linkend='ref.sdo'>the section on SDO</link>
.
<link linkend='ref.sdo'>the section on SDO</link>.
</para>
<para>
The job of the XML DAS is to move data between the
@ -53,8 +52,7 @@
&reftitle.install;
<para>
The XML Data Access Service is packaged and installed as part of the
<link linkend='ref.sdo'>SDO extension</link>
.
<link linkend='ref.sdo'>SDO extension</link>.
There are additional installations steps required.
</para>
</section>
@ -247,13 +245,11 @@
The following examples are based on the
<link linkend="sdo.sample.sequence">letter example</link>
described in the
<link linkend="ref.sdo">SDO documentation</link>
.
<link linkend="ref.sdo">SDO documentation</link>.
The examples assume the XML Schema for the letter is contained in a file
<filename>letter.xsd</filename>
and the letter instance is in the file
<filename>letter.xml</filename>
.
<filename>letter.xml</filename>.
</para>
<example>
@ -388,7 +384,7 @@ try {
$xmldas = SDO_DAS_XML::create("letter.xsd");
$xdoc = $xmldas->loadFromFile("letter.xml");
print("Encoding is set to : " . $xdoc->getEncoding());
print("XML Version : " . $xdoc->getXMLVersion();
print("XML Version : " . $xdoc->getXMLVersion());
$xdoc->setXMLVersion("1.1");
print($xmldas->saveDocumentToString($xdoc));
} catch (SDO_TypeNotFoundException $e) {
@ -638,8 +634,7 @@ try {
</title>
<para>
Is a subclass of
<classname>SDO_Exception</classname>
.
<classname>SDO_Exception</classname>.
Thrown for any parser errors while loading the xsd/xml file.
</para>
</section>

19
reference/sdodasrel/functions/SDO-DAS-Relational-construct.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.SDO-DAS-Relational-construct">
<refnamediv>
<refname>SDO_DAS_Relational::__construct</refname>
@ -45,14 +45,10 @@
<para>
An array containing one or more table definitions,
each of which is an associative array containing the keys
<varname>name</varname>
,
<varname>columns</varname>
,
<varname>PK</varname>
, and optionally,
<varname>FK</varname>
.
<varname>name</varname>,
<varname>columns</varname>,
<varname>PK</varname>, and optionally,
<varname>FK</varname>.
For a full discussion of the metadata, see the
<link linkend='sdo.das.rel.metadata'>metadata</link>
section in the general information about the Relational DAS.
@ -81,8 +77,7 @@
each of which is an associative array containing the keys
<varname>parent</varname>
and
<varname>child</varname>
.
<varname>child</varname>.
The containment relations describe how the types in the model
are connected to form a tree.
The type specified as the application root type must be present
@ -110,7 +105,7 @@
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
<function>SDO_DAS_Relational::construct</function>
<function>SDO_DAS_Relational::__construct</function>
throws a SDO_DAS_Relational_Exception if
any problems are found in the metadata.
</para>

5
reference/sdodasrel/functions/SDO-DAS-Relational-executeQuery.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.SDO-DAS-Relational-executeQuery">
<refnamediv>
<refname>SDO_DAS_Relational::executeQuery</refname>
@ -78,8 +78,7 @@ $dbh = new PDO("mysql:dbname=COMPANYDB;host=localhost",DATABASE_USER,DATABASE_PA
In these cases a column specifier is needed,
which is an array that identifies the columns.
Each entry in the array is simply a string in the form
<varname>table-name.column_name</varname>
.
<varname>table-name.column_name</varname>.
</para>

41
reference/sdodasrel/reference.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<reference id="ref.sdo.das.rel">
<title>SDO Relational Data Access Service Functions</title>
@ -19,15 +19,13 @@
the data graph, the data object, the disconnected way of working,
the change summary, XPath and property expressions, and so on.
If you are not familiar with these ideas, you might want to look first at
<link linkend='ref.sdo'>the section on SDO</link>
.
<link linkend='ref.sdo'>the section on SDO</link>.
In addition, the Relational DAS makes use of the PDO extension to
isolate itself from specifics of different back-end relational databases.
In order to use the Relational DAS you will need to be able to
create and pass a PDO database connection;
for this reason you might also want to take a look at
<link linkend='ref.pdo'>the section on PDO</link>
.
<link linkend='ref.pdo'>the section on PDO</link>.
</para>
<para>
@ -100,8 +98,7 @@
of the Relational DAS must be constructed, using the
same metadata, and another connection to the database obtained.
These, plus the data graph itself, are passed to
<function>applyChanges</function>
.
<function>applyChanges</function>.
At this point the Relational DAS examines the change summary
and generates the necessary INSERT, UPDATE and DELETE SQL statements
to apply the changes. The UPDATE and DELETE statements are qualified
@ -118,8 +115,8 @@
There are other ways of working with the data in the database:
it is possible to just create data objects and write them to the
database without a preliminary call to
<function>executeQuery</function>
, for example. This scenario and others are explored in the
<function>executeQuery</function>,
for example. This scenario and others are explored in the
<link linkend="sdo.das.rel.examples">Examples</link>
section below.
</para>
@ -356,7 +353,7 @@ $company_table = array (
);
$department_table = array (
'name' => 'department',
'columns' => array('id', 'name', 'location' , 'number', 'co_id'),
'columns' => array('id', 'name', 'location', 'number', 'co_id'),
'PK' => 'id',
'FK' => array (
'from' => 'co_id',
@ -705,13 +702,12 @@ $das -> applyChanges($dbh, $root);
</para>
<para>
In this example the third argument to
<function>executeQuery</function>
, the column specifier is needed as there are other tables in the
<function>executeQuery</function>,
the column specifier is needed as there are other tables in the
metadata with column names of
<varname>name</varname>
and
<varname>id</varname>
.
<varname>id</varname>.
If there were no possible ambiguity it could be omitted.
</para>
<programlisting role="php" id="sdo.das.rel.examples.1c-R">
@ -765,8 +761,8 @@ foreach ($root['company'] as $company) {
<para>
In this example the same instance of the Relational DAS is reused
for the
<function>applyChanges</function>
, as is the PDO database handle. This is quite alright; it also
<function>applyChanges</function>,
as is the PDO database handle. This is quite alright; it also
alright to allow the previous instances to be garbage collected
and to obtain new instances. No state data regarding the graph
is held the Relational DAS once it has returned a data graph to
@ -1099,8 +1095,7 @@ $das -> applyChanges($dbh, $root);
the company, department, and employee tables. These introduce the final
piece of function not exercised by the examples above: the
non-containment reference
<varname>employee_of_the_month</varname>
.
<varname>employee_of_the_month</varname>.
</para>
<para>
Like the examples above for company and department, this set of examples
@ -1229,7 +1224,7 @@ $name = 'Acme';
$root = $das->executeQuery($dbh,
'select c.id, c.name, c.employee_of_the_month, d.id, d.name, e.id, e.name ' .
'from company c, department d, employee e ' .
'where e.dept_id = d.id and d.co_id = c.id and c.name="' . $name . '";' ,
'where e.dept_id = d.id and d.co_id = c.id and c.name="' . $name . '";',
array('company.id','company.name','company.employee_of_the_month',
'department.id','department.name','employee.id','employee.name'));
$acme = $root['company'][0];
@ -1289,7 +1284,7 @@ $name='MegaCorp';
$root = $das->executeQuery($dbh,
'select c.id, c.name, c.employee_of_the_month, d.id, d.name, e.id, e.name ' .
'from company c, department d, employee e ' .
'where e.dept_id = d.id and d.co_id = c.id and c.name="' . $name . '";' ,
'where e.dept_id = d.id and d.co_id = c.id and c.name="' . $name . '";',
array('company.id','company.name','company.employee_of_the_month',
'department.id','department.name','employee.id','employee.name'));
$megacorp = $root['company'][0];
@ -1403,11 +1398,9 @@ echo "Deleted the company, departments and employees all in one go.\n";
</title>
<para>
Is a subclass of PHP's
<classname>Exception</classname>
.
<classname>Exception</classname>.
It adds no behaviour to
<classname>Exception</classname>
.
<classname>Exception</classname>.
Thrown, with useful descriptive text, to signal errors in the
metadata or unexpected failures to perform SQL operations.
</para>