[Solar-svn] Revision 2855

pmjones at solarphp.com pmjones at solarphp.com
Fri Oct 12 10:12:47 CDT 2007


updated comments


Modified: trunk/Solar/Example/Model/Areas/Collection.php
===================================================================
--- trunk/Solar/Example/Model/Areas/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Areas/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of area records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of area records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Areas_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Areas/Record.php
===================================================================
--- trunk/Solar/Example/Model/Areas/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Areas/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single area record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single area record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Areas_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Areas.php
===================================================================
--- trunk/Solar/Example/Model/Areas.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Areas.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,38 @@
 <?php
+/**
+ * 
+ * Example for testing a model of content "areas".
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Example for testing a model of content "areas".
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Areas extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/Metas/Collection.php
===================================================================
--- trunk/Solar/Example/Model/Metas/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Metas/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of node metadata records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of node metadata records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Metas_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Metas/Record.php
===================================================================
--- trunk/Solar/Example/Model/Metas/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Metas/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single node-metadata record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single node-metadata record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Metas_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Metas.php
===================================================================
--- trunk/Solar/Example/Model/Metas.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Metas.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,38 @@
 <?php
+/**
+ * 
+ * Example for testing a model of content node "metas" (metadata).
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Example for testing a model of content node "metas" (metadata).
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Metas extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/Nodes/Collection.php
===================================================================
--- trunk/Solar/Example/Model/Nodes/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Nodes/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of node records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of node records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Nodes_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Nodes/Record.php
===================================================================
--- trunk/Solar/Example/Model/Nodes/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Nodes/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single node record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single node record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Nodes_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Nodes.php
===================================================================
--- trunk/Solar/Example/Model/Nodes.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Nodes.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,13 @@
 <?php
 class Solar_Example_Model_Nodes extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/Taggings/Collection.php
===================================================================
--- trunk/Solar/Example/Model/Taggings/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Taggings/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of tagging (nodes-to-tags mappings) records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of tagging (nodes-to-tags mappings) records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Taggings_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Taggings/Record.php
===================================================================
--- trunk/Solar/Example/Model/Taggings/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Taggings/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single tagging (node-to-tag) record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single tagging (node-to-tag) record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Taggings_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Taggings.php
===================================================================
--- trunk/Solar/Example/Model/Taggings.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Taggings.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,13 @@
 <?php
 class Solar_Example_Model_Taggings extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/Tags/Collection.php
===================================================================
--- trunk/Solar/Example/Model/Tags/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Tags/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of tag records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of tag records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Tags_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Tags/Record.php
===================================================================
--- trunk/Solar/Example/Model/Tags/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Tags/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single tag record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single tag record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Tags_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Tags.php
===================================================================
--- trunk/Solar/Example/Model/Tags.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Tags.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,13 @@
 <?php
 class Solar_Example_Model_Tags extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/TestSolarDib.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarDib.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarDib.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,13 @@
 <?php
 class Solar_Example_Model_TestSolarDib extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/TestSolarFoo/Bar/Record.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarFoo/Bar/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarFoo/Bar/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single "bar" record (inherited from table "test_solar_foo").
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single "bar" record (inherited from table "test_solar_foo").
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarFoo_Bar_Record extends Solar_Example_Model_TestSolarFoo_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/TestSolarFoo/Collection.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarFoo/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarFoo/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of "test_solar_foo" records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of "test_solar_foo" records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarFoo_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/TestSolarFoo.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarFoo.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarFoo.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,13 @@
 <?php
 class Solar_Example_Model_TestSolarFoo extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/TestSolarSpecialCols/Collection.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarSpecialCols/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarSpecialCols/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of special-column records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of special-column records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarSpecialCols_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/TestSolarSpecialCols/Record.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarSpecialCols/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarSpecialCols/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single special-columns record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single special-columns record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarSpecialCols_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/TestSolarSpecialCols.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarSpecialCols.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarSpecialCols.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,13 @@
 <?php
 class Solar_Example_Model_TestSolarSpecialCols extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/TestSolarSqlDescribe/Collection.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarSqlDescribe/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarSqlDescribe/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of records from describing a table.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of records from describing a table.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarSqlDescribe_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/TestSolarSqlDescribe/Record.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarSqlDescribe/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarSqlDescribe/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single describe-table record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single describe-table record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarSqlDescribe_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/TestSolarSqlDescribe.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarSqlDescribe.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/TestSolarSqlDescribe.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,13 @@
 <?php
 class Solar_Example_Model_TestSolarSqlDescribe extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Example/Model/Users/Collection.php
===================================================================
--- trunk/Solar/Example/Model/Users/Collection.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Users/Collection.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a collection of user records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a collection of user records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Users_Collection extends Solar_Sql_Model_Collection {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Users/Record.php
===================================================================
--- trunk/Solar/Example/Model/Users/Record.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Users/Record.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single user record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Exception.php 2804 2007-10-06 14:01:27Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * Represents a single user record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Users_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/Users.php
===================================================================
--- trunk/Solar/Example/Model/Users.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Example/Model/Users.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1,6 +1,13 @@
 <?php
 class Solar_Example_Model_Users extends Solar_Sql_Model {
     
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         $dir = str_replace('_', DIRECTORY_SEPARATOR, __CLASS__)

Modified: trunk/Solar/Sql/Model.php
===================================================================
--- trunk/Solar/Sql/Model.php	2007-10-12 14:33:52 UTC (rev 2854)
+++ trunk/Solar/Sql/Model.php	2007-10-12 15:12:47 UTC (rev 2855)
@@ -1354,6 +1354,10 @@
      * Given a record, fetches a related record or collection for a named
      * relationship.
      * 
+     * @param array|Solar_Sql_Model_Record $spec The specification for the
+     * native selection.  If an array, treated as selection criteria; if a
+     * record object, uses the primary key from that record.
+     * 
      * @param string $name The relationship name.
      * 
      * @param int $page For to-many associations, the page-number of records
@@ -1361,6 +1365,8 @@
      * associations.  Paging is based on the related model's "$_paging"
      * property.
      * 
+     * @param array $bind Key-value pairs to bind to the select.
+     * 
      * @return Solar_Sql_Model_Record|Solar_Sql_Model_Collection A record or collection
      * object.
      * 
@@ -1384,6 +1390,27 @@
         return $result;
     }
     
+    /**
+     * 
+     * Given a record, fetches related data for a named relationship as an
+     * array.
+     * 
+     * @param array|Solar_Sql_Model_Record $spec The specification for the
+     * native selection.  If an array, treated as selection criteria; if a
+     * record object, uses the primary key from that record.
+     * 
+     * @param string $name The relationship name.
+     * 
+     * @param int $page For to-many associations, the page-number of records
+     * to fetch (default null, which fetches all records).  Ignored by to-one
+     * associations.  Paging is based on the related model's "$_paging"
+     * property.
+     * 
+     * @param array $bind Key-value pairs to bind to the select.
+     * 
+     * @return array An array of data from the fetch.
+     * 
+     */
     public function fetchRelatedArray($spec, $name, $page = null, $bind = null)
     {
         $related = $this->getRelated($name);




More information about the Solar-svn mailing list