view 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
line wrap: on
line source
<?php
namespace Consolidation\AnnotatedCommand\Hooks;

/**
 * A StatusDeterminer maps from a result to a status exit code.
 *
 * @deprecated. Instead of using a Status Determiner hook, commands
 * should simply return their exit code and result data separately
 * using a CommandResult object.
 *
 * @see HookManager::addStatusDeterminer()
 */
interface StatusDeterminerInterface
{
    /**
     * Convert a result object into a status code, if
     * possible. Return null if the result object is unknown.
     *
     * @return null|integer
     */
    public function determineStatusCode($result);
}