Namespaces
	Loop

	Promise

Data Structures
class	ContinueCallbackTest

class	CoroutineTest

class	EventEmitter
	EventEmitter object. More...

interface	EventEmitterInterface
	Event Emitter Interface. More...

class	EventEmitterTest

class	Promise
	An implementation of the Promise pattern. More...

class	PromiseAlreadyResolvedException
	This exception is thrown when the user tried to reject or fulfill a promise, after either of these actions were already performed. More...

class	PromiseTest

class	Version
	This class contains the version number for this package. More...

Functions
	coroutine (callable $gen)
	Turn asynchronous promise-based code into something that looks synchronous again, through the use of generators. More...

	on ($eventName, callable $callBack, $priority=100)
	Subscribe to an event. More...

	once ($eventName, callable $callBack, $priority=100)
	Subscribe to an event exactly once. More...

	emit ($eventName, array $arguments=[], callable $continueCallBack=null)
	Emits an event. More...

	listeners ($eventName)
	Returns the list of listeners for an event. More...

	removeListener ($eventName, callable $listener)
	Removes a specific listener from an event. More...

	removeAllListeners ($eventName=null)
	Removes all listeners. More...

Variables
trait	EventEmitterTrait
	Event Emitter Trait. More...

Function Documentation

◆ coroutine()

Sabre\Event\coroutine ( callable $gen )

Turn asynchronous promise-based code into something that looks synchronous again, through the use of generators.

Example without coroutines:

$promise = $httpClient->request('GET', '/foo'); $promise->then(function($value) {

return $httpClient->request('DELETE','/foo');

})->then(function($value) {

return $httpClient->request('PUT', '/foo');

})->error(function($reason) {

echo "Failed because: $reason\n";

});

Example with coroutines:

