Merge pull request #2 from Linfuby/master

PHPDocs

Author: dracony

src/PHPixie/HTTP.php

@@ -10,30 +10,49 @@ public function __construct($slice)
     {
         $this->builder = $this->buildBuilder($slice);
     }
-    
+
+    /**
+     * @return HTTP\Messages\Message\Request\ServerRequest\SAPI
+     */
     public function sapiServerRequest()
     {
         return $this->builder->messages()->sapiServerRequest();
     }
-    
+
+    /**
+     * @param HTTP\Messages\Message\Request\ServerRequest $serverRequest
+     * @return HTTP\Request
+     */
     public function request($serverRequest = null)
     {
         if($serverRequest === null) {
             $serverRequest = $this->sapiServerRequest();
         }
         return $this->builder->request($serverRequest);
     }
-    
+
+    /**
+     * @param HTTP\Responses\Response $response
+     * @param HTTP\Context $context
+     */
     public function output($response, $context = null)
     {
         $this->builder->output()->response($response, $context);
     }
-    
+
+    /**
+     * @param HTTP\Responses\Response $responseMessage
+     */
     public function outputResponseMessage($responseMessage)
     {
         $this->builder->output()->responseMessage($responseMessage);
     }
-    
+
+    /**
+     * @param HTTP\Request $request
+     * @param HTTP\Context\Session\SAPI $session
+     * @return HTTP\Context
+     */
     public function context($request, $session = null)
     {
         $serverRequest = $request->serverRequest();
@@ -45,22 +64,35 @@ public function context($request, $session = null)
 
         return $this->builder->context($request, $cookies, $session);
     }
-    
+
+    /**
+     * @param HTTP\Context $context
+     * @return HTTP\Context\Container\Implementation
+     */
     public function contextContainer($context)
     {
         return $this->builder->contextContainer($context);
     }
-    
+
+    /**
+     * @return HTTP\Messages
+     */
     public function messages()
     {
         return $this->builder->messages();
     }
-    
+
+    /**
+     * @return HTTP\Responses
+     */
     public function responses()
     {
         return $this->builder->responses();
     }
- 
+
+    /**
+     * @return HTTP\Builder
+     */
     public function builder()
     {
         return $this->builder;

src/PHPixie/HTTP/Builder.php

@@ -10,62 +10,114 @@ class Builder
     public function __construct($slice) {
         $this->slice = $slice;
     }
-    
+
+    /**
+     * @return Messages
+     */
     public function messages()
     {
         return $this->instance('messages');
     }
-    
+
+    /**
+     * @return Responses
+     */
     public function responses()
     {
         return $this->instance('responses');
     }
-    
+
+    /**
+     * @return Output
+     */
     public function output()
     {
         return $this->instance('output');
     }
-    
+
+    /**
+     * @param $serverRequest
+     * @return \PHPixie\HTTP\Request
+     */
     public function request($serverRequest)
     {
         return new Request($this, $serverRequest);
     }
-    
+
+    /**
+     * @param array $array
+     * @return mixed
+     */
     public function data($array = array())
     {
         return $this->slice->arrayData($array);
     }
-    
+
+    /**
+     * @param array $headerArray
+     * @return Data\Headers
+     */
     public function headers($headerArray = array())
     {
         return new Data\Headers($headerArray);
     }
-    
+
+    /**
+     * @param array $headerArray
+     * @return Data\Headers\Editable
+     */
     public function editableHeaders($headerArray = array())
     {
         return new Data\Headers\Editable($headerArray);
     }
-    
+
+    /**
+     * @param array $serverData
+     * @return Data\Server
+     */
     public function serverData($serverData = array())
     {
         return new Data\Server($serverData);
     }
-    
+
+    /**
+     * @param Request $request
+     * @param Context\Cookies $cookies
+     * @param Context\Session\SAPI $session
+     * @return Context
+     */
     public function context($request, $cookies, $session)
     {
         return new Context($request, $cookies, $session);
     }
-    
+
+    /**
+     * @param array $cookieArray
+     * @return Context\Cookies
+     */
     public function cookies($cookieArray = array())
     {
         return new Context\Cookies($this, $cookieArray);
     }
-    
+
+    /**
+     * @return Context\Session\SAPI
+     */
     public function sapiSession()
     {
         return new Context\Session\SAPI();
     }
-    
+
+    /**
+     * @param            $name
+     * @param            $value
+     * @param null       $expires
+     * @param string     $path
+     * @param null       $domain
+     * @param bool       $secure
+     * @param bool       $httpOnly
+     * @return Context\Cookies\Update
+     */
     public function cookiesUpdate(
         $name,
         $value,
@@ -86,7 +138,11 @@ public function cookiesUpdate(
             $httpOnly
         );    
     }
-    
+
+    /**
+     * @param $context
+     * @return Context\Container\Implementation
+     */
     public function contextContainer($context)
     {
         return new Context\Container\Implementation($context);

src/PHPixie/HTTP/Context.php

@@ -7,24 +7,38 @@ class Context
     protected $request;
     protected $cookies;
     protected $session;
-    
+
+    /**
+     * @param Request $request
+     * @param Context\Cookies $cookies
+     * @param Context\Session\SAPI $session
+     */
     public function __construct($request, $cookies, $session)
     {
         $this->request = $request;
         $this->cookies = $cookies;
         $this->session = $session;
     }
-    
+
+    /**
+     * @return Request
+     */
     public function request()
     {
         return $this->request;
     }
-    
+
+    /**
+     * @return Context\Cookies
+     */
     public function cookies()
     {
         return $this->cookies;
     }
-    
+
+    /**
+     * @return Context\Session\SAPI
+     */
     public function session()
     {
         return $this->session;