TokenInterface.php

<?php


/*
 * This file is part of the Prophecy.
 * (c) Konstantin Kudryashov <ever.zet@gmail.com>
 *     Marcello Duarte <marcello.duarte@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Prophecy\Argument\Token;


/**
 * Argument token interface.
 *
 * @author Konstantin Kudryashov <ever.zet@gmail.com>
 */
interface TokenInterface {
    
    /**
     * Calculates token match score for provided argument.
     *
     * @param mixed $argument
     *
     * @return false|int
     */
    public function scoreArgument($argument);
    
    /**
     * Returns true if this token prevents check of other tokens (is last one).
     *
     * @return bool
     */
    public function isLast();
    
    /**
     * Returns string representation for token.
     *
     * @return string
     */
    public function __toString();

}