Sabre\Event\Promise Namespace Reference

Functions
	all (array $promises)
	This file contains a set of functions that are useful for dealing with the Promise object. More...
	race (array $promises)
	The race function returns a promise that resolves or rejects as soon as one of the promises in the argument resolves or rejects. More...
	resolve ($value)
	Returns a Promise that resolves with the given value. More...
	reject ($reason)
	Returns a Promise that will reject with the given reason. More...

Function Documentation

all()

Sabre\Event\Promise\all

(

array

$promises

)

This file contains a set of functions that are useful for dealing with the Promise object.

Copyright

Copyright (C) 2013-2015 fruux GmbH (https://fruux.com/).

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License This function takes an array of Promises, and returns a Promise that resolves when all of the given arguments have resolved.

The returned Promise will resolve with a value that's an array of all the values the given promises have been resolved with.

This array will be in the exact same order as the array of input promises.

If any of the given Promises fails, the returned promise will immidiately fail with the first Promise that fails, and its reason.

Parameters

Promise[]

$promises

Returns

Promise

Definition at line 32 of file functions.php.

References $result, $success, and Sabre\Event\Promise\error().

Referenced by Slim\Http\Headers\all(), ilPCTable\importHtml(), Slim\Handlers\NotFound\renderHtmlNotFoundOutput(), Sabre\VObject\Parser\XmlTest\testRFC6321Example2(), and Sabre\DAVACL\Xml\Property\SupportedPrivilegeSetTest\testToHtml().

                              {

    return new Promise(function($success, $fail) use ($promises) {

        $successCount = 0;
        $completeResult = [];

        foreach ($promises as $promiseIndex => $subPromise) {

            $subPromise->then(
                function($result) use ($promiseIndex, &$completeResult, &$successCount, $success, $promises) {
                    $completeResult[$promiseIndex] = $result;
                    $successCount++;
                    if ($successCount === count($promises)) {
                        $success($completeResult);
                    }
                    return $result;
                }
            )->error(
                function($reason) use ($fail) {
                    $fail($reason);
                }
            );

        }
    });

}

Here is the call graph for this function:

Here is the caller graph for this function:

race()

Sabre\Event\Promise\race

(

array

$promises

)

The race function returns a promise that resolves or rejects as soon as one of the promises in the argument resolves or rejects.

The returned promise will resolve or reject with the value or reason of that first promise.

Parameters

Promise[]

$promises

Returns

Promise

Definition at line 71 of file functions.php.

References $promise, $result, and $success.

Referenced by Sabre\Event\Promise\FunctionsTest\testRace(), Sabre\Event\PromiseTest\testRace(), Sabre\Event\Promise\FunctionsTest\testRaceReject(), and Sabre\Event\PromiseTest\testRaceReject().

                               {

    return new Promise(function($success, $fail) use ($promises) {

        $alreadyDone = false;
        foreach ($promises as $promise) {

            $promise->then(
                function($result) use ($success, &$alreadyDone) {
                    if ($alreadyDone) {
                        return;
                    }
                    $alreadyDone = true;
                    $success($result);
                },
                function($reason) use ($fail, &$alreadyDone) {
                    if ($alreadyDone) {
                        return;
                    }
                    $alreadyDone = true;
                    $fail($reason);
                }
            );

        }

    });

}

Here is the caller graph for this function:

reject()

Sabre\Event\Promise\reject

(

$reason

)

Returns a Promise that will reject with the given reason.

Parameters

mixed

$reason

Returns

Promise

Definition at line 129 of file functions.php.

References $promise.

                         {

    $promise = new Promise();
    $promise->reject($reason);
    return $promise;

}

resolve()

Sabre\Event\Promise\resolve

(

$value

)

Returns a Promise that resolves with the given value.

If the value is a promise, the returned promise will attach itself to that promise and eventually get the same state as the followed promise.

Parameters

mixed

$value

Returns

Promise

Definition at line 111 of file functions.php.

References $promise, and Sabre\Event\Promise\$value.

Referenced by Sabre\HTTP\Client\send(), Sabre\Event\Promise\FunctionsTest\testResolve(), Sabre\Event\Promise\FunctionsTest\testResolvePromise(), Sabre\Xml\Element\Uri\xmlDeserialize(), and Sabre\Xml\Element\Uri\xmlSerialize().

                         {

    if ($value instanceof Promise) {
        return $value->then();
    } else {
        $promise = new Promise();
        $promise->fulfill($value);
        return $promise;
    }

}

Here is the caller graph for this function: