add docblocks

Author: dracony

src/PHPixie/HTTP.php

@@ -2,70 +2,94 @@
 
 namespace PHPixie;
 
+use PHPixie\HTTP\Messages\Message\Request;
+
+/**
+ * HTTP component
+ */
 class HTTP
 {
+    /**
+     * @var HTTP\Builder
+     */
     protected $builder;
-    
+
+    /**
+     * Constructor
+     * @param Slice $slice
+     */
     public function __construct($slice)
     {
         $this->builder = $this->buildBuilder($slice);
     }
 
     /**
-     * @return HTTP\Messages\Message\Request\ServerRequest\SAPI
+     * Create a PSR 7 ServerRequest from globals
+     * @return Request\ServerRequest\SAPI
      */
     public function sapiServerRequest()
     {
         return $this->builder->messages()->sapiServerRequest();
     }
 
     /**
-     * @param HTTP\Messages\Message\Request\ServerRequest $serverRequest
+     * Create PHPixie request from server request.
+     *
+     * If the server request is not specified it will be created
+     * from globals
+     * @param Request\ServerRequest $serverRequest
      * @return HTTP\Request
      */
     public function request($serverRequest = null)
     {
-        if($serverRequest === null) {
+        if ($serverRequest === null) {
             $serverRequest = $this->sapiServerRequest();
         }
         return $this->builder->request($serverRequest);
     }
 
     /**
+     * Output a HTTP response
      * @param HTTP\Responses\Response $response
-     * @param HTTP\Context $context
+     * @param HTTP\Context $context Optional HTTP context to use (e.g. for cookie data)
+     * @return void
      */
     public function output($response, $context = null)
     {
         $this->builder->output()->response($response, $context);
     }
 
     /**
+     * Output a PSR-7 response message
      * @param HTTP\Responses\Response $responseMessage
+     * @return void
      */
     public function outputResponseMessage($responseMessage)
     {
         $this->builder->output()->responseMessage($responseMessage);
     }
 
     /**
+     * Create a context from a HTTP request
      * @param HTTP\Request $request
-     * @param HTTP\Context\Session\SAPI $session
+     * @param HTTP\Context\Session $session Optional session container,
+     *        if not specified the default PHP session storage is used
      * @return HTTP\Context
      */
     public function context($request, $session = null)
     {
         $serverRequest = $request->serverRequest();
         $cookieArray = $serverRequest->getCookieParams();
         $cookies = $this->builder->cookies($cookieArray);
-        if($session === null) {
+        if ($session === null) {
             $session = $this->builder->sapiSession();
         }
-        
+
         return $this->builder->context($request, $cookies, $session);
     }
 
     /**
+     * Create a context container
      * @param HTTP\Context $context
      * @return HTTP\Context\Container\Implementation
      */
@@ -75,6 +99,7 @@ public function contextContainer($context)
     }
 
     /**
+     * Message factory
      * @return HTTP\Messages
      */
     public function messages()
@@ -83,6 +108,7 @@ public function messages()
     }
 
     /**
+     * Response factory
      * @return HTTP\Responses
      */
     public function responses()
@@ -91,13 +117,18 @@ public function responses()
     }
 
     /**
+     * Get internal factory
      * @return HTTP\Builder
      */
     public function builder()
     {
         return $this->builder;
     }
-    
+
+    /**
+     * @param Slice $slice
+     * @return HTTP\Builder
+     */
     protected function buildBuilder($slice)
     {
         return new HTTP\Builder($slice);

src/PHPixie/HTTP/Builder.php

@@ -2,16 +2,33 @@
 
 namespace PHPixie\HTTP;
 
+use PHPixie\Slice;
+
+/**
+ * HTTP factory
+ */
 class Builder
 {
+    /**
+     * @var Slice
+     */
     protected $slice;
+
+    /**
+     * @var array
+     */
     protected $instances = array();
-    
+
+    /**
+     * Builder constructor
+     * @param Slice $slice
+     */
     public function __construct($slice) {
         $this->slice = $slice;
     }
 
     /**
+     * Message factory
      * @return Messages
      */
     public function messages()
@@ -20,6 +37,7 @@ public function messages()
     }
 
     /**
+     * Response factory
      * @return Responses
      */
     public function responses()
@@ -28,6 +46,7 @@ public function responses()
     }
 
     /**
+     * Output
      * @return Output
      */
     public function output()
