added docblocks3.2.1

9 files changed, 139 insertions, 17 deletions

diff --git a/bundles/app/src/Project/App.php b/bundles/app/src/Project/App.php
index 468bb35..b346f94 100755
--- a/bundles/app/src/Project/App.php
+++ b/bundles/app/src/Project/App.php
@@ -2,8 +2,16 @@
 
 namespace Project;
 
+/**
+ * Default application bundle
+ */
 class App extends \PHPixie\DefaultBundle
 {
+    /**
+     * Build bundle builder
+     * @param \PHPixie\BundleFramework\Builder $frameworkBuilder
+     * @return App\Builder
+     */
     protected function buildBuilder($frameworkBuilder)
     {
         return new App\Builder($frameworkBuilder);
diff --git a/bundles/app/src/Project/App/Builder.php b/bundles/app/src/Project/App/Builder.php
index bad2370..73514c8 100755
--- a/bundles/app/src/Project/App/Builder.php
+++ b/bundles/app/src/Project/App/Builder.php
@@ -2,23 +2,42 @@
 
 namespace Project\App;
 
+/**
+ * App bundle builder
+ */
 class Builder extends \PHPixie\DefaultBundle\Builder
 {
+    /**
+     * Build Processor for HTTP requests
+     * @return HTTPProcessor
+     */
     protected function buildHttpProcessor()
     {
         return new HTTPProcessor($this);
     }
-    
+
+    /**
+     * Build ORM Wrappers
+     * @return ORMWrappers
+     */
     protected function buildORMWrappers()
     {
         return new ORMWrappers($this);
     }
-    
+
+    /**
+     * Get bundle root directory
+     * @return string
+     */
     protected function getRootDirectory()
     {
         return realpath(__DIR__.'/../../../');
     }
-    
+
+    /**
+     * Get bundle name
+     * @return string
+     */
     public function bundleName()
     {
         return 'app';
diff --git a/bundles/app/src/Project/App/HTTPProcessor.php b/bundles/app/src/Project/App/HTTPProcessor.php
index 0555f7b..f8ede3d 100755
--- a/bundles/app/src/Project/App/HTTPProcessor.php
+++ b/bundles/app/src/Project/App/HTTPProcessor.php
@@ -4,14 +4,24 @@ namespace Project\App;
 
 class HTTPProcessor extends \PHPixie\DefaultBundle\Processor\HTTP\Builder
 {
+    /**
+     * @var Builder
+     */
     protected $builder;
-    protected $attribute = 'processor';
-    
+
+    /**
+     * Constructor
+     * @param Builder $builder
+     */
     public function __construct($builder)
     {
         $this->builder = $builder;
     }
-    
+
+    /**
+     * Build 'greet' processor
+     * @return HTTPProcessors\Greet
+     */
     protected function buildGreetProcessor()
     {
         $components = $this->builder->components();
diff --git a/bundles/app/src/Project/App/HTTPProcessors/Greet.php b/bundles/app/src/Project/App/HTTPProcessors/Greet.php
index ac4f3b8..2d38205 100755
--- a/bundles/app/src/Project/App/HTTPProcessors/Greet.php
+++ b/bundles/app/src/Project/App/HTTPProcessors/Greet.php
@@ -2,15 +2,30 @@
 
 namespace Project\App\HTTPProcessors;
 
+use PHPixie\HTTP\Request;
+use PHPixie\Template;
+
 class Greet extends \PHPixie\DefaultBundle\Processor\HTTP\Actions
 {
+    /**
+     * @var Template Template component
+     */
     protected $template;
-    
+
+    /**
+     * Constructor
+     * @param Template $template
+     */
     public function __construct($template)
     {
         $this->template = $template;
     }
-    
+
+    /**
+     * Default action
+     * @param Request $request HTTP request
+     * @return Template\Container
+     */
     public function defaultAction($request)
     {
         $container = $this->template->get('app:greet');
diff --git a/bundles/app/src/Project/App/ORMWrappers.php b/bundles/app/src/Project/App/ORMWrappers.php
index 6799b89..bb5b995 100755
--- a/bundles/app/src/Project/App/ORMWrappers.php
+++ b/bundles/app/src/Project/App/ORMWrappers.php
@@ -2,8 +2,15 @@
 
 namespace Project\App;
 
+/**
+ * Here you can define wrappers for the ORM to use.
+ */
 class ORMWrappers extends \PHPixie\ORM\Wrappers\Implementation
 {
+    /**
+     * Array of model names that have custom Entity wrappers
+     * @var array
+     */
     protected $databaseEntities = array(
         
     );
diff --git a/src/Project/Framework.php b/src/Project/Framework.php
index c71b85a..b1b2209 100755
--- a/src/Project/Framework.php
+++ b/src/Project/Framework.php
@@ -1,8 +1,17 @@
 <?php
 namespace Project;
 
-class Framework extends \PHPixie\BundleFramework
+use \PHPixie\BundleFramework;
+
+/**
+ * Project class extending the PHPixie Framework.
+ */
+class Framework extends BundleFramework
 {
+    /**
+     * Project factory
+     * @return Framework\Builder
+     */
     protected function buildBuilder()
     {
         return new Framework\Builder();
diff --git a/src/Project/Framework/Builder.php b/src/Project/Framework/Builder.php
index d467ec1..c4b5640 100755
--- a/src/Project/Framework/Builder.php
+++ b/src/Project/Framework/Builder.php
@@ -2,18 +2,35 @@
 
 namespace Project\Framework;
 
+/**
+ * Your projects main factory, usually referenced as $frameworkBuilder.
+ *
+ * You can use it to override and customize the framework.
+ */
 class Builder extends \PHPixie\BundleFramework\Builder
 {
+    /**
+     * Your Bundles registry
+     * @return Bundles
+     */
     protected function buildBundles()
     {
         return new Bundles($this);
     }
-    
+
+    /**
+     * Your extension registry registry
+     * @return Bundles
+     */
     protected function buildExtensions()
     {
         return new Extensions($this);
     }
-    
+
+    /**
+     * Projects root directory
+     * @return Bundles
+     */
     protected function getRootDirectory()
     {
         return realpath(__DIR__.'/../../../');
diff --git a/src/Project/Framework/Bundles.php b/src/Project/Framework/Bundles.php
index 52a7c31..d98eb88 100755
--- a/src/Project/Framework/Bundles.php
+++ b/src/Project/Framework/Bundles.php
@@ -2,17 +2,20 @@
 
 namespace Project\Framework;
 
+/**
+ * Your projects bundle registry.
+ * Every bundle you add must be registered here.
+ */
 class Bundles extends \PHPixie\BundleFramework\Bundles
 {
+    /**
+     * Should return an array of Bundle instances
+     * @return array
+     */
     protected function buildBundles()
     {
         return array(
             new \Project\App($this->builder)
         );
     }
-    
-    protected function getRootFolder()
-    {
-        return realpath(__DIR__.'/../../');
-    }
 }
\ No newline at end of file
diff --git a/src/Project/Framework/Extensions.php b/src/Project/Framework/Extensions.php
index ad972fa..156bd7d 100644
--- a/src/Project/Framework/Extensions.php
+++ b/src/Project/Framework/Extensions.php
@@ -2,7 +2,41 @@
 
 namespace Project\Framework;
 
+/**
+ * Extensions registry.
+  */
 class Extensions extends \PHPixie\Framework\Extensions
 {
-    
+    /**
+     * Extensions for the Template component
+     * @return array
+     */
+    public function templateExtensions()
+    {
+        return array_merge(parent::templateExtensions(), array(
+           //add your Template Extensions here
+        ));
+    }
+
+    /**
+     * Format compilers for the Template component
+     * @return array
+     */
+    public function templateFormats()
+    {
+        return array_merge(parent::templateFormats(), array(
+            //add your Template Formats here
+        ));
+    }
+
+    /**
+     * Provider Builders for the Auth component
+     * @return array
+     */
+    public function authProviderBuilders()
+    {
+        return array_merge(parent::authProviderBuilders(), array(
+            //add your Auth Provider Builders here
+        ));
+    }
 }
\ No newline at end of file