tidal / PEIP

src/Factory/DedicatedFactory.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
         return new DedicatedFactory(array($class, '__construct'), $parameters); 

     } 

 

+    /**
+     * @param string[] $callable
+     */
     public static function getfromCallable($callable, array $parameters = array()){

         return new DedicatedFactory($callable, $parameters); 

     } 

src/Service/ServiceProvider.php

Doc Comments +3 added lines

@@ -112,6 +112,9 @@
         );

     }

 

+    /**
+     * @param string $key
+     */
     public function provideService($key){

         $this->doFireEvent(self::EVENT_BEFORE_PROVIDE_SERVICE, array(

             self::HEADER_KEY=>$key)

Spacing +4 added lines, -4 removed lines

@@ -69,7 +69,7 @@ 
          * @param string $nodeName the name of the node
          * @param callable $callable a callable which creates instances for node-name
          */
-    public function registerNodeBuilder($nodeName, $callable){
+    public function registerNodeBuilder($nodeName, $callable) {
         $this->nodeBuilders[$nodeName] = $callable;
     }
     /**
@@ -82,16 +82,16 @@ 
      * @see XMLContext::includeContext
      * @access protected
      */
-    protected function initNodeBuilders(){
+    protected function initNodeBuilders() {
         $builders = array(
             'service' => 'initService'
         );
-        foreach($builders as $nodeName => $method){
+        foreach ($builders as $nodeName => $method) {
             $this->registerNodeBuilder($nodeName, array($this, $method));
         }
     }
 
-    public function addConfig($config){ 
+    public function addConfig($config) { 
         $this->doFireEvent(
             self::EVENT_BEFORE_ADD_CONFIG,
             array(

Braces +5 added lines, -5 removed lines

@@ -117,7 +117,7 @@ 
 
         if ($this->hasService($key)) {
             $service = $this->getService($key);
-        }else {
+        } else {
             $service = $this->createService($key);
         }
 
@@ -149,11 +149,11 @@ 
                 ));
 
                 return $node;                
-            }else {
+            } else {
                 $errorMessage = 'COULD NOT BUILD NODE FOR KEY: '.$key;
             }
 
-        }else {
+        } else {
             $errorMessage = 'NO CONFIG FOR KEY: '.$key;
         }
         $this->doFireEvent(self::EVENT_CREATE_SERVICE_ERROR, array(
@@ -197,10 +197,10 @@ 
                     self::HEADER_NODE => $nodeInstance
                 ));
                 return $nodeInstance;
-            }else {
+            } else {
                 $errorMessage = 'BUILDER RETURNED NO OBJECT FOR NODE-TYPE: '.$nodeName;
             }
-        }else {
+        } else {
             $errorMessage = 'NO BUILDER FOUND FOR NODE-TYPE: '.$nodeName;
         }
 

src/Dispatcher/ClassEventDispatcher.php

Braces +2 added lines, -2 removed lines

@@ -70,10 +70,10 @@
                      ),

                      $object

                  );

-            }else{

+            } else{

                 throw new \InvalidArgumentException('instance of \PEIP\INF\Event\Event must contain subject');

             }

-        }else{

+        } else{

             throw new \InvalidArgumentException('object must be instance of \PEIP\INF\Event\Event');

         }

     }       //put your code here

Doc Comments +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
          * @param array $headers headers of the event-object as key/value pairs

          * @param string $eventClass event-class to create instances from

          * @return

-         * @see EventBuilder

