cvs: peardoc /en/package/database db-dataobject.xml /en/package/database/db-dataobject/db-dataobject setfrom.xml settersgetters.xml
| From: | Alan Knowles | Date: | Wed, 14 May 2003 13:03:10 +0000 |
| Subject: | cvs: peardoc /en/package/database db-dataobject.xml /en/package/database/db-dataobject/db-dataobject setfrom.xml settersgetters.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-816@lists.php.net to get a copy of this message | ||
alan_k Wed May 14 09:03:10 2003 EDT
Added files:
/peardoc/en/package/database/db-dataobject/db-dataobject
settersgetters.xml
Modified files:
/peardoc/en/package/database db-dataobject.xml
/peardoc/en/package/database/db-dataobject/db-dataobject
setfrom.xml
Log:
adding setters getters, update setFrom
Index: peardoc/en/package/database/db-dataobject.xml diff -u peardoc/en/package/database/db-dataobject.xml:1.6 peardoc/en/package/database/db-dataobject.xml:1.7 --- peardoc/en/package/database/db-dataobject.xml:1.6 Wed Mar 12 04:00:10 2003 +++ peardoc/en/package/database/db-dataobject.xml Wed May 14 09:03:09 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <sect1 id="package.database.db-dataobject"> <title>DB_DataObject</title> @@ -57,6 +57,7 @@ &package.database.db-dataobject.db-dataobject.joinadd; <!-- other usefull stuff --> + &package.database.db-dataobject.db-dataobject.settersgetters; &package.database.db-dataobject.db-dataobject.setfrom; &package.database.db-dataobject.db-dataobject.toarray; Index: peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml diff -u peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml:1.3 peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml:1.4 --- peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml:1.3 Mon Mar 10 17:27:41 2003 +++ peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml Wed May 14 09:03:10 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="package.database.db-dataobject.db-dataobject.setfrom"> <refnamediv> <refname>->setFrom()</refname> @@ -12,7 +12,9 @@ <paramdef> array or object <parameter>$from</parameter> </paramdef> - + <paramdef> + string <parameter><optional>$format = '%s'</optional></parameter> + </paramdef> </funcprototype> </funcsynopsis> @@ -37,8 +39,15 @@ <parameter>array or Object $from</parameter> - what to copy from </para> </listitem> - + + <listitem> + <para> + <parameter>string $format</parameter> - the format of the array or object variables and how they relate to this object. + for example if your input array is in the format prefix_COLNAME, then you can use 'prefix_%s'. + </para> + </listitem> </itemizedlist> + </para> </refsect1> @@ -46,7 +55,7 @@ <refsect1 id="package.database.db-dataobject.db-dataobject.setfrom.return"> &title.returns; <para> - <parameter>boolean</parameter> - true on success + <parameter>array or boolean</parameter> - true on success or an array of set*() return values in PHP4.3.2 upwards </para> </refsect1> @@ -67,11 +76,38 @@ <example> <title>Using <function>setFrom</function></title> <programlisting role="php"> - <![CDATA[ + <![CDATA[ + +// person contains name,age +// $_POST contains 'name'=>'fred', 'age'=>'22' + + $person = new DataObjects_Person; $person->get(12); -$person->setFrom($_POST['input']); +$person->setFrom($_POST); $person->update(); + + +// or using the formating + +// person contains name,age +// $_POST contains 'person_name'=>'fred', 'person_age'=>'22' + +$person = new DataObjects_Person; +$person->get(12); +$ret = $person->setFrom($_POST,'person_%s'); + +// use the return value from setFrom to test for errors (PHP4.3.2) +if ($ret === true) { + $person->update(); +} else { + // $ret is an array or strings.. + echo 'There were some errors: ' . implode(', ', $ret); +} + + + + // or copying from another object Index: peardoc/en/package/database/db-dataobject/db-dataobject/settersgetters.xml +++ peardoc/en/package/database/db-dataobject/db-dataobject/settersgetters.xml <!-- $Revision: 1.1 $ --> <refentry id="package.database.db-dataobject.db-dataobject.settersgetters"> <refnamediv> <refname>->set*() and ->get*()</refname> <refpurpose>Automatic Setters and Getters using overload</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>true | string <function>$DB_DataObject->set*</function></funcdef> <paramdef>mixed <parameter>$value</parameter></paramdef> </funcprototype> <funcprototype> <funcdef>mixed <function>$DB_DataObject->get*</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.desc"> &title.desc; <para> From version PHP 4.3.2RC2 onwards, DB_DataObject is automatically overloaded, providing access to all variables using $object->set{ColumnName}() and $object->set{ColumnName}($value) even if you have not defined the method. </para> <para> It is assumed that set methods return strings as errors or true, so that it can interact with setFrom and return array's of error strings. </para> <para> The get Methods are used by toArray(), if defined they can be used to alter the appearance of columns ,like making dates human readable </para> <para> The logic is very simple, if you call $object->setXXX() and it is not defined, it will just set the value, if you define a method setXXXX, that will be called instead of the default handler, same applies to getXXX(). </para> </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>mixed $value</parameter> - on setters only (the value to assign to the column), on getters you may like to implement date formating or sprintf formating as the argument. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.return"> &title.returns; <para> <parameter>mixed</parameter> - setters will return true from the default method, in your implementations of setters it is expected that setXXX($value) will return a string (the error) if it is invalid. or true on success. getXXX may return the value or a formated value, remember though it affects $object->toArray(). </para> </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.note"> &title.note; ¬e.notstatic; <simpara>Warning: This is experimental, it's behavour may change slightly in the future.</simpara> </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.example"> &title.example; <example> <title>Simple find and fetch of data based on Object Vars</title> <programlisting role="php"> <![CDATA[ class DataObjects_Person extends DB_DataObject { var $id; var $name; var $date_of_birth; // you can define this method after you implement a call to it! // as it's automatically implemented to return $this->date_of_birth by // the overload __call() method. function getDate_of_Birth() { return date('d M Y', strtotime($this->date_of_birth)); } } $person = new DataObjects_Person; $person->get(12); // now lets use the getters and setters even though some are not defined. echo $person->getName() . ' was born on ' . $person->getDate_of_Birth(); ]]> </programlisting> </example> <example> <title>Resulting Output </title> <programlisting> <![CDATA[ Fred Blogs was born on 1 April 1970 ]]> </programlisting> </example> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->
Index: peardoc/en/package/database/db-dataobject.xml diff -u peardoc/en/package/database/db-dataobject.xml:1.6 peardoc/en/package/database/db-dataobject.xml:1.7 --- peardoc/en/package/database/db-dataobject.xml:1.6 Wed Mar 12 04:00:10 2003 +++ peardoc/en/package/database/db-dataobject.xml Wed May 14 09:03:09 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <sect1 id="package.database.db-dataobject"> <title>DB_DataObject</title> @@ -57,6 +57,7 @@ &package.database.db-dataobject.db-dataobject.joinadd; <!-- other usefull stuff --> + &package.database.db-dataobject.db-dataobject.settersgetters; &package.database.db-dataobject.db-dataobject.setfrom; &package.database.db-dataobject.db-dataobject.toarray; Index: peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml diff -u peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml:1.3 peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml:1.4 --- peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml:1.3 Mon Mar 10 17:27:41 2003 +++ peardoc/en/package/database/db-dataobject/db-dataobject/setfrom.xml Wed May 14 09:03:10 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="package.database.db-dataobject.db-dataobject.setfrom"> <refnamediv> <refname>->setFrom()</refname> @@ -12,7 +12,9 @@ <paramdef> array or object <parameter>$from</parameter> </paramdef> - + <paramdef> + string <parameter><optional>$format = '%s'</optional></parameter> + </paramdef> </funcprototype> </funcsynopsis> @@ -37,8 +39,15 @@ <parameter>array or Object $from</parameter> - what to copy from </para> </listitem> - + + <listitem> + <para> + <parameter>string $format</parameter> - the format of the array or object variables and how they relate to this object. + for example if your input array is in the format prefix_COLNAME, then you can use 'prefix_%s'. + </para> + </listitem> </itemizedlist> + </para> </refsect1> @@ -46,7 +55,7 @@ <refsect1 id="package.database.db-dataobject.db-dataobject.setfrom.return"> &title.returns; <para> - <parameter>boolean</parameter> - true on success + <parameter>array or boolean</parameter> - true on success or an array of set*() return values in PHP4.3.2 upwards </para> </refsect1> @@ -67,11 +76,38 @@ <example> <title>Using <function>setFrom</function></title> <programlisting role="php"> - <![CDATA[ + <![CDATA[ + +// person contains name,age +// $_POST contains 'name'=>'fred', 'age'=>'22' + + $person = new DataObjects_Person; $person->get(12); -$person->setFrom($_POST['input']); +$person->setFrom($_POST); $person->update(); + + +// or using the formating + +// person contains name,age +// $_POST contains 'person_name'=>'fred', 'person_age'=>'22' + +$person = new DataObjects_Person; +$person->get(12); +$ret = $person->setFrom($_POST,'person_%s'); + +// use the return value from setFrom to test for errors (PHP4.3.2) +if ($ret === true) { + $person->update(); +} else { + // $ret is an array or strings.. + echo 'There were some errors: ' . implode(', ', $ret); +} + + + + // or copying from another object Index: peardoc/en/package/database/db-dataobject/db-dataobject/settersgetters.xml +++ peardoc/en/package/database/db-dataobject/db-dataobject/settersgetters.xml <!-- $Revision: 1.1 $ --> <refentry id="package.database.db-dataobject.db-dataobject.settersgetters"> <refnamediv> <refname>->set*() and ->get*()</refname> <refpurpose>Automatic Setters and Getters using overload</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef>true | string <function>$DB_DataObject->set*</function></funcdef> <paramdef>mixed <parameter>$value</parameter></paramdef> </funcprototype> <funcprototype> <funcdef>mixed <function>$DB_DataObject->get*</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.desc"> &title.desc; <para> From version PHP 4.3.2RC2 onwards, DB_DataObject is automatically overloaded, providing access to all variables using $object->set{ColumnName}() and $object->set{ColumnName}($value) even if you have not defined the method. </para> <para> It is assumed that set methods return strings as errors or true, so that it can interact with setFrom and return array's of error strings. </para> <para> The get Methods are used by toArray(), if defined they can be used to alter the appearance of columns ,like making dates human readable </para> <para> The logic is very simple, if you call $object->setXXX() and it is not defined, it will just set the value, if you define a method setXXXX, that will be called instead of the default handler, same applies to getXXX(). </para> </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>mixed $value</parameter> - on setters only (the value to assign to the column), on getters you may like to implement date formating or sprintf formating as the argument. </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.return"> &title.returns; <para> <parameter>mixed</parameter> - setters will return true from the default method, in your implementations of setters it is expected that setXXX($value) will return a string (the error) if it is invalid. or true on success. getXXX may return the value or a formated value, remember though it affects $object->toArray(). </para> </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.note"> &title.note; ¬e.notstatic; <simpara>Warning: This is experimental, it's behavour may change slightly in the future.</simpara> </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.settersgetters.example"> &title.example; <example> <title>Simple find and fetch of data based on Object Vars</title> <programlisting role="php"> <![CDATA[ class DataObjects_Person extends DB_DataObject { var $id; var $name; var $date_of_birth; // you can define this method after you implement a call to it! // as it's automatically implemented to return $this->date_of_birth by // the overload __call() method. function getDate_of_Birth() { return date('d M Y', strtotime($this->date_of_birth)); } } $person = new DataObjects_Person; $person->get(12); // now lets use the getters and setters even though some are not defined. echo $person->getName() . ' was born on ' . $person->getDate_of_Birth(); ]]> </programlisting> </example> <example> <title>Resulting Output </title> <programlisting> <![CDATA[ Fred Blogs was born on 1 April 1970 ]]> </programlisting> </example> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->