tidal / PEIP

src/Context/XMLContext.php

Doc Comments +11 added lines, -7 removed lines

@@ -135,7 +135,7 @@ 
      * 
      * @implements \PEIP\INF\Context\Context
      * @access public
-     * @param \PEIP\INF\Context\Context_Plugin $plugin a plugin instance
+     * @param \PEIP\INF\Context\ContextPlugin $plugin a plugin instance
      */
     public function addPlugin(\PEIP\INF\Context\ContextPlugin $plugin){ 
         $plugin->init($this);   
@@ -167,7 +167,6 @@ 
      * </config>     
      * 
      * @access public
-     * @param XMLContext $config the config to include
      */    
     public function includeContext(XMLContext $context){
         $this->services = array_merge($this->services, $context->getServices());
@@ -178,7 +177,7 @@ 
      * 
      * @see XMLContext::includeContext
      * @access public
-     * @param XMLContext $context the config to include
+     * @param string $filePath
      */    
     public function includeContextFromFile($filePath){
         if(file_exists($filePath)){
@@ -357,7 +356,7 @@ 
      * 
      * @access public
      * @param $config 
-     * @return object the initialized service instance
+     * @return \PEIP\INF\Context\ContextPlugin the initialized service instance
      */
     public function createService($config){
         return ServiceFactory::createService($config);      
@@ -685,7 +684,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(
@@ -730,7 +729,8 @@ 
      * 
      * @access protected
      * @param string the configuration type ofthe channel (e.g.: 'reply', 'request')
-     * @param object $config configuration object to return channel from. 
+     * @param object $config configuration object to return channel from.
+     * @param string $type 
      * @return \PEIP\INF\Channel\Channel reply-channel
      */
     public function doGetChannel($type, $config){
@@ -793,7 +793,7 @@ 
      * @see GenericBuilder
      * @static
      * @access protected
-     * @param object $className name of class to build instance for. 
+     * @param string $className name of class to build instance for. 
      * @param array $arguments arguments for the constructor 
      * @return object build and modified srvice instance
      */     
@@ -801,6 +801,10 @@ 
         return GenericBuilder::getInstance($className)->build($arguments);
     }
 
+    /**
+     * @param string $type
+     * @param string $name
+     */
     protected static function hasPublicProperty($service, $type, $name){
         $reflection = GenericBuilder::getInstance(get_class($service))->getReflectionClass();
         if($reflection->{'has'.$type}($name) && $reflection->{'get'.$type}($name)->isPublic()){

src/Dispatcher/ClassDispatcher.php

Doc Comments -1 removed lines

@@ -71,7 +71,6 @@
      * notifies all listeners on a event on a subject
      *
      * @access public
-     * @param string $name name of the event
      * @param mixed $subject the subject
      * @return
      */

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(){

src/Dispatcher/EventClassDispatcher.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
      * @access public
      * @param string $name name of the event
      * @param \PEIP\INF\Event\Event $object an event object
-     * @return boolean
+     * @return boolean|null
      */
     public function notify($name, $object){ 
         if($object instanceof \PEIP\INF\Event\Event){
@@ -53,7 +53,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))){

src/Dispatcher/ObjectEventDispatcher.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
      * @access public
      * @param string $name name of the event 
      * @param \PEIP\INF\Event\Event $object an event object
-     * @return boolean
+     * @return boolean|null
      */
     public function notify($name, $object){
         if($object instanceof \PEIP\INF\Event\Event){

src/Dispatcher/ObjectMapDispatcher.php

Doc Comments +2 added lines, -2 removed lines

@@ -162,7 +162,7 @@ 
      * @access public
      * @param $name 
      * @param $subject 
-     * @return mixed
+     * @return \PEIP\INF\Handler\Handler
      */
     public function notifyUntil($name, $subject){
         if($this->hasListeners($name, $subject)){       
@@ -205,7 +205,7 @@ 
      * @access protected
      * @param $name 
      * @param $object 
-     * @return boolean
+     * @return boolean|null
      */    
     protected static function doNotify(array $listeners, $subject){
         foreach($listeners as $listener){ 

src/Event/Event.php

Doc Comments -1 removed lines

@@ -49,7 +49,6 @@
      * @access public
      * @param mixed $subject the subject for the event
      * @param string $name the name of the event
-     * @param array|ArrayAccess $headers the headers for the event 
      */
     public function __construct($subject, $name, $parameters = array(), $type = false){
         parent::__construct($subject, Test::ensureArrayAccess($parameters));

src/Gateway/SimpleMessagingGateway.php

Doc Comments +1 added lines, -2 removed lines

@@ -55,7 +55,6 @@ 
      * sets the channel to send requests from the gateway
      * 
      * @access public
-     * @param \PEIP\INF\Channel\Channel $replyChannel The default channel to receive requests from the gateway
      * @return 
      */
     public function setRequestChannel(\PEIP\INF\Channel\Channel $requestChannel){
@@ -108,7 +107,7 @@ 
      * sends and receives a request/message through the gateway
      * 
      * @access public
-     * @param mixed $content the content/payload for the message to send 
+     * @param \Order $content the content/payload for the message to send 
      * @return mixed content/payload of the received message
      */
     public function sendAndReceive($content){

src/INF/Channel/Channel.php

Doc Comments +3 added lines, -3 removed lines

@@ -33,10 +33,10 @@
      * Send a message, blocking until either the message is accepted or the
      * specified timeout period elapses.
      * 
-     * @param message the {@link Message} to send
-     * @param timeout the timeout in milliseconds
+     * @param message \PEIP\INF\Message\Message {@link Message} to send
+     * @param timeout integer timeout in milliseconds
      * 
-     * @return <code>true</code> if the message is sent successfully,
+     * @return null|boolean if the message is sent successfully,
      * <code>false</false> if the specified timeout period elapses or
      * the send is interrupted
      */