coroutine(function() {

try { yield $httpClient->request('GET', '/foo'); yield $httpClient->request('DELETE', /foo'); yield $httpClient->request('PUT', '/foo'); } catch( $reason) { echo "Failed because: $reason\n"; }

});

Copyright: Copyright (C) 2013-2015 fruux GmbH. All rights reserved.

Author: Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

So tempted to use the mythical y-combinator here, but it's not needed in PHP.

Definition at line 47 of file coroutine.php.

References $promise, $type, and Sabre\Event\Promise\PENDING.

                                   {
 
     $generator = $gen();
     if (!$generator instanceof Generator) {
         throw new \InvalidArgumentException('You must pass a generator function');
     }
 
     // This is the value we're returning.
     $promise = new Promise();
 
     $lastYieldResult = null;
 
     $advanceGenerator = function() use (&$advanceGenerator, $generator, $promise, &$lastYieldResult) {
 
         while ($generator->valid()) {
 
             $yieldedValue = $generator->current();
             if ($yieldedValue instanceof Promise) {
                 $yieldedValue->then(
                     function($value) use ($generator, &$advanceGenerator, &$lastYieldResult) {
                         $lastYieldResult = $value;
                         $generator->send($value);
                         $advanceGenerator();
                     },
                     function($reason) use ($generator, $advanceGenerator) {
                         if ($reason instanceof Exception) {
                             $generator->throw($reason);
                         } elseif (is_scalar($reason)) {
                             $generator->throw(new Exception($reason));
                         } else {
                             $type = is_object($reason) ? get_class($reason) : gettype($reason);
                             $generator->throw(new Exception('Promise was rejected with reason of type: ' . $type));
                         }
                         $advanceGenerator();
                     }
                 )->error(function($reason) use ($promise) {
                     // This error handler would be called, if something in the
                     // generator throws an exception, and it's not caught
                     // locally.
                     $promise->reject($reason);
                 });
                 // We need to break out of the loop, because $advanceGenerator
                 // will be called asynchronously when the promise has a result.
                 break;
             } else {
                 // If the value was not a promise, we'll just let it pass through.
                 $lastYieldResult = $yieldedValue;
                 $generator->send($yieldedValue);
             }
 
         }
 
         // If the generator is at the end, and we didn't run into an exception,
         // we can fullfill the promise with the last thing that was yielded to
         // us.
         if (!$generator->valid() && $promise->state === Promise::PENDING) {
             $promise->fulfill($lastYieldResult);
         }
 
     };
 
     try {
         $advanceGenerator();
     } catch (Exception $e) {
         $promise->reject($e);
     }
 
     return $promise;
 
 }

Here is the caller graph for this function:

◆ emit()

Sabre\Event\emit	(		$eventName,
		array	$arguments = `[]`,
		callable	$continueCallBack = `null`
	)

Emits an event.

This method will return true if 0 or more listeners were succesfully handled. false is returned if one of the events broke the event chain.

If the continueCallBack is specified, this callback will be called every time before the next event handler is called.

If the continueCallback returns false, event propagation stops. This allows you to use the eventEmitter as a means for listeners to implement functionality in your application, and break the event loop as soon as some condition is fulfilled.

Note that returning false from an event subscriber breaks propagation and returns false, but if the continue-callback stops propagation, this is still considered a 'successful' operation and returns true.

Lastly, if there are 5 event handlers for an event. The continueCallback will be called at most 4 times.

Parameters

string	$eventName
array	$arguments
callback	$continueCallBack

Returns: bool

Definition at line 99 of file EventEmitterTrait.php.

References $result, and Sabre\Event\listeners().

Referenced by Sabre\HTTP\ClientMock\curlExec(), Sabre\HTTP\ClientMock\curlStuff(), and Sabre\HTTP\ClientMock\doRequest().

                                                                                         {
 
         if (is_null($continueCallBack)) {
 
             foreach ($this->listeners($eventName) as $listener) {
 
                 $result = call_user_func_array($listener, $arguments);
                 if ($result === false) {
                     return false;
                 }
             }
 
         } else {
 
             $listeners = $this->listeners($eventName);
             $counter = count($listeners);
 
             foreach ($listeners as $listener) {
 
                 $counter--;
                 $result = call_user_func_array($listener, $arguments);
                 if ($result === false) {
                     return false;
                 }
 
                 if ($counter > 0) {
                     if (!$continueCallBack()) break;
                 }
 
             }
 
         }
 
         return true;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listeners()

Sabre\Event\listeners ( $eventName )

Returns the list of listeners for an event.

The list is returned as an array, and the list of events are sorted by their priority.

Parameters

string $eventName

Returns: callable[]

Definition at line 145 of file EventEmitterTrait.php.

Referenced by Sabre\Event\emit(), Sabre\Event\on(), Sabre\Event\removeAllListeners(), and Sabre\Event\removeListener().

                                    {
 
         if (!isset($this->listeners[$eventName])) {
             return [];
         }
 
         // The list is not sorted
         if (!$this->listeners[$eventName][0]) {
 
             // Sorting
             array_multisort($this->listeners[$eventName][1], SORT_NUMERIC, $this->listeners[$eventName][2]);
 
             // Marking the listeners as sorted
             $this->listeners[$eventName][0] = true;
         }
 
         return $this->listeners[$eventName][2];
 
     }

Here is the caller graph for this function:

◆ on()

Sabre\Event\on	(		$eventName,
		callable	$callBack,
			$priority = `100`
	)

Subscribe to an event.

Parameters

string	$eventName
callable	$callBack
int	$priority

Returns: void

Definition at line 35 of file EventEmitterTrait.php.

References Sabre\Event\listeners().

Referenced by ilExternalFeed\_getRSSLocation(), LightboxMockPage\getComponent(), LightboxTest\getExpectedImagePageHTML(), LightboxTest\getExpectedMixedPagesHTML(), Sabre\Event\once(), LSControlBuilder\setListenerJS(), showHelp(), ilWACTokenTest\testCookieGeneration(), and Sabre\VObject\Parser\XmlTest\testRFC6321Example2().

                                                                  {
 
         if (!isset($this->listeners[$eventName])) {
             $this->listeners[$eventName] = [
                 true,  // If there's only one item, it's sorted
                 [$priority],
                 [$callBack]
             ];
         } else {
             $this->listeners[$eventName][0] = false; // marked as unsorted
             $this->listeners[$eventName][1][] = $priority;
             $this->listeners[$eventName][2][] = $callBack;
         }
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ once()

Sabre\Event\once	(		$eventName,
		callable	$callBack,
			$priority = `100`
	)

Subscribe to an event exactly once.

Parameters

string	$eventName
callable	$callBack
int	$priority

Returns: void

Definition at line 59 of file EventEmitterTrait.php.

References Sabre\Event\on(), and Sabre\Event\removeListener().

                                                                    {
 
         $wrapper = null;
         $wrapper = function() use ($eventName, $callBack, &$wrapper) {
 
             $this->removeListener($eventName, $wrapper);
             return call_user_func_array($callBack, func_get_args());
 
         };
 
         $this->on($eventName, $wrapper, $priority);
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAllListeners()

Sabre\Event\removeAllListeners ( $eventName = null )

Removes all listeners.

If the eventName argument is specified, all listeners for that event are removed. If it is not specified, every listener for every event is removed.

Parameters

string $eventName

Returns: void

Definition at line 201 of file EventEmitterTrait.php.

References Sabre\Event\listeners().

                                                    {
 
         if (!is_null($eventName)) {
             unset($this->listeners[$eventName]);
         } else {
             $this->listeners = [];
         }
 
     }

Here is the call graph for this function:

◆ removeListener()

Sabre\Event\removeListener	(		$eventName,
		callable	$listener
	)

Removes a specific listener from an event.

If the listener could not be found, this method will return false. If it was removed it will return true.

Parameters

string	$eventName
callable	$listener

Returns: bool

Definition at line 175 of file EventEmitterTrait.php.

References $index, and Sabre\Event\listeners().

Referenced by Sabre\Event\once().

                                                             {
 
         if (!isset($this->listeners[$eventName])) {
             return false;
         }
         foreach ($this->listeners[$eventName][2] as $index => $check) {
             if ($check === $listener) {
                 unset($this->listeners[$eventName][1][$index]);
                 unset($this->listeners[$eventName][2][$index]);
                 return true;
             }
         }
         return false;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ EventEmitterTrait

trait Sabre::Event\EventEmitterTrait

Initial value:

{
    
    protected $listeners = []

Event Emitter Trait.

This trait contains all the basic functions to implement an EventEmitterInterface.

Using the trait + interface allows you to add EventEmitter capabilities without having to change your base-class.

Author: Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 18 of file EventEmitterTrait.php.

Namespaces

Data Structures

Functions

Variables

Function Documentation

◆ coroutine()

◆ emit()

◆ listeners()

◆ on()

◆ once()

◆ removeAllListeners()

◆ removeListener()

Variable Documentation

◆ EventEmitterTrait