docblocks

Author: dracony

src/PHPixie/Framework/Assets.php

@@ -2,24 +2,55 @@
 
 namespace PHPixie\Framework;
 
+use PHPixie\Filesystem\Locators\Locator;
+use PHPixie\Filesystem\Root;
+
+/**
+ * Assets registry
+ */
 class Assets
 {
     /**
      * @type Components
      */
     protected $components;
+
+    /**
+     * @var array
+     */
     protected $instances = array();
-    
+
+    /**
+     * Constructor
+     * @param Components $components
+     */
     public function __construct($components)
     {
         $this->components = $components;
     }
-    
+
+    /**
+     * Assets root directory
+     * @return Root
+     */
+    public function frameworkAssetsRoot()
+    {
+        return $this->instance('frameworkAssetsRoot');
+    }
+
+    /**
+     * Filesystem locator for templates
+     * @return Locator
+     */
     public function frameworkTemplateLocator()
     {
         return $this->instance('frameworkTemplateLocator');
     }
-    
+
+    /**
+     * @param string $name
+     * @return mixed
+     */
     protected function instance($name)
     {
         if(!array_key_exists($name, $this->instances)) {
@@ -29,24 +60,29 @@ protected function instance($name)
 
         return $this->instances[$name];
     }
-    
-    public function frameworkAssetsRoot()
-    {
-        return $this->instance('frameworkAssetsRoot');
-    }
-    
+
+    /**
+     * @return Root
+     */
     protected function buildFrameworkAssetsRoot()
     {
         $directory = realpath(__DIR__.'/../../../assets');
         return $this->buildFilesystemRoot($directory);
     }
-    
+
+    /**
+     * @param string $directory
+     * @return Root
+     */
     protected function buildFilesystemRoot($directory)
     {
         $filesystem = $this->components->filesystem();
         return $filesystem->root($directory);
     }
-    
+
+    /**
+     * @return Locator
+     */
     protected function buildFrameworkTemplateLocator()
     {
         $slice      = $this->components->slice();

src/PHPixie/Framework/Builder.php

@@ -2,11 +2,18 @@
 
 namespace PHPixie\Framework;
 
+/**
+ * Base framework factory
+ */
 abstract class Builder
 {
+    /**
+     * @var array
+     */
     protected $instances = array();
 
     /**
+     * Assets registry
      * @return Assets
      */
     public function assets()
@@ -15,6 +22,7 @@ public function assets()
     }
 
     /**
+     * Components factory
      * @return Components
      */
     public function components()
@@ -23,6 +31,7 @@ public function components()
     }
 
     /**
+     * Context container (e.g. for HTTP context)
      * @return Context
      */
     public function context()
@@ -31,6 +40,7 @@ public function context()
     }
 
     /**
+     * Extensions registry
      * @return Extensions
      */
     public function extensions()
@@ -39,6 +49,7 @@ public function extensions()
     }
 
     /**
+     * HTTP handler
      * @return HTTP
      */
     public function http()
@@ -47,13 +58,18 @@ public function http()
     }
 
     /**
+     * Processors factory
      * @return Processors
      */
     public function processors()
     {
         return $this->instance('processors');
     }
-    
+
+    /**
+     * @param string $name
+     * @return mixed
+     */
     protected function instance($name)
     {
         if(!array_key_exists($name, $this->instances)) {
@@ -63,38 +79,60 @@ protected function instance($name)
 
         return $this->instances[$name];
     }
-    
+
+    /**
+     * @return Assets
+     */
     protected function buildAssets()
     {
         return new Assets(
             $this->components()
         );
     }
-    
+
+    /**
+     * @return Components
+     */
     protected function buildComponents()
     {
         return new Components($this);
     }
-    
+
+    /**
+     * @return Context
+     */
     protected function buildContext()
     {
         return new Context($this);
     }
-    
+
+    /**
+     * @return Extensions
+     */
     protected function buildExtensions()
     {
         return new Extensions($this);
     }
-    
+
+    /**
+     * @return HTTP
+     */
     protected function buildHttp()
     {
         return new HTTP($this);
     }
-    
+
+    /**
+     * @return Processors
+     */
     protected function buildProcessors()
     {
         return new Processors($this);
     }
-    
+
+    /**
+     * Framework Configuration
+     * @return Configuration
+     */
     abstract public function configuration();
 }