deployment gui - valuestore - update phpdoc

public_html/valuestore/classes/valuestore.class.php

@@ -18,7 +18,7 @@
  *     $oVersion = new valuestore();
  * 
  *     to delete values for a single place:
- *     $oVersion->setProject("", $this->_aPrjConfig["fileprefix"]$sPhase, $sPlace);
+ *     $oVersion->setProject("", $this->_aPrjConfig["fileprefix"], $sPhase, $sPlace);
  *     $aVersions=$oVersion->deleteValues();
  * 
  *     to delete all version items for a whole whole project (packages) in all phases
@@ -338,13 +338,14 @@ class valuestore {
     // ----------------------------------------------------------------------
     
     /**
-     * init before setting or getting 
+     * init a "position" before getting or updating deleting a value
+     * 
      * @param string  $sProject  project id
      * @param string  $sPackage  package id
      * @param string  $sPhase    phase (preview|stage|live)
-     * @param string  $sPlace    place()
-     * @param string  $sHost
-     * @return type
+     * @param string  $sPlace    place (onhold|ready2install|deployed)
+     * @param string  $sHost     hostname (for place deployed)
+     * @return type string
      */
     public function setProject($sProject, $sPackage, $sPhase=false, $sPlace=false, $sHost=false){
         $this->sProject=preg_replace('/[^a-z\-\_0-9]/', '' ,$sProject);
@@ -352,12 +353,31 @@ class valuestore {
         return $this->sProject;
     }
 
+    /**
+     * set a package (and more granular items)
+     * @see setProject()
+     * 
+     * @param string  $sPackage  package id
+     * @param string  $sPhase    phase (preview|stage|live)
+     * @param string  $sPlace    place (onhold|ready2install|deployed)
+     * @param string  $sHost     hostname (for place deployed)
+     * @return type string
+     */
     public function setPackage($sPackage, $sPhase, $sPlace=false, $sHost=false){
         $this->sPackage=preg_replace('/[^a-z\-\_0-9]/', '' ,$sPackage);
         $this->setPhase($sPhase, $sPlace, $sHost);
         return $this->sPackage;
     }
     
+    /**
+     * set a phase (and more granular items)
+     * @see setProject()
+     * 
+     * @param string  $sPhase    phase (preview|stage|live)
+     * @param string  $sPlace    place (onhold|ready2install|deployed)
+     * @param string  $sHost     hostname (for place deployed)
+     * @return type string
+     */
     public function setPhase($sPhase, $sPlace=false, $sHost=false){
         if (!$this->sProject && !$this->sPackage){
             $this->_quit(__FUNCTION__ , "ERROR: you need to set a project. Use the setProject() method to do so.");
@@ -371,6 +391,14 @@ class valuestore {
         return $this->sPhase;
     }
 
+    /**
+     * set a place (and host)
+     * @see setProject()
+     * 
+     * @param string  $sPlace    place (onhold|ready2install|deployed)
+     * @param string  $sHost     hostname (for place deployed)
+     * @return type string
+     */
     public function setPlace($sPlace, $sHost=false){
         if ((!$this->sProject && !$this->sPackage)){
             $this->_quit(__FUNCTION__ , "ERROR: you need to set a project and phase. Use the setProject() method to do so.");
@@ -387,6 +415,13 @@ class valuestore {
         return $this->sPlace;
     }
     
+    /**
+     * set a host for place "deployed"
+     * @see setProject()
+     * 
+     * @param string  $sHost     hostname
+     * @return type string
+     */
     public function setHost($sHost=false){
         if ((!$this->sProject && !$this->sPackage)){
             $this->_quit(__FUNCTION__ , "ERROR: you need to set a project, phase and place. Use the setProject() method to do so.");
@@ -423,11 +458,6 @@ class valuestore {
         return true;
     }
     
-    /**
-     * delete values
-     * @return boolean
-     */
-    
     /**
      * delete values from value store. You need to call setProject() to set
      * project or package and optional phase, place, host. Then call this delete