[Solar-svn] Revision 2856

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


updated comments


Modified: trunk/Solar/Example/Model/Nodes.php
===================================================================
--- trunk/Solar/Example/Model/Nodes.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/Nodes.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Example for testing a model of content "nodes".
+ * 
+ * @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 "nodes".
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Nodes extends Solar_Sql_Model {
     
     /**

Modified: trunk/Solar/Example/Model/Taggings.php
===================================================================
--- trunk/Solar/Example/Model/Taggings.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/Taggings.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Example for testing a model of content "taggings" (nodes-to-tags mappings).
+ * 
+ * @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 "taggings" (nodes-to-tags mappings).
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Taggings extends Solar_Sql_Model {
     
     /**

Modified: trunk/Solar/Example/Model/Tags.php
===================================================================
--- trunk/Solar/Example/Model/Tags.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/Tags.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Example for testing a model of content "tags".
+ * 
+ * @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 "tags".
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Tags extends Solar_Sql_Model {
     
     /**

Modified: trunk/Solar/Example/Model/TestSolarDib.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarDib.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/TestSolarDib.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Example for testing a "test_solar_dib" model.
+ * 
+ * @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 "test_solar_dib" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarDib extends Solar_Sql_Model {
     
     /**

Modified: trunk/Solar/Example/Model/TestSolarFoo/Bar.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarFoo/Bar.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/TestSolarFoo/Bar.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,3 +1,28 @@
 <?php
+/**
+ * 
+ * Example for testing a "bar" model (inherited from 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 $
+ * 
+ */
+
+/**
+ * 
+ * Example for testing a "bar" model (inherited from test_solar_foo).
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarFoo_Bar extends Solar_Example_Model_TestSolarFoo {
 }
\ No newline at end of file

Modified: trunk/Solar/Example/Model/TestSolarFoo.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarFoo.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/TestSolarFoo.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Example for testing a "test_solar_foo" model.
+ * 
+ * @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 "test_solar_foo" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarFoo extends Solar_Sql_Model {
     
     /**

Modified: trunk/Solar/Example/Model/TestSolarSpecialCols.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarSpecialCols.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/TestSolarSpecialCols.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Example for testing a "special columns" model.
+ * 
+ * @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 "special_columns" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarSpecialCols extends Solar_Sql_Model {
     
     /**

Modified: trunk/Solar/Example/Model/TestSolarSqlDescribe.php
===================================================================
--- trunk/Solar/Example/Model/TestSolarSqlDescribe.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/TestSolarSqlDescribe.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Example for testing a "describe-table" model.
+ * 
+ * @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 "describe-table" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_TestSolarSqlDescribe extends Solar_Sql_Model {
     
     /**

Modified: trunk/Solar/Example/Model/Users.php
===================================================================
--- trunk/Solar/Example/Model/Users.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Example/Model/Users.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Example for testing a "users" model.
+ * 
+ * @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 "users" model.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Example
+ * 
+ */
 class Solar_Example_Model_Users extends Solar_Sql_Model {
     
     /**

Modified: trunk/Solar/Model/Nodes.php
===================================================================
--- trunk/Solar/Model/Nodes.php	2007-10-12 15:12:47 UTC (rev 2855)
+++ trunk/Solar/Model/Nodes.php	2007-10-12 15:33:01 UTC (rev 2856)
@@ -1,5 +1,38 @@
 <?php
+/**
+ * 
+ * Model for nodes 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 $
+ * 
+ */
+
+/**
+ * 
+ * Model for nodes of content.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Model
+ * 
+ */
 class Solar_Model_Nodes extends Solar_Model {
+    
+    /**
+     * 
+     * Model setup.
+     * 
+     * @return void
+     * 
+     */
     protected function _setup()
     {
         /**
@@ -145,6 +178,17 @@
         ));
     }
     
+    /**
+     * 
+     * Fetches a collection of nodes with certain tags.
+     * 
+     * @param array $tag_list Fetch only nodes with all of these tags.
+     * 
+     * @param array $params Added parameters for the SELECT.
+     * 
+     * @return Solar_Model_Nodes_Collection
+     * 
+     */
     public function fetchAllByTags($tag_list, $params = null)
     {
         // no tags? fetch all to pre-empt errors related to "IN()" not
@@ -159,6 +203,15 @@
         return $this->_fetchAll($select, $params);
     }
     
+    /**
+     * 
+     * Support method to "fix" tag-list arrays: no duplicates, no spaces, etc.
+     * 
+     * @param array $tag_list The list of tags to "fix".
+     * 
+     * @return array The fixed tag list.
+     * 
+     */
     protected function _fixTagList($tag_list)
     {
         // convert to array
@@ -179,6 +232,17 @@
         return $tag_list;
     }
     
+    /**
+     * 
+     * Support method to create a new selection tool based on tag lists.
+     * 
+     * @param array $tag_list The list of tags to select by.
+     * 
+     * @param array $params Added parameters for the SELECT.
+     * 
+     * @return Solar_Sql_Select
+     * 
+     */
     protected function _newSelectByTags($tag_list, $params)
     {
         // setup
@@ -224,6 +288,18 @@
         return $select;
     }
     
+    /**
+     * 
+     * Gets a count of nodes and pages-of-nodes with certain tags.
+     * 
+     * @param array $tag_list Count only nodes with all of these tags.
+     * 
+     * @param array $params Added parameters for the SELECT.
+     * 
+     * @return array An array with elemets 'count' (the number of nodes) and
+     * 'pages' (the number of pages-of-nodes).
+     * 
+     */
     public function countPagesByTags($tag_list, $params = null)
     {
         $tag_list = $this->_fixTagList($tag_list);




More information about the Solar-svn mailing list