Ariadne-CMS / arc-events

src/events/EventsTree.php

Doc Comments +10 added lines, -4 removed lines

@@ -80,7 +80,7 @@ 
     /**
      *	Returns a new EventStack with the given path.
      *	@param string $path The path to listen or fire an event.
-     *	@return EventStack a new EventStack for the given path.
+     *	@return EventsTree a new EventStack for the given path.
      */
     public function cd($path)
     {
@@ -115,9 +115,6 @@ 
      *	Non-fluent api method to remove a listener.
      *	@param string $eventName The name of the event the listener is registered for.
      *	@param int $id The id of the listener.
-     *	@param string $path Optional. The path the listener is registered on. Default is '/'.
-     *	@param bool $capture Optional. If true the listener is triggered in the capture phase.
-     *		Default is false.
      */
     public function removeListener($eventName, $id, $capture = false)
     {
@@ -127,6 +124,7 @@ 
 
     /**
      *	Calls each listener with the given event untill a listener returns false.
+     * @param Event $event
      */
     private function walkListeners($event)
     {
@@ -140,6 +138,10 @@ 
         };
         $result = \arc\tree::parents(
             $this->tree,
+
+            /**
+             * @param Event $node
+             */
             function ($node, $result) use ($callListeners, $event) {
                 if ($result !== false && isset( $node->nodeValue['capture.'.$event->name] )) {
                     return call_user_func($callListeners, $node->nodeValue['capture.'.$event->name] );
@@ -149,6 +151,10 @@ 
         if (!isset( $result )) {
             $result = \arc\tree::dive(
                 $this->tree,
+
+                /**
+                 * @param Event $node
+                 */
                 function ($node) use ($callListeners, $event) {
                     if (isset( $node->nodeValue['listen.'.$event->name] )) {
                         return call_user_func($callListeners, $node->nodeValue['listen.'.$event->name ] );

src/events/Listener.php

Doc Comments -4 removed lines

@@ -25,10 +25,6 @@
     /**
      *	@param string $eventName The name of the event
      *	@param int $id The id of this listener. This is unique for this eventStack.
-     *	@param string $path Optional. The path listened on, defaults to '/'
-     *	@param bool $capture Optional. True for capture phase listeners, default is false.
-     *	@param Stack $eventStack Optional. The eventStack the listener is registered on. Must be set
-     *		for remove() to work.
      */
     public function __construct($eventName, $id, $capture = false, $eventStack = null)
     {