[Solar-svn] Revision 2857

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


updated comments


Modified: trunk/Solar/Example/Model/TestSolarFoo/Record.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarFoo/Record.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Example/Model/TestSolarFoo/Record.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Represents a single "foo" 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 "foo" record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarFoo_Record extends Solar_Sql_Model_Record {
 }
\ No newline at end of file

Modified: trunk/Solar/Model/Areas/Collection.php
===================================================================
--- trunk/Solar/Model/Areas/Collection.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Model/Areas/Collection.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,2 +1,27 @@
 <?php
+/**
+ * 
+ * Represents a collection of records from the "areas" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ * @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 the "areas" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ */
 class Solar_Model_Areas_Collection extends Solar_Model_Collection {}
\ No newline at end of file

Modified: trunk/Solar/Model/Areas/Record.php
===================================================================
--- trunk/Solar/Model/Areas/Record.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Model/Areas/Record.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,2 +1,27 @@
 <?php
+/**
+ * 
+ * Represents a single record from the "areas" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ * @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 record from the "areas" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ */
 class Solar_Model_Areas_Record extends Solar_Model_Record {}
\ No newline at end of file

Modified: trunk/Solar/Model/Areas.php
===================================================================
--- trunk/Solar/Model/Areas.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Model/Areas.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,5 +1,38 @@
 <?php
+/**
+ * 
+ * A model of content "areas" (logical groups or buckets of nodes).
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ * @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 $
+ * 
+ */
+
+/**
+ * 
+ * A model of content "areas" (logical groups or buckets of nodes).
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ */
 class Solar_Model_Areas extends Solar_Model {
+    
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         /**

Modified: trunk/Solar/Model/Collection.php
===================================================================
--- trunk/Solar/Model/Collection.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Model/Collection.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,2 +1,27 @@
 <?php
+/**
+ * 
+ * Represents a collection of generic model records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ * @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 generic model records.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ */
 class Solar_Model_Collection extends Solar_Sql_Model_Collection {}
\ No newline at end of file

Modified: trunk/Solar/Model/Nodes.php
===================================================================
--- trunk/Solar/Model/Nodes.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Model/Nodes.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,7 +1,7 @@
 <?php
 /**
  * 
- * Model for nodes of content.
+ * A model of content "nodes" (individual pieces of content).
  * 
  * @category Solar
  * 
@@ -17,7 +17,7 @@
 
 /**
  * 
- * Model for nodes of content.
+ * A model of content "nodes" (individual pieces of content).
  * 
  * @category Solar
  * 

Modified: trunk/Solar/Model/Record.php
===================================================================
--- trunk/Solar/Model/Record.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Model/Record.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,2 +1,27 @@
 <?php
+/**
+ * 
+ * Represents a single generic model record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ * @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 generic model record.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ */
 class Solar_Model_Record extends Solar_Sql_Model_Record {}
\ No newline at end of file

Modified: trunk/Solar/Model/Taggings.php
===================================================================
--- trunk/Solar/Model/Taggings.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Model/Taggings.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * A model of content "nodes" (individual pieces of content).
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Mime.php 2826 2007-10-06 15:55:03Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * A model of content "nodes" (individual pieces of content).
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ */
 class Solar_Model_Taggings extends Solar_Model {
     protected function _setup()
     {

Modified: trunk/Solar/Model/Tags.php
===================================================================
--- trunk/Solar/Model/Tags.php	2007-10-12 15:33:01 UTC (rev 2856)
+++ trunk/Solar/Model/Tags.php	2007-10-12 15:55:40 UTC (rev 2857)
@@ -1,5 +1,38 @@
 <?php
+/**
+ * 
+ * A model of "tags" that can be applied to nodes.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id: Mime.php 2826 2007-10-06 15:55:03Z pmjones $
+ * 
+ */
+
+/**
+ * 
+ * A model of "tags" that can be applied to nodes.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ */
 class Solar_Model_Tags extends Solar_Model {
+    
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         /**
@@ -48,6 +81,16 @@
         ));
     }
     
+    /**
+     * 
+     * Fetches a collection of all tags, with an added "count" column saying
+     * how many nodes use that tag.
+     * 
+     * @param array $params Added paramters for the select.
+     * 
+     * @return Solar_Model_Tags_Collection
+     * 
+     */
     public function fetchAllWithCount($params = null)
     {
         $params = $this->fixSelectParams($params);
@@ -55,6 +98,18 @@
         return $this->_fetchAll($select, $params);
     }
     
+    /**
+     * 
+     * Fetches a collection of all tags applied by a particular owner, as
+     * identified by that user's "handle".
+     * 
+     * @param string $owner_handle Only select tags in use by this handle.
+     * 
+     * @param array $params Added parameters for the select.
+     * 
+     * @return Solar_Model_Tags_Collection
+     * 
+     */
     public function fetchAllByOwnerHandle($owner_handle, $params = null)
     {
         $owner_handle = trim($owner_handle);
@@ -106,6 +161,15 @@
         return $this->_fetchAll($select, $params);
     }
     
+    /**
+     * 
+     * Support method to add the tag-count to a selection tool.
+     * 
+     * @param array $params Added parameters for the select.
+     * 
+     * @return Solar_Sql_Select
+     * 
+     */
     protected function _newSelectWithCount($params)
     {
         // params should have been fixed by this point




More information about the Solar-svn mailing list