@@ -36,24 +55,27 @@ public function output()
     }
 
     /**
+     * Build PHPixie request from PSR-7 ServerRequest
      * @param $serverRequest
-     * @return \PHPixie\HTTP\Request
+     * @return Request
      */
     public function request($serverRequest)
     {
         return new Request($this, $serverRequest);
     }
 
     /**
+     * Proxy for building slice data
      * @param array $array
-     * @return mixed
+     * @return Slice\Type\ArrayData
      */
     public function data($array = array())
     {
         return $this->slice->arrayData($array);
     }
 
     /**
+     * Build headers storage
      * @param array $headerArray
      * @return Data\Headers
      */
@@ -63,6 +85,7 @@ public function headers($headerArray = array())
     }
 
     /**
+     * Build editable headers storage
      * @param array $headerArray
      * @return Data\Headers\Editable
      */
@@ -72,6 +95,7 @@ public function editableHeaders($headerArray = array())
     }
 
     /**
+     * Build server data storage
      * @param array $serverData
      * @return Data\Server
      */
@@ -81,6 +105,7 @@ public function serverData($serverData = array())
     }
 
     /**
+     * Build HTTP context
      * @param Request $request
      * @param Context\Cookies $cookies
      * @param Context\Session\SAPI $session
@@ -92,6 +117,7 @@ public function context($request, $cookies, $session)
     }
 
     /**
+     * Build cookie storage
      * @param array $cookieArray
      * @return Context\Cookies
      */
@@ -101,6 +127,7 @@ public function cookies($cookieArray = array())
     }
 
     /**
+     * Build default session storage
      * @return Context\Session\SAPI
      */
     public function sapiSession()
@@ -109,6 +136,7 @@ public function sapiSession()
     }
 
     /**
+     * Build a single cookie update
      * @param            $name
      * @param            $value
      * @param null       $expires
@@ -140,14 +168,19 @@ public function cookiesUpdate(
     }
 
     /**
+     * Build context container
      * @param $context
      * @return Context\Container\Implementation
      */
     public function contextContainer($context)
     {
         return new Context\Container\Implementation($context);
     }
-    
+
+    /**
+     * @param $name
+     * @return mixed
+     */
     protected function instance($name)
     {
         if(!array_key_exists($name, $this->instances)) {
@@ -157,17 +190,26 @@ protected function instance($name)
 
         return $this->instances[$name];
     }
-    
+
+    /**
+     * @return Messages
+     */
     protected function buildMessages()
     {
         return new Messages();
     }
-    
+
+    /**
+     * @return Responses
+     */
     protected function buildResponses()
     {
         return new Responses($this);
     }
-    
+
+    /**
+     * @return Output
+     */
     protected function buildOutput()
     {
         return new Output();

src/PHPixie/HTTP/Context.php

@@ -2,16 +2,31 @@
 
 namespace PHPixie\HTTP;
 
+/**
+ * Represents a HTTP context
+ * containing a request and cookie and session storages
+ */
 class Context
 {
+    /**
+     * @var Request
+     */
     protected $request;
+
+    /**
+     * @var Context\Cookies
+     */
     protected $cookies;
+
+    /**
+     * @var Context\Session
+     */
     protected $session;
 
     /**
      * @param Request $request
      * @param Context\Cookies $cookies
-     * @param Context\Session\SAPI $session
+     * @param Context\Session $session
      */
     public function __construct($request, $cookies, $session)
     {
@@ -21,6 +36,7 @@ public function __construct($request, $cookies, $session)
     }
 
     /**
+     * HTTP request
      * @return Request
      */
     public function request()
@@ -29,6 +45,7 @@ public function request()
     }
 
     /**
+     * Cookie storage
      * @return Context\Cookies
      */
     public function cookies()
@@ -37,7 +54,8 @@ public function cookies()
     }
 
     /**
-     * @return Context\Session\SAPI
+     * Session storage
+     * @return Context\Session
      */
     public function session()
     {

src/PHPixie/HTTP/Context/Container.php

@@ -1,8 +1,15 @@
 <?php
 
 namespace PHPixie\HTTP\Context;
+use PHPixie\HTTP\Context;
 
+/**
+ * HTTP Context container
+ */
 interface Container
 {
+    /**
+     * @return Context
+     */
     public function httpContext();
 }