Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ExactValueToken.php

class ExactValueToken

Exact value token.

@author Konstantin Kudryashov <ever.zet@gmail.com>

Hierarchy

  • class \Prophecy\Argument\Token\ExactValueToken implements \Prophecy\Argument\Token\TokenInterface

Expanded class hierarchy of ExactValueToken

File

vendor/phpspec/prophecy/src/Prophecy/Argument/Token/ExactValueToken.php, line 24

Namespace

Prophecy\Argument\Token
View source
class ExactValueToken implements TokenInterface {
    private $value;
    
    /**
     * @var string|null
     */
    private $string;
    private $util;
    private $comparatorFactory;
    
    /**
     * Initializes token.
     *
     * @param mixed $value
     */
    public function __construct($value, ?StringUtil $util = null, ?ComparatorFactory $comparatorFactory = null) {
        $this->value = $value;
        $this->util = $util ?: new StringUtil();
        $this->comparatorFactory = $comparatorFactory ?: FactoryProvider::getInstance();
    }
    
    /**
     * Scores 10 if argument matches preset value.
     *
     * @param mixed $argument
     *
     * @return false|int
     */
    public function scoreArgument($argument) {
        if (is_object($argument) && is_object($this->value)) {
            $comparator = $this->comparatorFactory
                ->getComparatorFor($argument, $this->value);
            try {
                $comparator->assertEquals($argument, $this->value);
                return 10;
            } catch (ComparisonFailure $failure) {
                return false;
            }
        }
        // If either one is an object it should be castable to a string
        if (is_object($argument) xor is_object($this->value)) {
            if (is_object($argument) && !method_exists($argument, '__toString')) {
                return false;
            }
            if (is_object($this->value) && !method_exists($this->value, '__toString')) {
                return false;
            }
            if (is_numeric($argument) xor is_numeric($this->value)) {
                return strval($argument) == strval($this->value) ? 10 : false;
            }
        }
        elseif (is_numeric($argument) && is_numeric($this->value)) {
            // noop
        }
        elseif (gettype($argument) !== gettype($this->value)) {
            return false;
        }
        return $argument == $this->value ? 10 : false;
    }
    
    /**
     * Returns preset value against which token checks arguments.
     *
     * @return mixed
     */
    public function getValue() {
        return $this->value;
    }
    
    /**
     * Returns false.
     *
     * @return bool
     */
    public function isLast() {
        return false;
    }
    
    /**
     * Returns string representation for token.
     *
     * @return string
     */
    public function __toString() {
        if (null === $this->string) {
            $this->string = sprintf('exact(%s)', $this->util
                ->stringify($this->value));
        }
        return $this->string;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ExactValueToken::$comparatorFactory private property
ExactValueToken::$string private property
ExactValueToken::$util private property
ExactValueToken::$value private property
ExactValueToken::getValue public function Returns preset value against which token checks arguments.
ExactValueToken::isLast public function Returns false. Overrides TokenInterface::isLast
ExactValueToken::scoreArgument public function Scores 10 if argument matches preset value. Overrides TokenInterface::scoreArgument
ExactValueToken::__construct public function Initializes token.
ExactValueToken::__toString public function Returns string representation for token. Overrides TokenInterface::__toString

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal