cvs: pear /DB_DataObject/doc packages.db.dataobject.autobuilding.html packages.db.dataobject.configuration.html packages.db.dataobject.filters.html
packages.db.dataobject.find_fetch.html packages.db.dataobject.introduction.html packages.db.dataobject.links.html packages.db.dataobject.updating.html
| From: | Alan Knowles | Date: | Thu, 11 Jul 2002 06:26:20 +0000 |
| Subject: | cvs: pear /DB_DataObject/doc packages.db.dataobject.autobuilding.html packages.db.dataobject.configuration.html packages.db.dataobject.filters.html packages.db.dataobject.find_fetch.html packages.db.dataobject.introduction.html packages.db.dataobject.links.html packages.db.dataobject.updating.html |
||
| Groups: | php.pear.cvs | ||
| Request: | Send a blank email to pear-cvs+get-5027@lists.php.net to get a copy of this message | ||
alan_k Thu Jul 11 02:26:20 2002 EDT
Modified files:
/pear/DB_DataObject/doc packages.db.dataobject.autobuilding.html
packages.db.dataobject.configuration.html
packages.db.dataobject.filters.html
packages.db.dataobject.find_fetch.html
packages.db.dataobject.introduction.html
packages.db.dataobject.links.html
packages.db.dataobject.updating.html
Log:
updated html with typos fixed
Index: pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html Thu Jul 11 02:26:19 2002 @@ -1,7 +1,7 @@ <HTML ><HEAD ><TITLE ->AutoBuilding</TITLE +>Auto Building</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ @@ -72,13 +72,13 @@ WIDTH="100%"></DIV ><H1 ><A -NAME="packages.DB.DataObject.autobuilding">AutoBuilding</H1 +NAME="packages.DB.DataObject.autobuilding">Auto Building</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN3851" ></A ->AutoBuilding -- +>Auto Building -- creating the base Classes and Database schema </DIV ><DIV @@ -87,11 +87,11 @@ NAME="AEN3854" ></A ><H2 ->What the AutoBuilder (createTables.php) Does</H2 +>What the Auto Builder (createTables.php) Does</H2 ><P > One of the essential features of an SQL building tool is to to have some understanding of the database structure, So that Integers can be checked, and strings can be escaped. There a few ways - that Quering the database for the table structre could be accomplished + that Querying the database for the table structure could be accomplished <P ></P @@ -116,11 +116,11 @@ ><P > The other key concept of DB_DataObject is that you work with extended classes of DB_DataObject, which do all the 'table' related work. Setting up these classes for a large database can be time consuming, so - the createTables.php file will automatically bulid the skeletons for all these class files. + the createTables.php file will automatically build the skeletons for all these class files. </P ><P > - To start the autobuilder simply go to the pear/DB/DataObject/ directory, and type + To start the auto builder simply go to the pear/DB/DataObject/ directory, and type <B CLASS="command" >c:\php4\php.exe createTables.php myconfig.ini</B Index: pear/DB_DataObject/doc/packages.db.dataobject.configuration.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.configuration.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.configuration.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.configuration.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.configuration.html Thu Jul 11 02:26:19 2002 @@ -16,7 +16,7 @@ TITLE="Introduction" HREF="packages.db.dataobject.introduction.html"><LINK REL="NEXT" -TITLE="AutoBuilding" +TITLE="Auto Building" HREF="packages.db.dataobject.autobuilding.html"><META HTTP-EQUIV="Content-type" CONTENT="text/html; charset=ISO-8859-1"></HEAD @@ -275,7 +275,7 @@ NAME="AEN3803" ></A ><H2 ->Configuration Options - Mulitiple Databases (optional)</H2 +>Configuration Options - Multiple Databases (optional)</H2 ><P ></P ><DIV @@ -291,7 +291,7 @@ string</DT ><DD ><P -> When you have multiple databases you can use the database_* to specifiy the dsn for each +> When you have multiple databases you can use the database_* to specify the dsn for each database </P ><P @@ -412,7 +412,7 @@ > The Directory where your DataObject extended Classes are. </P ><P -> Used by the Class AutoBuilder when updating/writing to your class definitions. +> Used by the Class Auto Builder when updating/writing to your class definitions. </P ></DD ><DT @@ -510,7 +510,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ->AutoBuilding</TD +>Auto Building</TD ></TR ></TABLE ></DIV Index: pear/DB_DataObject/doc/packages.db.dataobject.filters.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.filters.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.filters.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.filters.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.filters.html Thu Jul 11 02:26:19 2002 @@ -96,9 +96,9 @@ ><P > The DB_DataObject class does not handle JOIN queries directly for the simple reason that it is designed to simplify the use of databases, and make the code that access them clear and easy to read. Having - experimented with a Join Version, it became very clear that this did not fulfil either of these goals, and + experimented with a Join Version, it became very clear that this did not fulfill either of these goals, and made the resulting code more difficult to read, debug and understand. So in reality it is best to use the - raw query() method to do join'ed queries.. + raw query() method to do joined queries.. </P ></DIV ><DIV @@ -203,7 +203,7 @@ ></P ></DIV ><P -> By default a select query will request all items '*', to change this behaviour you can first call +> By default a select query will request all items '*', to change this behavior you can first call selectAdd() without any arguments to clear the current request and then add the specific items you require. <TABLE @@ -331,7 +331,7 @@ ></DIV ><P > Adds items to the where part of a SQL query. Calling this without any arguments clears, - the where condition. The default behaviour is to add 'AND' queries, send the string 'OR' to + the where condition. The default behavior is to add 'AND' queries, send the string 'OR' to append OR conditions. <TABLE WIDTH="100%" @@ -714,7 +714,7 @@ ><A NAME="AEN4143"><P ><B ->Example 10. Settin the Group by </B +>Example 10. Setting the Group by </B ></P ><TABLE WIDTH="100%" Index: pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html Thu Jul 11 02:26:19 2002 @@ -13,7 +13,7 @@ TITLE="SQL Builder and Data Modeling Layer" HREF="packages.db.dataobject.html"><LINK REL="PREVIOUS" -TITLE="AutoBuilding" +TITLE="Auto Building" HREF="packages.db.dataobject.autobuilding.html"><LINK REL="NEXT" TITLE="Modifying the database" @@ -322,7 +322,7 @@ ><H2 >::staticGet()</H2 ><P -> Simple Get (Select) request, abreviated get request. +> Simple Get (Select) request, abbreviated get request. </P ><DIV CLASS="funcsynopsis" @@ -344,7 +344,7 @@ ></DIV ><P > The static method is similar to the get request, however it does not require the - initial instantation of the class. staticGet also caches the result. + initial instantiation of the class. staticGet also caches the result. <TABLE WIDTH="100%" BORDER="0" @@ -661,7 +661,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ->AutoBuilding</TD +>Auto Building</TD ><TD WIDTH="34%" ALIGN="center" Index: pear/DB_DataObject/doc/packages.db.dataobject.introduction.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.introduction.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.introduction.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.introduction.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.introduction.html Thu Jul 11 02:26:19 2002 @@ -89,7 +89,7 @@ ><H2 >Introduction</H2 ><P -> Db_DataObject is a SQL Builder and Data Modeling Layer built ontop of PEAR DB, It main purpose is to +> Db_DataObject is a SQL Builder and Data Modeling Layer built on top of PEAR DB, It main purpose is to </P ><P > <P @@ -105,14 +105,14 @@ ></LI ><LI ><P ->Provide a simple consistant API to access and manipulate that data.</P +>Provide a simple consistent API to access and manipulate that data.</P ></LI ></UL > </P ><P > The DB_DataObject is rarely accessed directly, it is intended to be the base class which you can - extend to put the code specificly relating to a particular database table. Below is an example of how you + extend to put the code specifically relating to a particular database table. Below is an example of how you can use the end result (and extended class), </P ><TABLE @@ -170,7 +170,7 @@ ></TABLE ><P > The above example illustrates the two components of the DataManager, By setting the options, all - the core objects will be able to autoload the data definitons from a generated ini file, and know + the core objects will be able to auto load the data definitions from a generated ini file, and know how to access the database. (multiple databases are supported - see section on configuration) </P ><P @@ -223,7 +223,7 @@ ></TABLE ><P > The Package includes a number of tools to make building the extended classes and configuration file, - Once you have made your extended classes, the idea is that any data maniplation/calculation that relates + Once you have made your extended classes, the idea is that any data manipulation/calculation that relates to this table, or how this table interacts with other data is placed inside the extended class. </P ><TABLE Index: pear/DB_DataObject/doc/packages.db.dataobject.links.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.links.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.links.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.links.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.links.html Thu Jul 11 02:26:19 2002 @@ -87,17 +87,17 @@ NAME="AEN4154" ></A ><H2 ->Automating the colleciton of related data</H2 +>Automating the collection of related data</H2 ><P > When designing a database, often some tables are related to others - a membership table would contain a reference to a person's id and the group id that they are a member of. Using the Link methods, you can automatically fetch objects into the parents variables. </P ><P -> The Automated method of doing this is heavily dependant on naming columns relating to databases, for example in the +> The Automated method of doing this is heavily dependent on naming columns relating to databases, for example in the membership described above, you would have to have a column called person_id, group_id for the automated Link methods to understand which table to fetch the data from. The principle is TABLENAME_ANYTHING, and it - will always attempt to find primary keys that match the value of field, the getLinks() methods will autoload + will always attempt to find primary keys that match the value of field, the getLinks() methods will auto load the related object into $object->_tablename_anything </P ><P Index: pear/DB_DataObject/doc/packages.db.dataobject.updating.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.updating.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.updating.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.updating.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.updating.html Thu Jul 11 02:26:19 2002 @@ -489,7 +489,7 @@ ><TD ><PRE CLASS="sql" ->SELECT * FROM person WHERe id=12 +>SELECT * FROM person WHERE id=12 DELETE FROM person WHERE id=12 AND name='test' AND age=21 DELETE FROM person WHERE age < 21</PRE ></TD
Index: pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.autobuilding.html Thu Jul 11 02:26:19 2002 @@ -1,7 +1,7 @@ <HTML ><HEAD ><TITLE ->AutoBuilding</TITLE +>Auto Building</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ @@ -72,13 +72,13 @@ WIDTH="100%"></DIV ><H1 ><A -NAME="packages.DB.DataObject.autobuilding">AutoBuilding</H1 +NAME="packages.DB.DataObject.autobuilding">Auto Building</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN3851" ></A ->AutoBuilding -- +>Auto Building -- creating the base Classes and Database schema </DIV ><DIV @@ -87,11 +87,11 @@ NAME="AEN3854" ></A ><H2 ->What the AutoBuilder (createTables.php) Does</H2 +>What the Auto Builder (createTables.php) Does</H2 ><P > One of the essential features of an SQL building tool is to to have some understanding of the database structure, So that Integers can be checked, and strings can be escaped. There a few ways - that Quering the database for the table structre could be accomplished + that Querying the database for the table structure could be accomplished <P ></P @@ -116,11 +116,11 @@ ><P > The other key concept of DB_DataObject is that you work with extended classes of DB_DataObject, which do all the 'table' related work. Setting up these classes for a large database can be time consuming, so - the createTables.php file will automatically bulid the skeletons for all these class files. + the createTables.php file will automatically build the skeletons for all these class files. </P ><P > - To start the autobuilder simply go to the pear/DB/DataObject/ directory, and type + To start the auto builder simply go to the pear/DB/DataObject/ directory, and type <B CLASS="command" >c:\php4\php.exe createTables.php myconfig.ini</B Index: pear/DB_DataObject/doc/packages.db.dataobject.configuration.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.configuration.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.configuration.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.configuration.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.configuration.html Thu Jul 11 02:26:19 2002 @@ -16,7 +16,7 @@ TITLE="Introduction" HREF="packages.db.dataobject.introduction.html"><LINK REL="NEXT" -TITLE="AutoBuilding" +TITLE="Auto Building" HREF="packages.db.dataobject.autobuilding.html"><META HTTP-EQUIV="Content-type" CONTENT="text/html; charset=ISO-8859-1"></HEAD @@ -275,7 +275,7 @@ NAME="AEN3803" ></A ><H2 ->Configuration Options - Mulitiple Databases (optional)</H2 +>Configuration Options - Multiple Databases (optional)</H2 ><P ></P ><DIV @@ -291,7 +291,7 @@ string</DT ><DD ><P -> When you have multiple databases you can use the database_* to specifiy the dsn for each +> When you have multiple databases you can use the database_* to specify the dsn for each database </P ><P @@ -412,7 +412,7 @@ > The Directory where your DataObject extended Classes are. </P ><P -> Used by the Class AutoBuilder when updating/writing to your class definitions. +> Used by the Class Auto Builder when updating/writing to your class definitions. </P ></DD ><DT @@ -510,7 +510,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ->AutoBuilding</TD +>Auto Building</TD ></TR ></TABLE ></DIV Index: pear/DB_DataObject/doc/packages.db.dataobject.filters.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.filters.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.filters.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.filters.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.filters.html Thu Jul 11 02:26:19 2002 @@ -96,9 +96,9 @@ ><P > The DB_DataObject class does not handle JOIN queries directly for the simple reason that it is designed to simplify the use of databases, and make the code that access them clear and easy to read. Having - experimented with a Join Version, it became very clear that this did not fulfil either of these goals, and + experimented with a Join Version, it became very clear that this did not fulfill either of these goals, and made the resulting code more difficult to read, debug and understand. So in reality it is best to use the - raw query() method to do join'ed queries.. + raw query() method to do joined queries.. </P ></DIV ><DIV @@ -203,7 +203,7 @@ ></P ></DIV ><P -> By default a select query will request all items '*', to change this behaviour you can first call +> By default a select query will request all items '*', to change this behavior you can first call selectAdd() without any arguments to clear the current request and then add the specific items you require. <TABLE @@ -331,7 +331,7 @@ ></DIV ><P > Adds items to the where part of a SQL query. Calling this without any arguments clears, - the where condition. The default behaviour is to add 'AND' queries, send the string 'OR' to + the where condition. The default behavior is to add 'AND' queries, send the string 'OR' to append OR conditions. <TABLE WIDTH="100%" @@ -714,7 +714,7 @@ ><A NAME="AEN4143"><P ><B ->Example 10. Settin the Group by </B +>Example 10. Setting the Group by </B ></P ><TABLE WIDTH="100%" Index: pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.find_fetch.html Thu Jul 11 02:26:19 2002 @@ -13,7 +13,7 @@ TITLE="SQL Builder and Data Modeling Layer" HREF="packages.db.dataobject.html"><LINK REL="PREVIOUS" -TITLE="AutoBuilding" +TITLE="Auto Building" HREF="packages.db.dataobject.autobuilding.html"><LINK REL="NEXT" TITLE="Modifying the database" @@ -322,7 +322,7 @@ ><H2 >::staticGet()</H2 ><P -> Simple Get (Select) request, abreviated get request. +> Simple Get (Select) request, abbreviated get request. </P ><DIV CLASS="funcsynopsis" @@ -344,7 +344,7 @@ ></DIV ><P > The static method is similar to the get request, however it does not require the - initial instantation of the class. staticGet also caches the result. + initial instantiation of the class. staticGet also caches the result. <TABLE WIDTH="100%" BORDER="0" @@ -661,7 +661,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ->AutoBuilding</TD +>Auto Building</TD ><TD WIDTH="34%" ALIGN="center" Index: pear/DB_DataObject/doc/packages.db.dataobject.introduction.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.introduction.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.introduction.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.introduction.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.introduction.html Thu Jul 11 02:26:19 2002 @@ -89,7 +89,7 @@ ><H2 >Introduction</H2 ><P -> Db_DataObject is a SQL Builder and Data Modeling Layer built ontop of PEAR DB, It main purpose is to +> Db_DataObject is a SQL Builder and Data Modeling Layer built on top of PEAR DB, It main purpose is to </P ><P > <P @@ -105,14 +105,14 @@ ></LI ><LI ><P ->Provide a simple consistant API to access and manipulate that data.</P +>Provide a simple consistent API to access and manipulate that data.</P ></LI ></UL > </P ><P > The DB_DataObject is rarely accessed directly, it is intended to be the base class which you can - extend to put the code specificly relating to a particular database table. Below is an example of how you + extend to put the code specifically relating to a particular database table. Below is an example of how you can use the end result (and extended class), </P ><TABLE @@ -170,7 +170,7 @@ ></TABLE ><P > The above example illustrates the two components of the DataManager, By setting the options, all - the core objects will be able to autoload the data definitons from a generated ini file, and know + the core objects will be able to auto load the data definitions from a generated ini file, and know how to access the database. (multiple databases are supported - see section on configuration) </P ><P @@ -223,7 +223,7 @@ ></TABLE ><P > The Package includes a number of tools to make building the extended classes and configuration file, - Once you have made your extended classes, the idea is that any data maniplation/calculation that relates + Once you have made your extended classes, the idea is that any data manipulation/calculation that relates to this table, or how this table interacts with other data is placed inside the extended class. </P ><TABLE Index: pear/DB_DataObject/doc/packages.db.dataobject.links.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.links.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.links.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.links.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.links.html Thu Jul 11 02:26:19 2002 @@ -87,17 +87,17 @@ NAME="AEN4154" ></A ><H2 ->Automating the colleciton of related data</H2 +>Automating the collection of related data</H2 ><P > When designing a database, often some tables are related to others - a membership table would contain a reference to a person's id and the group id that they are a member of. Using the Link methods, you can automatically fetch objects into the parents variables. </P ><P -> The Automated method of doing this is heavily dependant on naming columns relating to databases, for example in the +> The Automated method of doing this is heavily dependent on naming columns relating to databases, for example in the membership described above, you would have to have a column called person_id, group_id for the automated Link methods to understand which table to fetch the data from. The principle is TABLENAME_ANYTHING, and it - will always attempt to find primary keys that match the value of field, the getLinks() methods will autoload + will always attempt to find primary keys that match the value of field, the getLinks() methods will auto load the related object into $object->_tablename_anything </P ><P Index: pear/DB_DataObject/doc/packages.db.dataobject.updating.html diff -u pear/DB_DataObject/doc/packages.db.dataobject.updating.html:1.2 pear/DB_DataObject/doc/packages.db.dataobject.updating.html:1.3 --- pear/DB_DataObject/doc/packages.db.dataobject.updating.html:1.2 Thu Jul 11 02:05:20 2002 +++ pear/DB_DataObject/doc/packages.db.dataobject.updating.html Thu Jul 11 02:26:19 2002 @@ -489,7 +489,7 @@ ><TD ><PRE CLASS="sql" ->SELECT * FROM person WHERe id=12 +>SELECT * FROM person WHERE id=12 DELETE FROM person WHERE id=12 AND name='test' AND age=21 DELETE FROM person WHERE age < 21</PRE ></TD