patternseek / componentview

lib/AbstractViewComponent.php

Spacing +92 added lines, -92 removed lines

@@ -89,7 +89,7 @@ 
         AbstractViewComponent $parent = null,
         ExecHelper $execHelper = null,
         LoggerInterface $logger = null
-    ){
+    ) {
         // Null means we are root
         $this->parent = $parent;
 
@@ -99,11 +99,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();
@@ -113,11 +113,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);
         }
     }
 
@@ -125,9 +125,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);
     }
 
     /**
@@ -138,13 +138,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;
     }
 
@@ -168,7 +168,7 @@ 
      * @throws \Exception
      * @return Response
      */
-    public function render( $execMethodName = null, array $execArgs = null )
+    public function render($execMethodName = null, array $execArgs = null)
     {
         $this->state->validate();
 
@@ -183,13 +183,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 Response )) {
-                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 Response)) {
+                throw new \Exception(get_class($this->template) . " returned invalid response. Should have been an instance of ViewComponentResponse");
             }
         }
         return $out;
@@ -203,26 +203,26 @@ 
      * @throws \Exception
      * @return Response
      */
-    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 Response )) {
-            $nameStr = is_array( $methodName )?implode( ".", $methodName ):$methodName;
-            throw new \Exception( $nameStr . " returned invalid response. Should have been an instance of ViewComponentResponse" );
+        if (!($out instanceof Response)) {
+            $nameStr = is_array($methodName) ? implode(".", $methodName) : $methodName;
+            throw new \Exception($nameStr . " returned invalid response. Should have been an instance of ViewComponentResponse");
         }
         return $out;
     }
@@ -231,10 +231,10 @@ 
      * @param $execMethod
      * @return string
      */
-    public function getExecPath( $execMethod )
+    public function getExecPath($execMethod)
     {
         $path = $this->getPath();
-        return ( $path === null?$execMethod:$path . '.' . $execMethod );
+        return ($path === null ? $execMethod : $path . '.' . $execMethod);
     }
 
     /**
@@ -249,7 +249,7 @@ 
     /**
      * @param $string
      */
-    protected function setFlashMessage( $string )
+    protected function setFlashMessage($string)
     {
         $this->flashMessage = $string;
     }
@@ -257,7 +257,7 @@ 
     /**
      * @param $string
      */
-    protected function setFlashError( $string )
+    protected function setFlashError($string)
     {
         $this->flashError = $string;
     }
@@ -299,7 +299,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;
@@ -315,20 +315,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();
     }
 
@@ -339,12 +339,12 @@ 
      * @return Response
      * @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;
     }
@@ -392,79 +392,79 @@ 
      * @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 ((count($fieldSpec) < 2)) {
+                if (!isset($inputs[ $fieldName ])) {
+                    $calledFunc = debug_backtrace()[ 1 ][ 'function' ];
+                    $callerFunc = debug_backtrace()[ 2 ][ 'function' ];
+                    $callerClass = debug_backtrace()[ 2 ][ 'class' ];
                     $parentText = '';
-                    if( $this->parent !== null ){
-                        $parentText = " (parent component is ".get_class($this->parent).")";
+                    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 ];
             $input = $inputs[ $fieldName ];
             // Specific type required
             // 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'];
+                    $calledFunc = debug_backtrace()[ 1 ][ 'function' ];
+                    $callerFunc = debug_backtrace()[ 2 ][ 'function' ];
+                    $callerClass = debug_backtrace()[ 2 ][ 'class' ];
                     $parentText = '';
-                    if( $this->parent !== null ){
-                        $parentText = " (parent component is ".get_class($this->parent).")";
+                    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}");
                 }
             }
         }
@@ -475,9 +475,9 @@ 
      *
      * @var array $props
      */
-    public function updateView( $props )
+    public function updateView($props)
     {
-        $this->updateProps( $props );
+        $this->updateProps($props);
         $this->updateState();
     }
 
@@ -486,13 +486,13 @@ 
      *
      * @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;   
     }
 
-    protected function forceResponse( Response $response )
+    protected function forceResponse(Response $response)
     {
         $this->forceResponse = $response;
     }
@@ -500,12 +500,12 @@ 
     /**
      * @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);
         }
     }
 
@@ -519,9 +519,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();
         }
     }
@@ -529,13 +529,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);
             }
         }
     }