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

Breadcrumb

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

class ArgumentsWildcard

Arguments wildcarding.

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

Hierarchy

  • class \Prophecy\Argument\ArgumentsWildcard

Expanded class hierarchy of ArgumentsWildcard

6 files declare their use of ArgumentsWildcard
Call.php in vendor/phpspec/prophecy/src/Prophecy/Call/Call.php
CallCenter.php in vendor/phpspec/prophecy/src/Prophecy/Call/CallCenter.php
CallPrediction.php in vendor/phpspec/prophecy/src/Prophecy/Prediction/CallPrediction.php
CallTimesPrediction.php in vendor/phpspec/prophecy/src/Prophecy/Prediction/CallTimesPrediction.php
MethodNotFoundException.php in vendor/phpspec/prophecy/src/Prophecy/Exception/Doubler/MethodNotFoundException.php

... See full list

File

vendor/phpspec/prophecy/src/Prophecy/Argument/ArgumentsWildcard.php, line 19

Namespace

Prophecy\Argument
View source
class ArgumentsWildcard {
    
    /**
     * @var list<Token\TokenInterface>
     */
    private $tokens = array();
    
    /**
     * @var string|null
     */
    private $string;
    
    /**
     * Initializes wildcard.
     *
     * @param array<mixed> $arguments Array of argument tokens or values
     */
    public function __construct(array $arguments) {
        foreach ($arguments as $argument) {
            if (!$argument instanceof Token\TokenInterface) {
                $argument = new Token\ExactValueToken($argument);
            }
            $this->tokens[] = $argument;
        }
    }
    
    /**
     * Calculates wildcard match score for provided arguments.
     *
     * @param array<mixed> $arguments
     *
     * @return false|int False OR integer score (higher - better)
     */
    public function scoreArguments(array $arguments) {
        if (0 == count($arguments) && 0 == count($this->tokens)) {
            return 1;
        }
        $arguments = array_values($arguments);
        $totalScore = 0;
        foreach ($this->tokens as $i => $token) {
            $argument = isset($arguments[$i]) ? $arguments[$i] : null;
            if (1 >= ($score = $token->scoreArgument($argument))) {
                return false;
            }
            $totalScore += $score;
            if (true === $token->isLast()) {
                return $totalScore;
            }
        }
        if (count($arguments) > count($this->tokens)) {
            return false;
        }
        return $totalScore;
    }
    
    /**
     * Returns string representation for wildcard.
     *
     * @return string
     */
    public function __toString() {
        if (null === $this->string) {
            $this->string = implode(', ', array_map(function ($token) {
                return (string) $token;
            }, $this->tokens));
        }
        return $this->string;
    }
    
    /**
     * @return list<Token\TokenInterface>
     */
    public function getTokens() {
        return $this->tokens;
    }

}

Members

Title Sort descending Modifiers Object type Summary
ArgumentsWildcard::$string private property
ArgumentsWildcard::$tokens private property
ArgumentsWildcard::getTokens public function
ArgumentsWildcard::scoreArguments public function Calculates wildcard match score for provided arguments.
ArgumentsWildcard::__construct public function Initializes wildcard.
ArgumentsWildcard::__toString public function Returns string representation for wildcard.

API Navigation

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