Skip to content

Commit

Permalink
Improve code organization and docblock.
Browse files Browse the repository at this point in the history
Signed-off-by: crynobone <crynobone@gmail.com>
  • Loading branch information
crynobone committed Jun 15, 2013
1 parent caa9bfb commit bde33dc
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 31 deletions.
20 changes: 11 additions & 9 deletions src/Orchestra/Facile/Environment.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public function __construct()
* @param string $name Name of template
* @param array $data
* @param string $format
* @return Orchestra\Facile\Response
* @return \Orchestra\Facile\Response
*/
public function make($name, $data = array(), $format = null)
{
Expand All @@ -76,7 +76,9 @@ public function make($name, $data = array(), $format = null)
* </code>
*
* @access public
* @return Orchestra\Facile\Response
* @param string $view
* @param array $data
* @return \Orchestra\Facile\Response
*/
public function view($view, $data = array())
{
Expand All @@ -103,7 +105,7 @@ public function view($view, $data = array())
*
* @access public
* @param mixed $data
* @return Orchestra\Facile\Response
* @return \Orchestra\Facile\Response
*/
public function with($data)
{
Expand All @@ -115,11 +117,11 @@ public function with($data)
/**
* Register a template.
*
* @access public
* @param string $name
* @param Orchestra\Facile\Template\Driver $callback
* @access public
* @param string $name
* @param \Orchestra\Facile\Template\Driver $callback
* @return void
* @throws RuntimeException If $callback not instanceof
* @throws \RuntimeException If $callback not instanceof
* Orchestra\Facile\Template\Driver
*/
public function template($name, $template)
Expand All @@ -141,8 +143,8 @@ public function template($name, $template)
*
* @access public
* @param string $name
* @return Orchestra\Facile\Template\Driver
* @throws InvalidArgumentException If template is not defined.
* @return \Orchestra\Facile\Template\Driver
* @throws \InvalidArgumentException If template is not defined.
*/
public function get($name)
{
Expand Down
24 changes: 13 additions & 11 deletions src/Orchestra/Facile/Response.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ class Response implements RenderableInterface {
/**
* Environment instance.
*
* @var Orchestra\Facile\Environment
* @var \Orchestra\Facile\Environment
*/
protected $env = null;

/**
* Template instance.
*
* @var Orchestra\Facile\Template\Driver
* @var \Orchestra\Facile\Template\Driver
*/
protected $template = null;

Expand All @@ -38,13 +38,13 @@ class Response implements RenderableInterface {
);

/**
* Construct a new Facile\Response instance.
* Construct a new Response instance.
*
* @access public
* @param Orchestar\Facile\Environment $env
* @param Orchestra\Facile\Template\Driver $template
* @param array $data
* @param string $format
* @access public
* @param \Orchestar\Facile\Environment $env
* @param \Orchestra\Facile\Template\Driver $template
* @param array $data
* @param string $format
* @return void
*/
public function __construct(Environment $env, Template\Driver $template, $data = array(), $format = null)
Expand Down Expand Up @@ -128,7 +128,7 @@ public function template($name)
*
* @access public
* @param string $format
* @return string
* @return self
*/
public function format($format = null)
{
Expand All @@ -149,18 +149,20 @@ public function format($format = null)
*
* @access public
* @param string $format
* @return void
* @return self
*/
public function setFormat($format)
{
$this->format = $format;

return $this;
}

/**
* Get Output Format.
*
* @access public
* @return void
* @return string
*/
public function getFormat()
{
Expand Down
10 changes: 5 additions & 5 deletions src/Orchestra/Facile/Template/Base.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@ class Base extends Driver {
protected $formats = array('html', 'json');

/**
* Default format
* Default format.
*
* @var string
*/
protected $defaultFormat = 'html';

/**
* Compose HTML
* Compose HTML.
*
* @access public
* @param mixed $view
* @param array $data
* @param integer $status
* @return string
* @return \Illuminate\Http\Response
*/
public function composeHtml($view = null, $data = array(), $status = 200)
{
Expand All @@ -42,13 +42,13 @@ public function composeHtml($view = null, $data = array(), $status = 200)
}

/**
* Compose json
* Compose JSON.
*
* @access public
* @param mixed $view
* @param array $data
* @param integer $status
* @return string
* @return \Illuminate\Http\JsonResponse
*/
public function composeJson($view, $data = array(), $status = 200)
{
Expand Down
14 changes: 8 additions & 6 deletions src/Orchestra/Facile/Template/Driver.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ abstract class Driver {
protected $formats = array('html');

/**
* Default format
* Default format.
*
* @var string
*/
Expand All @@ -40,7 +40,10 @@ public function format()
* Compose requested format.
*
* @access public
* @return mixedd
* @param string $format
* @param array $compose
* @return mixed
* @throws \RuntimeException
*/
public function compose($format, $compose = array())
{
Expand Down Expand Up @@ -68,7 +71,7 @@ public function compose($format, $compose = array())
* @param mixed $view
* @param array $data
* @param integer $status
* @return Response
* @return \Illuminate\Http\Response
*/
public function composeError($view, $data = array(), $status = 404)
{
Expand All @@ -80,7 +83,7 @@ public function composeError($view, $data = array(), $status = 404)
}

/**
* Transform given data
* Transform given data.
*
* @access public
* @param array $data
Expand All @@ -91,7 +94,7 @@ public function transform($item)
switch (true)
{
case ($item instanceof Eloquent) :
// passthru
# passthru;
case ($item instanceof ArrayableInterface) :
return $item->toArray();

Expand All @@ -108,7 +111,6 @@ public function transform($item)
'links' => e($item->links()),
);


case (is_array($item)) :
return array_map(array($this, 'transform'), $item);

Expand Down

0 comments on commit bde33dc

Please sign in to comment.