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

Breadcrumb

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

class ObjectStateToken

Object state-checker token.

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

Hierarchy

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

Expanded class hierarchy of ObjectStateToken

File

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

Namespace

Prophecy\Argument\Token
View source
class ObjectStateToken implements TokenInterface {
    private $name;
    private $value;
    private $util;
    private $comparatorFactory;
    
    /**
     * Initializes token.
     *
     * @param string $methodName
     * @param mixed  $value             Expected return value
     */
    public function __construct($methodName, $value, ?StringUtil $util = null, ?ComparatorFactory $comparatorFactory = null) {
        $this->name = $methodName;
        $this->value = $value;
        $this->util = $util ?: new StringUtil();
        $this->comparatorFactory = $comparatorFactory ?: FactoryProvider::getInstance();
    }
    
    /**
     * Scores 8 if argument is an object, which method returns expected value.
     *
     * @param mixed $argument
     *
     * @return bool|int
     */
    public function scoreArgument($argument) {
        $methodCallable = array(
            $argument,
            $this->name,
        );
        if (is_object($argument) && method_exists($argument, $this->name) && is_callable($methodCallable)) {
            $actual = call_user_func($methodCallable);
            $comparator = $this->comparatorFactory
                ->getComparatorFor($this->value, $actual);
            try {
                $comparator->assertEquals($this->value, $actual);
                return 8;
            } catch (ComparisonFailure $failure) {
                return false;
            }
        }
        if (is_object($argument) && property_exists($argument, $this->name)) {
            return $argument->{$this->name} === $this->value ? 8 : false;
        }
        return false;
    }
    
    /**
     * Returns false.
     *
     * @return bool
     */
    public function isLast() {
        return false;
    }
    
    /**
     * Returns string representation for token.
     *
     * @return string
     */
    public function __toString() {
        return sprintf('state(%s(), %s)', $this->name, $this->util
            ->stringify($this->value));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ObjectStateToken::$comparatorFactory private property
ObjectStateToken::$name private property
ObjectStateToken::$util private property
ObjectStateToken::$value private property
ObjectStateToken::isLast public function Returns false. Overrides TokenInterface::isLast
ObjectStateToken::scoreArgument public function Scores 8 if argument is an object, which method returns expected value. Overrides TokenInterface::scoreArgument
ObjectStateToken::__construct public function Initializes token.
ObjectStateToken::__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