cvs: peardoc /en/package/database/db-dataobject/db-dataobject getlinks.xml

arnaud Tue Aug 26 15:16:56 2003 EDT Modified files: /peardoc/en/package/database/db-dataobject/db-dataobject getlinks.xml Log: * ws Index: peardoc/en/package/database/db-dataobject/db-dataobject/getlinks.xml diff -u peardoc/en/package/database/db-dataobject/db-dataobject/getlinks.xml:1.3 peardoc/en/package/database/db-dataobject/db-dataobject/getlinks.xml:1.4 --- peardoc/en/package/database/db-dataobject/db-dataobject/getlinks.xml:1.3 Mon Mar 10 17:27:41 2003 +++ peardoc/en/package/database/db-dataobject/db-dataobject/getlinks.xml Tue Aug 26 15:16:56 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="package.database.db-dataobject.db-dataobject.getlinks"> <refnamediv> <refname>-&gt;getLinks()</refname> @@ -6,63 +6,57 @@ </refnamediv> <refsynopsisdiv> <funcsynopsis> - + <funcprototype> <funcdef>boolean <function>$DB_DataObject-&gt;getLinks</function></funcdef> - - + + <paramdef></paramdef> - + </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.database.db-dataobject.db-dataobject.getlinks.desc"> &title.desc; <para> - Loads the all the related objects into the main object, by using the links.ini + Loads the all the related objects into the main object, by using the links.ini relationships, and sets the calling objects variables with the row name prefixed - with an underscode (<parameter>_</parameter>) to the resulting objects. + with an underscode (<parameter>_</parameter>) to the resulting objects. </para> <para> Using this with the earlier column naming convention is depreciated, and links.ini files should be used. </para> - </refsect1> - - + </refsect1> + <refsect1 id="package.database.db-dataobject.db-dataobject.getlinks.return"> &title.returns; <para> <parameter>boolean</parameter> - &true; on success and &false; on failure </para> - </refsect1> - - - + </refsect1> + <refsect1 id="package.database.db-dataobject.db-dataobject.getlinks.note"> - &title.note; - + &title.note; + &note.notstatic; - - - <simpara></simpara> - </refsect1> - + </refsect1> + <refsect1 id="package.database.db-dataobject.db-dataobject.getlinks.see"> - &title.see; + &title.see; <!-- Additional links go here --> <para> <link linkend="package.database.db-dataobject.db-dataobject.getlink"><function> DB_DataObject::getLink</function></link> </para> - </refsect1> + </refsect1> <refsect1 id="package.database.db-dataobject.db-dataobject.getlinks.example"> &title.example; <example> <title>Two Example Tables</title> <programlisting> - <![CDATA[ + <![CDATA[ Person +---------------+---------------+------+-----+---------+----------------+ | Field | Type | Null | Key | Default | Extra | @@ -100,56 +94,56 @@ | web_site_url | varchar(200) | | | | | | last_modified | timestamp(14) | YES | | NULL | | +----------------------+---------------+------+-----+---------+----------------+ - -]]> + +]]> </programlisting> </example> <example> <title> Loading all the related objects </title> <programlisting role="php"> - <![CDATA[ + <![CDATA[ $person = new DataObjects_Person; $person->get(1079); $person->getLinks(); -print_r($person); -]]> +print_r($person); +]]> </programlisting> - </example> + </example> <example> <title>Resulting SQL</title> <programlisting> <![CDATA[ SELECT * FROM person WHERE id=1079 -SELECT * FROM convention WHERE id=1 -]]> +SELECT * FROM convention WHERE id=1 +]]> </programlisting> - </example> + </example> <example> <title>Resulting Output </title> <programlisting> - <![CDATA[ + <![CDATA[ Object:dataobjects_person Object ( [_DB_DataObject_version] => 1.0 [__table] => person - [_database_dsn] => + [_database_dsn] => [_database_dsn_md5] => 3974043abbccdd6412fb156a1d10b98377 [_database] => testing - [_condition] => - [_group_by] => - [_order_by] => - [_limit] => + [_condition] => + [_group_by] => + [_order_by] => + [_limit] => [_data_select] => * [_link_loaded] => 1 [_lastError] => pear_error Object ( - [error_message_prefix] => + [error_message_prefix] => [mode] => 1 [level] => 1024 [code] => -3 [message] => getLink:Could not find class for row last_modified, table last - [userinfo] => - [callback] => + [userinfo] => + [callback] => ) [id] => 1079 @@ -157,7 +151,7 @@ [_DB_resultid] => 2 [first_name] => Tim [last_name] => White - [middle_name] => + [middle_name] => [badge_number] => 123 [street] => 334411 N Washington [city] => Texas @@ -165,37 +159,37 @@ [zip] => 12345 [phone] => 343412323232 [reg_type] => Staff - [judge] => + [judge] => [staff] => CHECKED - [volunteer] => + [volunteer] => [rpga_number] => 1232323 [total_fee] => 0.00 [email_address] => tim@example.com [country] => USA [convention_id] => 1 [last_modified] => 20020711084539 - [_first_name] => - [_last_name] => - [_middle_name] => - [_badge_number] => - [_reg_type] => - [_rpga_number] => - [_total_fee] => - [_email_address] => + [_first_name] => + [_last_name] => + [_middle_name] => + [_badge_number] => + [_reg_type] => + [_rpga_number] => + [_total_fee] => + [_email_address] => [_convention_id] => dataobjects_convention Object ( [_DB_DataObject_version] => 1.0 [__table] => convention - [_database_dsn] => + [_database_dsn] => [_database_dsn_md5] => 3974043abbcc86412fb156a1d10b98377 [_database] => testing - [_condition] => - [_group_by] => - [_order_by] => - [_limit] => + [_condition] => + [_group_by] => + [_order_by] => + [_limit] => [_data_select] => * - [_link_loaded] => - [_lastError] => + [_link_loaded] => + [_lastError] => [id] => 1 [N] => 1 [_DB_resultid] => 3 @@ -206,12 +200,12 @@ [last_modified] => 20020703143828 ) - [_last_modified] => -) -]]> + [_last_modified] => +) +]]> </programlisting> - </example> - </refsect1> + </example> + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: @@ -231,4 +225,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> +-->