annotate vendor/consolidation/annotated-command/src/Hooks/StatusDeterminerInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2 namespace Consolidation\AnnotatedCommand\Hooks;
Chris@0 3
Chris@0 4 /**
Chris@0 5 * A StatusDeterminer maps from a result to a status exit code.
Chris@0 6 *
Chris@17 7 * @deprecated. Instead of using a Status Determiner hook, commands
Chris@17 8 * should simply return their exit code and result data separately
Chris@17 9 * using a CommandResult object.
Chris@17 10 *
Chris@0 11 * @see HookManager::addStatusDeterminer()
Chris@0 12 */
Chris@0 13 interface StatusDeterminerInterface
Chris@0 14 {
Chris@0 15 /**
Chris@0 16 * Convert a result object into a status code, if
Chris@0 17 * possible. Return null if the result object is unknown.
Chris@0 18 *
Chris@0 19 * @return null|integer
Chris@0 20 */
Chris@0 21 public function determineStatusCode($result);
Chris@0 22 }