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

Breadcrumb

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

class ArrayCountToken

Array elements count token.

@author Boris Mikhaylov <kaguxmail@gmail.com>

Hierarchy

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

Expanded class hierarchy of ArrayCountToken

File

vendor/phpspec/prophecy/src/Prophecy/Argument/Token/ArrayCountToken.php, line 20

Namespace

Prophecy\Argument\Token
View source
class ArrayCountToken implements TokenInterface {
    private $count;
    
    /**
     * @param integer $value
     */
    public function __construct($value) {
        $this->count = $value;
    }
    
    /**
     * Scores 6 when argument has preset number of elements.
     *
     * @param mixed $argument
     *
     * @return false|int
     */
    public function scoreArgument($argument) {
        return $this->isCountable($argument) && $this->hasProperCount($argument) ? 6 : false;
    }
    
    /**
     * Returns false.
     *
     * @return boolean
     */
    public function isLast() {
        return false;
    }
    
    /**
     * Returns string representation for token.
     *
     * @return string
     */
    public function __toString() {
        return sprintf('count(%s)', $this->count);
    }
    
    /**
     * Returns true if object is either array or instance of \Countable
     *
     * @param mixed $argument
     * @return bool
     *
     * @phpstan-assert-if-true array<mixed>|\Countable $argument
     */
    private function isCountable($argument) {
        return is_array($argument) || $argument instanceof \Countable;
    }
    
    /**
     * Returns true if $argument has expected number of elements
     *
     * @param array<mixed>|\Countable $argument
     *
     * @return bool
     */
    private function hasProperCount($argument) {
        return $this->count === count($argument);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ArrayCountToken::$count private property
ArrayCountToken::hasProperCount private function Returns true if $argument has expected number of elements
ArrayCountToken::isCountable private function Returns true if object is either array or instance of \Countable
ArrayCountToken::isLast public function Returns false. Overrides TokenInterface::isLast
ArrayCountToken::scoreArgument public function Scores 6 when argument has preset number of elements. Overrides TokenInterface::scoreArgument
ArrayCountToken::__construct public function
ArrayCountToken::__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