patternseek / componentview

lib/AbstractViewComponent.php

Doc Comments +6 added lines, -3 removed lines

@@ -142,7 +142,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {
@@ -184,7 +184,7 @@ 
     /**
      * Execute a component method within the page or component.
      * Called first on a top level component which then passes the call down to the appropriate sub-component (or executes on itself if appropriate).
-     * @param array|string $methodName A methodname in the format subComponent.anotherSubComponent.methodName. Either dotted string as described, or parts in an array. The top level page component shouldn't be included
+     * @param string $methodName A methodname in the format subComponent.anotherSubComponent.methodName. Either dotted string as described, or parts in an array. The top level page component shouldn't be included
      * @param array $args
      * @throws \Exception
      * @return ViewComponentResponse
@@ -213,6 +213,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $execMethod
+     */
     public function getExecPath( $execMethod )
     {
         $path = $this->getPath();
@@ -318,7 +321,7 @@ 
      * Render a child component.
      *
      * @param $handle
-     * @return ViewComponentResponse
+     * @return string
      * @throws \Exception
      */
     public function renderChild( $handle )

Spacing +91 added lines, -91 removed lines

@@ -82,7 +82,7 @@ 
         AbstractViewComponent $parent = null,
         ExecHelper $execHelper = null,
         LoggerInterface $logger = null
-    ){
+    ) {
         // Null means we are root
         $this->parent = $parent;
 
@@ -92,11 +92,11 @@ 
         if (null === $execHelper) {
             $execHelper = new ExecHelper();
         }
-        $this->setExec( $execHelper );
+        $this->setExec($execHelper);
 
         $this->handleDependencyInjection();
         
-        $this->setLogger( $logger );
+        $this->setLogger($logger);
 
         // Set up the state container
         $this->initState();
@@ -106,11 +106,11 @@ 
      * @param string $message
      * @param string $level A constant from LogLevel
      */
-    protected function log( $message, $level ){
-        if( isset( $this->logger ) ){
-            $class = get_class( $this );
+    protected function log($message, $level) {
+        if (isset($this->logger)) {
+            $class = get_class($this);
             $message = "[{$class}] {$message}";
-            $this->logger->log( $level, $message );
+            $this->logger->log($level, $message);
         }
     }
 
@@ -118,9 +118,9 @@ 
      * User this to serialise ViewComponents as extra steps may be added later.
      * @return string
      */
-    public function dehydrate(){
-        $this->log( "Dehydrating", LogLevel::DEBUG );
-        return serialize( $this );
+    public function dehydrate() {
+        $this->log("Dehydrating", LogLevel::DEBUG);
+        return serialize($this);
     }
 
     /**
@@ -131,13 +131,13 @@ 
      * @return AbstractViewComponent
      */
     
-    public static function rehydrate( $serialised, ExecHelper $execHelper, LoggerInterface $logger = null ){
+    public static function rehydrate($serialised, ExecHelper $execHelper, LoggerInterface $logger = null) {
         /** @var AbstractViewComponent $view */
-        $view = unserialize( $serialised );
-        $view->setExec( $execHelper );
+        $view = unserialize($serialised);
+        $view->setExec($execHelper);
         $view->handleDependencyInjection();
-        $view->setLogger( $logger );
-        $view->log( "Rehydrated", LogLevel::DEBUG );
+        $view->setLogger($logger);
+        $view->log("Rehydrated", LogLevel::DEBUG);
         return $view;
     }
 
@@ -161,7 +161,7 @@ 
      * @throws \Exception
      * @return ViewComponentResponse
      */
-    public function render( $execMethodName = null, array $execArgs = null )
+    public function render($execMethodName = null, array $execArgs = null)
     {
         $this->state->validate();
         $this->initTemplate();
@@ -169,13 +169,13 @@ 
         // If we're called with an 'exec' then run it instead of rendering the whole tree.
         // It may still render the whole tree or it may just render a portion or just return JSON
         if ($execMethodName) { // Used to test for null but it could easily be an empty string
-            $this->log( "Rendering with exec: {$execMethodName}, args:".var_export($execArgs, true ), LogLevel::DEBUG );
-            $out = $this->execMethod( $execMethodName, $execArgs );
+            $this->log("Rendering with exec: {$execMethodName}, args:" . var_export($execArgs, true), LogLevel::DEBUG);
+            $out = $this->execMethod($execMethodName, $execArgs);
         }else {
-            $this->log( "Rendering without exec", LogLevel::DEBUG );
-            $out = $this->template->render( $this->state, $this->props );
-            if (!( $out instanceof ViewComponentResponse )) {
-                throw new \Exception( get_class( $this->template ) . " returned invalid response. Should have been an instance of ViewComponentResponse" );
+            $this->log("Rendering without exec", LogLevel::DEBUG);
+            $out = $this->template->render($this->state, $this->props);
+            if (!($out instanceof ViewComponentResponse)) {
+                throw new \Exception(get_class($this->template) . " returned invalid response. Should have been an instance of ViewComponentResponse");
             }
         }
         return $out;
@@ -189,34 +189,34 @@ 
      * @throws \Exception
      * @return ViewComponentResponse
      */
-    protected function execMethod( $methodName, array $args = null )
+    protected function execMethod($methodName, array $args = null)
     {
-        if (!is_array( $methodName )) {
-            $methodName = explode( '.', $methodName );
+        if (!is_array($methodName)) {
+            $methodName = explode('.', $methodName);
         }
-        if (count( $methodName ) == 1) {
+        if (count($methodName) == 1) {
             $methodName = $methodName[ 0 ] . 'Handler';
-            $out = $this->$methodName( $args );
+            $out = $this->$methodName($args);
         }else {
-            $childName = array_shift( $methodName );
+            $childName = array_shift($methodName);
             $child = $this->childComponents[ $childName ];
             if ($child instanceof AbstractViewComponent) {
-                $out = $child->execMethod( $methodName, $args );
+                $out = $child->execMethod($methodName, $args);
             }else {
-                throw new \Exception( implode( ".", $methodName ) . " is not a valid method." );
+                throw new \Exception(implode(".", $methodName) . " is not a valid method.");
             }
         }
-        if (!( $out instanceof ViewComponentResponse )) {
-            $nameStr = is_array( $methodName )?implode( ".", $methodName ):$methodName;
-            throw new \Exception( $nameStr . " returned invalid response. Should have been an instance of ViewComponentResponse" );
+        if (!($out instanceof ViewComponentResponse)) {
+            $nameStr = is_array($methodName) ? implode(".", $methodName) : $methodName;
+            throw new \Exception($nameStr . " returned invalid response. Should have been an instance of ViewComponentResponse");
         }
         return $out;
     }
 
-    public function getExecPath( $execMethod )
+    public function getExecPath($execMethod)
     {
         $path = $this->getPath();
-        return ( $path === null?$execMethod:$path . '.' . $execMethod );
+        return ($path === null ? $execMethod : $path . '.' . $execMethod);
     }
 
     /**
@@ -231,7 +231,7 @@ 
     /**
      * @param $string
      */
-    protected function setFlashMessage( $string )
+    protected function setFlashMessage($string)
     {
         $this->flashMessage = $string;
     }
@@ -239,7 +239,7 @@ 
     /**
      * @param $string
      */
-    protected function setFlashError( $string )
+    protected function setFlashError($string)
     {
         $this->flashError = $string;
     }
@@ -281,7 +281,7 @@ 
         if (null === $this->parent) {
             return null;
         }
-        if (null !== ( $pPath = $this->parent->getPath() )) {
+        if (null !== ($pPath = $this->parent->getPath())) {
             return $pPath . '.' . $this->handle;
         }else {
             return $this->handle;
@@ -297,20 +297,20 @@ 
      * @return AbstractViewComponent
      * @throws \Exception
      */
-    protected function addOrUpdateChild( $handle, $type, array $props = [ ] )
+    protected function addOrUpdateChild($handle, $type, array $props = [ ])
     {
-        $this->log( "Adding/updating child '{$handle}' of type {$type}", LogLevel::DEBUG );
-        if (!isset( $this->childComponents[ $handle ] )) {
-            if( ! class_exists( $type ) ){
-                throw new \Exception( "Class '{$type}' for sub-component  does not exist." );
+        $this->log("Adding/updating child '{$handle}' of type {$type}", LogLevel::DEBUG);
+        if (!isset($this->childComponents[ $handle ])) {
+            if (!class_exists($type)) {
+                throw new \Exception("Class '{$type}' for sub-component  does not exist.");
             }
-            $child = new $type( $handle, $this, $this->exec, $this->logger );
+            $child = new $type($handle, $this, $this->exec, $this->logger);
             $this->childComponents[ $handle ] = $child;
         }else {
             // exec, di and logger are set recursively in rehydrate()
             $child = $this->childComponents[ $handle ];
         }
-        $child->updateProps( $props );
+        $child->updateProps($props);
         $child->updateState();
     }
 
@@ -321,12 +321,12 @@ 
      * @return ViewComponentResponse
      * @throws \Exception
      */
-    public function renderChild( $handle )
+    public function renderChild($handle)
     {
         if (!$this->childComponents[ $handle ]) {
             $message = "Attempted to render nonexistent child component with handle '{$handle}'";
-            $this->log( $message, LogLevel::CRITICAL );
-            throw new \Exception( $message );
+            $this->log($message, LogLevel::CRITICAL);
+            throw new \Exception($message);
         }
         return $this->childComponents[ $handle ]->render()->content;
     }
@@ -374,29 +374,29 @@ 
      * @param array $inputs
      * @throws \Exception
      */
-    protected function testInputs( array $inputSpec, array &$inputs )
+    protected function testInputs(array $inputSpec, array &$inputs)
     {
         
         foreach ($inputSpec as $fieldName => $fieldSpec) {
             // Required field
-            if (( count( $fieldSpec ) < 2 )) {
-                if (!isset( $inputs[ $fieldName ] )) {
-                    $calledFunc = debug_backtrace()[1]['function'];
-                    $callerFunc = debug_backtrace()[2]['function'];
-                    $callerClass = debug_backtrace()[2]['class'];
-                    if( $this->parent !== null ){
-                        $parentText = " (parent component is ".get_class($this->parent).")";
+            if ((count($fieldSpec) < 2)) {
+                if (!isset($inputs[ $fieldName ])) {
+                    $calledFunc = debug_backtrace()[ 1 ][ 'function' ];
+                    $callerFunc = debug_backtrace()[ 2 ][ 'function' ];
+                    $callerClass = debug_backtrace()[ 2 ][ 'class' ];
+                    if ($this->parent !== null) {
+                        $parentText = " (parent component is " . get_class($this->parent) . ")";
                     }
-                    throw new \Exception( $fieldName . " is a required field for " . get_class( $this )."::{$calledFunc}() called from {$callerClass}::{$callerFunc}(){$parentText}" );
+                    throw new \Exception($fieldName . " is a required field for " . get_class($this) . "::{$calledFunc}() called from {$callerClass}::{$callerFunc}(){$parentText}");
                 }
             }
             // Set default is unset
-            if (!isset( $inputs[ $fieldName ] )) {
+            if (!isset($inputs[ $fieldName ])) {
                 $inputs[ $fieldName ] = $fieldSpec[ 1 ];
             }
             // Check type
             // Any type allowed, continue
-            if (!isset( $fieldSpec[ 0 ] ) || $fieldSpec[ 0 ] === null) {
+            if (!isset($fieldSpec[ 0 ]) || $fieldSpec[ 0 ] === null) {
                 continue;
             }
             $requiredType = $fieldSpec[ 0 ];
@@ -404,48 +404,48 @@ 
             // Specific type required
             $failed = true;
             // Null is allowed
-            if (!is_null( $input )) {
+            if (!is_null($input)) {
                 switch ($requiredType) {
                     case "boolean":
                     case "bool":
-                    $failed = !is_bool( $input );
+                    $failed = !is_bool($input);
                         break;
                     case "integer":
                     case "int":
-                    $failed = !is_int( $input+0 );
+                    $failed = !is_int($input + 0);
                         break;
                     case "double":
-                        $failed = !is_double( $input+0 );
+                        $failed = !is_double($input + 0);
                         break;
                     case "float":
-                        $failed = !is_float( $input+0 );
+                        $failed = !is_float($input + 0);
                         break;
                     case "string":
-                        $failed = !is_string( $input );
+                        $failed = !is_string($input);
                         break;
                     case "array":
-                        $failed = !is_array( $input );
+                        $failed = !is_array($input);
                         break;
                     case "object":
-                        $failed = !is_object( $input );
+                        $failed = !is_object($input);
                         break;
                     case "resource":
-                        $failed = !is_resource( $input );
+                        $failed = !is_resource($input);
                         break;
                     case "callable":
-                        $failed = !is_callable( $input );
+                        $failed = !is_callable($input);
                         break;
                     default:
-                        $failed = !( $input instanceof $requiredType );
+                        $failed = !($input instanceof $requiredType);
                 }
                 if ($failed) {
-                    $calledFunc = debug_backtrace()[1]['function'];
-                    $callerFunc = debug_backtrace()[2]['function'];
-                    $callerClass = debug_backtrace()[2]['class'];
-                    if( $this->parent !== null ){
-                        $parentText = " (parent component is ".get_class($this->parent).")";
+                    $calledFunc = debug_backtrace()[ 1 ][ 'function' ];
+                    $callerFunc = debug_backtrace()[ 2 ][ 'function' ];
+                    $callerClass = debug_backtrace()[ 2 ][ 'class' ];
+                    if ($this->parent !== null) {
+                        $parentText = " (parent component is " . get_class($this->parent) . ")";
                     }
-                    throw new \Exception( $fieldName . " should be of type " . $requiredType . "in " . get_class( $this )."::{$calledFunc}() called from {$callerClass}::{$callerFunc}(){$parentText}" );
+                    throw new \Exception($fieldName . " should be of type " . $requiredType . "in " . get_class($this) . "::{$calledFunc}() called from {$callerClass}::{$callerFunc}(){$parentText}");
                 }
             }
         }
@@ -456,9 +456,9 @@ 
      *
      * @var array $props
      */
-    public function updateView( $props )
+    public function updateView($props)
     {
-        $this->updateProps( $props );
+        $this->updateProps($props);
         $this->updateState();
     }
 
@@ -467,21 +467,21 @@ 
      *
      * @var array $props
      */
-    protected function updateProps( $props )
+    protected function updateProps($props)
     {
-        $this->log( "Storing new props: " . var_export( $props, true ), LogLevel::DEBUG );
+        $this->log("Storing new props: " . var_export($props, true), LogLevel::DEBUG);
         $this->props = $props;   
     }
 
     /**
      * @param ExecHelper $execHelper
      */
-    private function setExec( ExecHelper $execHelper )
+    private function setExec(ExecHelper $execHelper)
     {
         $this->exec = clone $execHelper;
-        $this->exec->setComponent( $this );
-        foreach( $this->childComponents as $child ){
-            $child->setExec( $execHelper );
+        $this->exec->setComponent($this);
+        foreach ($this->childComponents as $child) {
+            $child->setExec($execHelper);
         }
     }
 
@@ -492,9 +492,9 @@ 
         // it manually and you still get the advantage that the deps
         // are specified in the optional injectDependencies() method's
         // signature
-        $this->log( "Dependency injection...", LogLevel::DEBUG );
-        DependencyInjector::instance()->injectIntoMethod( $this );
-        foreach( $this->childComponents as $child ){
+        $this->log("Dependency injection...", LogLevel::DEBUG);
+        DependencyInjector::instance()->injectIntoMethod($this);
+        foreach ($this->childComponents as $child) {
             $child->handleDependencyInjection();
         }
     }
@@ -502,13 +502,13 @@ 
     /**
      * @param LoggerInterface $logger
      */
-    private function setLogger( LoggerInterface $logger = null )
+    private function setLogger(LoggerInterface $logger = null)
     {
-        if( null !== $logger ){
+        if (null !== $logger) {
             $this->logger = $logger;
             /** @var AbstractViewComponent $child */
-            foreach( $this->childComponents as $child ){
-                $child->setLogger( $logger );
+            foreach ($this->childComponents as $child) {
+                $child->setLogger($logger);
             }
         }
     }

lib/Template/TwigTemplate.php

Doc Comments +2 added lines, -2 removed lines

@@ -69,9 +69,9 @@
     }
 
     /**
-     * @param array|ViewState $state
+     * @param ViewState $state
      * @param array $props
-     * @return string
+     * @return ViewComponentResponse
      */
     protected function doRender( ViewState $state, array $props = [] )
     {

Spacing +13 added lines, -13 removed lines

@@ -57,15 +57,15 @@ 
         $templatePath = null,
         $templateString = null,
         ResourceRepository $repo = null
-    ){
-        parent::__construct( $component );
+    ) {
+        parent::__construct($component);
         $this->templatePath = $templatePath;
         $this->templateString = $templateString;
         // Optional Puli repo
         $this->repo = $repo;
 
         Twig_Autoloader::register();
-        $this->initTwig( $this->getLoader() );
+        $this->initTwig($this->getLoader());
     }
 
     /**
@@ -73,15 +73,15 @@ 
      * @param array $props
      * @return string
      */
-    protected function doRender( ViewState $state, array $props = [] )
+    protected function doRender(ViewState $state, array $props = [ ])
     {
         // If puli plugin is available then add it.
-        if (class_exists( "Puli\\TwigExtension\\PuliExtension" ) && null !== $this->repo) {
-            $this->twig->addExtension( new PuliExtension( $this->repo ) );
+        if (class_exists("Puli\\TwigExtension\\PuliExtension") && null !== $this->repo) {
+            $this->twig->addExtension(new PuliExtension($this->repo));
         }
 
         $rendered = $this->twig->render(
-            $this->templateString?$this->templateString:$this->templatePath,
+            $this->templateString ? $this->templateString : $this->templatePath,
             [
                 'state' => $state,
                 'props' => $props,
@@ -89,7 +89,7 @@ 
                 'parent' => $this->component->getParent(),
                 'exec' => $this->component->exec
             ] );
-        return new ViewComponentResponse( "text/html", $rendered );
+        return new ViewComponentResponse("text/html", $rendered);
     }
 
     /**
@@ -98,8 +98,8 @@ 
     protected function getLoader()
     {
 
-        if (class_exists( "Puli\\TwigExtension\\PuliExtension" ) && null !== $this->repo) {
-            $loader = new \Twig_Loader_Chain( [ new PuliTemplateLoader( $this->repo ), new Twig_Loader_String() ] );
+        if (class_exists("Puli\\TwigExtension\\PuliExtension") && null !== $this->repo) {
+            $loader = new \Twig_Loader_Chain([ new PuliTemplateLoader($this->repo), new Twig_Loader_String() ]);
         }else {
             $loader = new Twig_Loader_String();
         }
@@ -109,13 +109,13 @@ 
     /**
      * @param $loader
      */
-    protected function initTwig( $loader )
+    protected function initTwig($loader)
     {
         $config = [ 'autoescape' => false ];
-        if (defined( "TWIG_CACHE_DIR" )) {
+        if (defined("TWIG_CACHE_DIR")) {
             $config[ 'cache' ] = TWIG_CACHE_DIR;
         }
-        $this->twig = new Twig_Environment( $loader, $config );
+        $this->twig = new Twig_Environment($loader, $config);
     }
 
 }

lib/ViewComponentResponse.php

Doc Comments +2 added lines, -2 removed lines

@@ -26,8 +26,8 @@
     public $content;
 
     /**
-     * @param $mime
-     * @param $content
+     * @param string $mime
+     * @param string $content
      */
     function __construct( $mime, $content )
     {

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
      * @param $mime
      * @param $content
      */
-    function __construct( $mime, $content )
+    function __construct($mime, $content)
     {
         $this->mime = $mime;
         $this->content = $content;

lib/ExecHelper.php

Spacing +12 added lines, -12 removed lines

@@ -18,7 +18,7 @@ 
      */
     protected $component;
 
-    public function setComponent( AbstractViewComponent $component )
+    public function setComponent(AbstractViewComponent $component)
     {
         $this->component = $component;
     }
@@ -30,11 +30,11 @@ 
      * @param bool $onlyComponentOutput
      * @return string A URL or URI
      */
-    public function url( $execMethod, $args = [ ], $onlyComponentOutput = false ) // $onlyComponentOutput Not used in this implementation but necessary for subclasses
+    public function url($execMethod, $args = [ ], $onlyComponentOutput = false) // $onlyComponentOutput Not used in this implementation but necessary for subclasses
     {
         // $onlyComponentOutput is not used in this implementation but may be by sub-classes
-        $args[ 'exec' ] = $this->component->getExecPath( $execMethod );
-        $qs = http_build_query( $args );
+        $args[ 'exec' ] = $this->component->getExecPath($execMethod);
+        $qs = http_build_query($args);
         return "?{$qs}";
     }
 
@@ -66,7 +66,7 @@ 
         }
         return <<<EOS
 <form method="{$method}" action=""{$formID}{$onSubmit}>
-    <input type="hidden" name="exec" value="{$this->component->getExecPath( $execMethod )}">
+    <input type="hidden" name="exec" value="{$this->component->getExecPath($execMethod)}">
     {$formBody}
 </form>
 EOS;
@@ -82,7 +82,7 @@ 
     function callStatic($class, $function, $args = array())
     {
         if (class_exists($class) && method_exists($class, $function)) {
-            return call_user_func_array( array( $class, $function ), $args );
+            return call_user_func_array(array($class, $function), $args);
         }
         return null;
     }
@@ -96,14 +96,14 @@ 
      * @param array $anchorAttrs
      * @return string
      */
-    public function replaceElementUsingLink( $execMethod, $args = [ ], $targetDiv, $linkText, $anchorAttrs = [ ] )
+    public function replaceElementUsingLink($execMethod, $args = [ ], $targetDiv, $linkText, $anchorAttrs = [ ])
     {
-        $url = $this->url( $execMethod, $args, true );
+        $url = $this->url($execMethod, $args, true);
         $attrs = [ ];
         foreach ($anchorAttrs as $k => $v) {
             $attrs[ ] = "{$k}='{$v}'";
         }
-        $attrsStr = implode( ' ', $attrs );
+        $attrsStr = implode(' ', $attrs);
         return <<<EOS
         <script type="application/javascript">
             if( typeof(execLink) != "function" ){
@@ -135,11 +135,11 @@ 
      * @param $formID
      * @return string
      */
-    public function replaceElementUsingForm( $execMethod, $method, $formBody, $targetDiv, $formID )
+    public function replaceElementUsingForm($execMethod, $method, $formBody, $targetDiv, $formID)
     {
         return <<<EOS
-        {$this->wrapForm( $execMethod, $method, $formBody, true, $formID,
-            "execForm( this, \"{$targetDiv}\" ); return false;" )}
+        {$this->wrapForm($execMethod, $method, $formBody, true, $formID,
+            "execForm( this, \"{$targetDiv}\" ); return false;")}
         <script type="application/javascript">
         if( typeof(execForm) != "function" ){
             var execForm = function( form, targetDiv ){

lib/Template/AbstractTemplate.php

Spacing +5 added lines, -5 removed lines

@@ -24,7 +24,7 @@ 
  * Class AbstractTemplate
  * @package PatternSeek\ComponentView
  */
-abstract class AbstractTemplate{
+abstract class AbstractTemplate {
 
     /**
      * @var AbstractViewComponent
@@ -34,7 +34,7 @@ 
     /**
      * @param AbstractViewComponent $component
      */
-    public function __construct( AbstractViewComponent $component ){
+    public function __construct(AbstractViewComponent $component) {
         $this->component = $component;
     }
 
@@ -44,9 +44,9 @@ 
      * @param array $props
      * @return string
      */
-    public function render( ViewState $state, array $props = [] )
+    public function render(ViewState $state, array $props = [ ])
     {
-        return $this->doRender( $state, $props );
+        return $this->doRender($state, $props);
     }
 
     /**
@@ -54,6 +54,6 @@ 
      * @param array $props
      * @return string
      */
-    abstract protected function doRender( ViewState $state, array $props = [] );
+    abstract protected function doRender(ViewState $state, array $props = [ ]);
 
 }