+         boolean|null @see EventBuilder

          */

     public function buildAndNotify($name, $object, array $headers = array(), $eventClass = false, $type = false){

         if(!$this->hasListeners($name, ($object))){

Spacing +9 added lines, -9 removed lines

@@ -26,9 +26,9 @@ 
      * @param Callable|PEIP\INF\Handler\Handler $listener event-handler

      * @return boolean

      */

-    public function connect($name, $object, $listener){ 

+    public function connect($name, $object, $listener) { 

         $class = is_object($object) ? get_class($object) : (string)$object;

-        foreach(Reflection::getImplementedClassesAndInterfaces($object) as $cls){

+        foreach (Reflection::getImplementedClassesAndInterfaces($object) as $cls) {

             $reflection = \PEIP\Util\ReflectionPool::getInstance($class);

             parent::connect($name, $reflection, $listener);

         }

@@ -36,13 +36,13 @@ 
         return true;

     }

 

-    public function disconnect($name, $object, $listener){

+    public function disconnect($name, $object, $listener) {

         $class = is_object($object) ? get_class($object) : (string)$object;

         $res = true;

-        foreach(Reflection::getImplementedClassesAndInterfaces($object) as $cls){

+        foreach (Reflection::getImplementedClassesAndInterfaces($object) as $cls) {

             $reflection = \PEIP\Util\ReflectionPool::getInstance($class);

             $r = parent::disconnect($name, $reflection, $listener);

-            if(!$r){

+            if (!$r) {

                 $res = false;

             }

         }

@@ -69,10 +69,10 @@ 
                         ),

                         $object

                     );

-            }else{

+            }else {

                 throw new \InvalidArgumentException('instance of \PEIP\INF\Event\Event must contain subject');

             }

-        }else{

+        }else {

             throw new \InvalidArgumentException('object must be instance of \PEIP\INF\Event\Event');

         }

     }       //put your code here

@@ -89,8 +89,8 @@ 
          * @return

          * @see EventBuilder

          */

-    public function buildAndNotify($name, $object, array $headers = array(), $eventClass = false, $type = false){

-        if(!$this->hasListeners($name, ($object))){

+    public function buildAndNotify($name, $object, array $headers = array(), $eventClass = false, $type = false) {

+        if (!$this->hasListeners($name, ($object))) {

             return false;

         }

 

examples/Cafe/example.php

Indentation +10 added lines, -10 removed lines

@@ -46,19 +46,19 @@
 

 if($cafe){

 

-	for ($i = 1; $i <= 10; $i++) {

-       	// create and place orders

-		$order = new Order();

-        	$order->addItem("LATTE", 2, false);

-        	$order->addItem("MOCCA", 3, true);

-        	$cafe->placeOrder($order);

-        	// receive drinks

-		$drinks = $cafe->receiveDelivery();

+    for ($i = 1; $i <= 10; $i++) {

+            // create and place orders

+        $order = new Order();

+            $order->addItem("LATTE", 2, false);

+            $order->addItem("MOCCA", 3, true);

+            $cafe->placeOrder($order);

+            // receive drinks

+        $drinks = $cafe->receiveDelivery();

                 var_dump($drinks);

-    	}	

+        }	

 

 }else{

-	throw new RuntimeException('Could not get CafeGateway');

+    throw new RuntimeException('Could not get CafeGateway');

 }

 

 

Braces +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
                 

     	}	

 

-}else {

+} else {

 	throw new RuntimeException('Could not get CafeGateway');

 }

 

examples/Cafe/lib/messaging/DrinkRouter.php

Indentation +7 added lines, -7 removed lines

@@ -4,14 +4,14 @@
 use PEIP\INF\Message\Message;

 

 class DrinkRouter 

-	extends Router {

+    extends Router {

 	

-	protected function selectChannels(Message $message){

-		$order = $message->getContent();

-		$channelName = $order['iced']  ? 'coldDrinks' : 'hotDrinks';

-		echo PEIP_LINE_SEPARATOR."DrinkRouter: routed to channel: $channelName";

-		return $channelName;

-	}	

+    protected function selectChannels(Message $message){

+        $order = $message->getContent();

+        $channelName = $order['iced']  ? 'coldDrinks' : 'hotDrinks';

+        echo PEIP_LINE_SEPARATOR."DrinkRouter: routed to channel: $channelName";

+        return $channelName;

+    }	

 

 	

 }

Spacing +2 added lines, -2 removed lines

@@ -6,9 +6,9 @@
 class DrinkRouter 

 	extends Router {

 	

-	protected function selectChannels(Message $message){

+	protected function selectChannels(Message $message) {

 		$order = $message->getContent();

-		$channelName = $order['iced']  ? 'coldDrinks' : 'hotDrinks';

+		$channelName = $order['iced'] ? 'coldDrinks' : 'hotDrinks';

 		echo PEIP_LINE_SEPARATOR."DrinkRouter: routed to channel: $channelName";

 		return $channelName;

 	}	

src/Factory/ServiceFactory.php

Indentation +23 added lines, -23 removed lines

@@ -16,13 +16,13 @@ 
 use PEIP\Context\XMLContext;

 

 class ServiceFactory {

-     /**

-     * Creates and initializes service instance from a given configuration.

-     *

-     * @access public

-     * @param $config configuration of the service

-     * @return object the initialized service instance

-     */

+        /**

+         * Creates and initializes service instance from a given configuration.

+         *

+         * @access public

+         * @param $config configuration of the service

+         * @return object the initialized service instance

+         */

     public static function createService(array $config){

         $args = array();

         //build arguments for constructor

@@ -35,15 +35,15 @@ 
     }

 

         /**

-     * Builds an arbitrary service/object instance from a config-obect.

-     *

-     * @static

-     * @access protected

-     * @param object $config configuration object to build a service instance from.

-     * @param array $arguments arguments for the service constructor

-     * @param string $defaultClass class to create instance for if none is set in config

-     * @return object build and modified srvice instance

-     */

+         * Builds an arbitrary service/object instance from a config-obect.

+         *

+         * @static

+         * @access protected

+         * @param object $config configuration object to build a service instance from.

+         * @param array $arguments arguments for the service constructor

+         * @param string $defaultClass class to create instance for if none is set in config

+         * @return object build and modified srvice instance

+         */

     public static function doBuild($config, $arguments, $defaultClass = false){

         $cls = isset($config["class"]) ? trim((string)$config["class"]) : (string)$defaultClass;

         if($cls != ''){

@@ -80,12 +80,12 @@ 
     }

 

         /**

-     * Builds single argument (to call a method with later) from a config-obect.

-     *

-     * @access protected

-     * @param object $config configuration object to create argument from.

-     * @return mixed build argument

-     */

+         * Builds single argument (to call a method with later) from a config-obect.

+         *

+         * @access protected

+         * @param object $config configuration object to create argument from.

+         * @return mixed build argument

+         */

     protected function buildArg($config){

         if(trim((string)$config['value']) != ''){

             $arg = (string)$config['value'];

@@ -128,7 +128,7 @@ 
      */

     public static function buildAndModify(array $config, $arguments, $defaultClass = ""){

         if((isset($config["class"]) && "" != (string)$config["class"])  || $defaultClass !== ""){

-             $service = ServiceFactory::doBuild($config, $arguments, $defaultClass);

+                $service = ServiceFactory::doBuild($config, $arguments, $defaultClass);

         }else{

             throw new \RuntimeException('Could not create Service. no class or reference given.');

         }

Braces +3 added lines, -3 removed lines

@@ -51,7 +51,7 @@ 
                 $constructor = isset($config["constructor"]) ? (string)$config["constructor"] : "";

                 if ($constructor != '' && Test::assertMethod($cls, $constructor)) {

                     $service = call_user_func_array(array($cls, $constructor), $arguments);

-                }else {

+                } else {

                     $service = self::build($cls, $arguments);

                 }

             } catch (\Exception $e) {

@@ -97,7 +97,7 @@ 
                 if ($entry->getName() == 'value') {

                     if ($entry['key']) {

                         $arg[(string)$entry['key']] = (string)$entry;

-                    }else {

+                    } else {

                         $arg[] = (string)$entry;

                     }

                 } elseif ($entry->getName() == 'service') {

@@ -129,7 +129,7 @@ 
     public static function buildAndModify(array $config, $arguments, $defaultClass = "") {

         if ((isset($config["class"]) && "" != (string)$config["class"]) || $defaultClass !== "") {

              $service = ServiceFactory::doBuild($config, $arguments, $defaultClass);

-        }else {

+        } else {

             throw new \RuntimeException('Could not create Service. no class or reference given.');

         }

         if (isset($config["ref_property"])) {

src/Dispatcher/Dispatcher.php

Doc Comments -1 removed lines

@@ -65,7 +65,6 @@
      * Disconnects all listeners.
      * 
      * @access public
-     * @param Callable|PEIP\INF\Handler\Handler $listener
      * @return void
      */
     public function disconnectAll(){

Spacing +12 added lines, -12 removed lines

@@ -40,7 +40,7 @@ 
      * @param Callable|PEIP\INF\Handler\Handler  $listener
      * @return void
      */
-    public function connect($listener){
+    public function connect($listener) {
         Test::ensureHandler($listener);
         $this->listeners[] = $listener;
     }
@@ -52,10 +52,10 @@ 
      * @param Callable|PEIP\INF\Handler\Handler $listener
      * @return void
      */
-    public function disconnect($listener){
+    public function disconnect($listener) {
         Test::ensureHandler($listener);
-        foreach ($this->listeners as $i => $callable){
-            if ($listener === $callable){
+        foreach ($this->listeners as $i => $callable) {
+            if ($listener === $callable) {
                 unset($this->listeners[$i]);
             }
         }
@@ -68,7 +68,7 @@ 
      * @param Callable|PEIP\INF\Handler\Handler $listener
      * @return void
      */
-    public function disconnectAll(){
+    public function disconnectAll() {
         $this->listeners = array();
     }
 
@@ -78,8 +78,8 @@ 
      * @access public
      * @return boolean wether any listeners are registered
      */
-    public function hasListeners(){
-        return (boolean) count($this->listeners);
+    public function hasListeners() {
+        return (boolean)count($this->listeners);
     }
     
     /**
@@ -89,9 +89,9 @@ 
      * @param mixed $subject the subject
      * @return void
      */
-    public function notify($subject){
+    public function notify($subject) {
         $res = NULL;
-        if($this->hasListeners()){
+        if ($this->hasListeners()) {
             $res = self::doNotify($this->getListeners(), $subject); 
         }   
         return $res;      
@@ -104,8 +104,8 @@ 
      * @param mixed $subject the subject 
      * @return \PEIP\INF\Handler\Handler the listener which returned a boolean true value
      */
-    public function notifyUntil($subject){
-        if($this->hasListeners()){
+    public function notifyUntil($subject) {
+        if ($this->hasListeners()) {
             $res = self::doNotifyUntil($this->getListeners(), $subject);    
         }
         return $res;
@@ -117,7 +117,7 @@ 
      * @access public
      * @return array the listeners
      */
-    public function getListeners(){
+    public function getListeners() {
         return $this->listeners;
     }
 

src/Plugins/BasePlugin.php

Doc Comments +2 added lines, -1 removed lines

@@ -213,7 +213,7 @@ 
      *
      * @access protected
      * @param object $config configuration object to create arguments from.
-     * @return mixed build arguments
+     * @return \PEIP\INF\Channel\Channel[] build arguments
      */
     protected function getReplyHandlerArguments($config){
         $args = array(
@@ -259,6 +259,7 @@ 
      * @access protected
      * @param string the configuration type ofthe channel (e.g.: 'reply', 'request')
      * @param object $config configuration object to return channel from.
+     * @param string $type
      * @return \PEIP\INF\Channel\Channel reply-channel
      */
     public function doGetChannel($type, $config){

Spacing +19 added lines, -19 removed lines

@@ -42,7 +42,7 @@ 
      * @param object $config configuration object for the pollable channel.
      * @return \PEIP\INF\Channel\Channel the created pollable channel instance
      */
-    public function createChannel($config){
+    public function createChannel($config) {
         return $this->doCreateChannel($config, '\PEIP\Channel\PollableChannel');
     }
 
@@ -54,7 +54,7 @@ 
      * @param object $config configuration object for the subscribable channel.
      * @return \PEIP\INF\Channel\Channel the created subscribable channel instance
      */
-    public function createSubscribableChannel($config){
+    public function createSubscribableChannel($config) {
         return $this->doCreateChannel($config, '\PEIP\Channel\PublishSubscribeChannel');
     }
 
@@ -67,9 +67,9 @@ 
      * @param $additionalArguments additional arguments for the channel constructor (without first arg = id)
      * @return \PEIP\INF\Channel\Channel the created channel instance
      */
-    public function doCreateChannel($config, $defaultChannelClass, array $additionalArguments = array()){
+    public function doCreateChannel($config, $defaultChannelClass, array $additionalArguments = array()) {
         $id = (string)$config['id'];
-        if($id != ''){
+        if ($id != '') {
             array_unshift($additionalArguments, $id);
             $channel = $this->buildAndModify($config, $additionalArguments, $defaultChannelClass);
             //$this->channelRegistry->register($channel);
@@ -87,7 +87,7 @@ 
      * @param string $defaultClass the class to use if none is set in config.
      * @return object the gateway instance
      */
-    public function createGateway($config, $defaultClass = false){
+    public function createGateway($config, $defaultClass = false) {
         $args = array(
             $this->getRequestChannel($config),
             $this->getReplyChannel($config)
@@ -111,7 +111,7 @@ 
      * @param string $defaultClass the class to use if none is set in config.
      * @return object the router instance
      */
-    public function createRouter($config, $defaultClass = false){
+    public function createRouter($config, $defaultClass = false) {
         $resolver = $config['channel_resolver'] ? (string)$config['channel_resolver'] : $this->channelRegistry;
         return $this->buildAndModify($config, array(
             $resolver,
@@ -128,7 +128,7 @@ 
      * @param object $config configuration object for the splitter.
      * @return object the splitter instance
      */
-    public function createSplitter($config){
+    public function createSplitter($config) {
         return $this->createReplyMessageHandler($config);
     }
 
@@ -141,7 +141,7 @@ 
      * @param object $config configuration object for the transformer.
      * @return object the transformer instance
      */
-    public function createTransformer($config){
+    public function createTransformer($config) {
         return $this->createReplyMessageHandler($config);
     }
 
@@ -154,7 +154,7 @@ 
      * @param object $config configuration object for the aggregator.
      * @return object the aggregator instance
      */
-    public function createAggregator($config){
+    public function createAggregator($config) {
         return $this->createReplyMessageHandler($config);
     }
 
@@ -167,7 +167,7 @@ 
      * @param object $config configuration object for the wiretap.
      * @return object the wiretap instance
      */
-    public function createWiretap($config){
+    public function createWiretap($config) {
         return $this->createReplyMessageHandler($config, '\PEIP\Listener\Wiretap');
     }
 
@@ -180,7 +180,7 @@ 
      * @param string $defaultClass the class to use if none is set in config.
      * @return object the reply-message-handler instance
      */
-    public function createReplyMessageHandler($config, $defaultClass = false){
+    public function createReplyMessageHandler($config, $defaultClass = false) {
         return $this->buildAndModify($config, $this->getReplyHandlerArguments($config), $defaultClass);
     }
 
@@ -193,12 +193,12 @@ 
      * @param string $defaultClass the class to use if none is set in config.
      * @return object the service-activator instance
      */
-    public function createServiceActivator($config, $defaultClass = false){
+    public function createServiceActivator($config, $defaultClass = false) {
         $method = (string)$config['method'];
         $service = $this->context->getServiceProvider()->provideService((string)$config['ref']);
-        if($method && $service){
+        if ($method && $service) {
             $args = $this->getReplyHandlerArguments($config);
-            array_unshift($args,array(
+            array_unshift($args, array(
                 $service,
                 $method
             ));
@@ -215,12 +215,12 @@ 
      * @param object $config configuration object to create arguments from.
      * @return mixed build arguments
      */
-    protected function getReplyHandlerArguments($config){
+    protected function getReplyHandlerArguments($config) {
         $args = array(
             $this->doGetChannel('input', $config),
             $this->doGetChannel('output', $config)
         );
-        if($args[0] == NULL){
+        if ($args[0] == NULL) {
             throw new \RuntimeException('Could not receive input channel.');
         }
         return $args;
@@ -235,7 +235,7 @@ 
      * @param object $config configuration object to return request-channel from.
      * @return \PEIP\INF\Channel\Channel request-channel
      */
-    protected function getRequestChannel($config){
+    protected function getRequestChannel($config) {
         return $this->doGetChannel('request', $config);
     }
 
@@ -248,7 +248,7 @@ 
      * @param object $config configuration object to return reply-channel from.
      * @return \PEIP\INF\Channel\Channel reply-channel
      */
-    protected function getReplyChannel($config){
+    protected function getReplyChannel($config) {
         return $this->doGetChannel('reply', $config);
     }
 
@@ -261,7 +261,7 @@ 
      * @param object $config configuration object to return channel from.
      * @return \PEIP\INF\Channel\Channel reply-channel
      */
-    public function doGetChannel($type, $config){
+    public function doGetChannel($type, $config) {
         $channelName = isset($config[$type."_channel"])
             ? $config[$type."_channel"]
             : $config["default_".$type."_channel"];

src/Data/Store.php

Spacing +7 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
      * @param mixed $value the value to store
      * @return 
      */
-    public function setValue($key, $value){
+    public function setValue($key, $value) {
         return $this->offsetSet($key, $value);
     }
     
@@ -45,7 +45,7 @@ 
      * @param mixed $key the key to return value for 
      * @return mixed the value for the given key
      */
-    public function getValue($key){
+    public function getValue($key) {
         return $this->offsetGet($key, $value);
     }
   
@@ -56,7 +56,7 @@ 
      * @param mixed $key the key to unset value for 
      * @return 
      */
-    public function deleteValue($key){
+    public function deleteValue($key) {
         return $this->offsetUnset($key);
     }
       
@@ -67,7 +67,7 @@ 
      * @param mixed $key the key to look for a value
      * @return boolean wether a value is stored for the key
      */
-    public function hasValue($key){
+    public function hasValue($key) {
         return $this->offsetExists($key);
     }   
 
@@ -78,7 +78,7 @@ 
      * @param array $values key/value pairs to store
      * @return 
      */
-    public function setValues(array $values){
+    public function setValues(array $values) {
         $this->values = $values;        
     }
 
@@ -88,7 +88,7 @@ 
      * @access public
      * @return array stored key/value pairs
      */
-    public function getValues(){
+    public function getValues() {
         return $this->values;
     }
    
@@ -100,7 +100,7 @@ 
      * @param $values 
      * @return 
      */
-    public function addValues(array $values){
+    public function addValues(array $values) {
         array_merge($this->values, $values);
     }   
 }
\ No newline at end of file