Author: weaverryan
Date: 2010-01-26 05:21:08 +0100 (Tue, 26 Jan 2010)
New Revision: 27176

Modified:
   
plugins/sfSympalPlugin/trunk/lib/plugins/sfSympalInstallPlugin/lib/sfSympalInstall.class.php
   plugins/sfSympalPlugin/trunk/lib/task/sfSympalCreateSiteTask.class.php
Log:
[1.4][sfSympalPlugin][1.0] Adding some phpdoc as I go through the installation


Modified: 
plugins/sfSympalPlugin/trunk/lib/plugins/sfSympalInstallPlugin/lib/sfSympalInstall.class.php
===================================================================
--- 
plugins/sfSympalPlugin/trunk/lib/plugins/sfSympalInstallPlugin/lib/sfSympalInstall.class.php
        2010-01-26 02:53:26 UTC (rev 27175)
+++ 
plugins/sfSympalPlugin/trunk/lib/plugins/sfSympalInstallPlugin/lib/sfSympalInstall.class.php
        2010-01-26 04:21:08 UTC (rev 27176)
@@ -69,7 +69,11 @@
   {
     $this->_configuration->getEventDispatcher()->notify(new sfEvent($this, 
'command.log', array($this->_formatter->formatSection($section, $message, 
$size, $style))));
   }
-
+  
+  /**
+   * Actually runs the installation - this is the main entry point for
+   * installing sympal
+   */
   public function install()
   {
     $this->_dispatcher->notify(new sfEvent($this, 'sympal.pre_install', 
array('configuration' => $this->_configuration, 'dispatcher' => 
$this->_dispatcher, 'formatter' => $this->_formatter)));
@@ -156,6 +160,7 @@
       $return = false;
     }
     $conn->close();
+    
     return $return;
   }
 
@@ -169,6 +174,7 @@
       $return = false;
     }
     $conn->close();
+    
     return $return;
   }
 
@@ -187,7 +193,15 @@
     $task = new sfDoctrineBuildTask($this->_dispatcher, $this->_formatter);
     $task->run(array(), array('all-classes', 
'--application='.sfConfig::get('sf_app')));
   }
-
+  
+  /**
+   * Method called during a fresh install (or a force reload)
+   * 
+   * This method performs the following tasks:
+   *   * Writes the database dsn to databases.yml
+   *   * Creates the database
+   *   * Loads the install fixtures
+   */
   protected function _setupDatabase()
   {
     if (isset($this->_params['db_dsn']) && 
isset($this->_params['db_username']))
@@ -236,7 +250,13 @@
 
     $task->run(array(), $options);
   }
-
+  
+  /**
+   * Method called in a fresh install or a force reload install
+   * 
+   * This method simply calls the sympal:create-site task and creates
+   * a cache directory to store the minified css and js
+   */
   protected function _installSympal()
   {
     $task = new sfSympalCreateSiteTask($this->_dispatcher, $this->_formatter);

Modified: plugins/sfSympalPlugin/trunk/lib/task/sfSympalCreateSiteTask.class.php
===================================================================
--- plugins/sfSympalPlugin/trunk/lib/task/sfSympalCreateSiteTask.class.php      
2010-01-26 02:53:26 UTC (rev 27175)
+++ plugins/sfSympalPlugin/trunk/lib/task/sfSympalCreateSiteTask.class.php      
2010-01-26 04:21:08 UTC (rev 27176)
@@ -1,5 +1,18 @@
 <?php
 
+/**
+ * Task for creating a new sympal site.
+ * 
+ * This task performs the following things:
+ *  * creates the symfony application if it doesn't exist
+ *  * Calls the sympal:enable-for-app task, which performs the basic setup
+ *    that the application needs (actually modifies files) to be a sympal app
+ * 
+ * @package     sfSympalPlugin
+ * @subpackage  task
+ * @author      Jonathan H. Wage <[email protected]>
+ * @version     svn:$Id$ $Author$
+ */
 class sfSympalCreateSiteTask extends sfSympalBaseTask
 {
   protected function configure()

-- 
You received this message because you are subscribed to the Google Groups 
"symfony SVN" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/symfony-svn?hl=en.

Reply via email to