You are here

class Argument in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/phpspec/prophecy/src/Prophecy/Argument.php \Prophecy\Argument

Argument tokens shortcuts.

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

Hierarchy

Expanded class hierarchy of Argument

33 files declare their use of Argument
ArrayEntryTokenSpec.php in vendor/phpspec/prophecy/spec/Prophecy/Argument/Token/ArrayEntryTokenSpec.php
ArrayEveryEntryTokenSpec.php in vendor/phpspec/prophecy/spec/Prophecy/Argument/Token/ArrayEveryEntryTokenSpec.php
CallPredictionSpec.php in vendor/phpspec/prophecy/spec/Prophecy/Prediction/CallPredictionSpec.php
ClosureComparatorSpec.php in vendor/phpspec/prophecy/spec/Prophecy/Comparator/ClosureComparatorSpec.php
ConditionTest.php in core/tests/Drupal/Tests/Core/Database/ConditionTest.php
Contains \Drupal\Tests\Core\Database\ConditionTest.

... See full list

2 string references to 'Argument'
views.data_types.schema.yml in core/modules/views/config/schema/views.data_types.schema.yml
core/modules/views/config/schema/views.data_types.schema.yml
views.entity_reference.schema.yml in core/modules/views/config/schema/views.entity_reference.schema.yml
core/modules/views/config/schema/views.entity_reference.schema.yml

File

vendor/phpspec/prophecy/src/Prophecy/Argument.php, line 21

Namespace

Prophecy
View source
class Argument {

  /**
   * Checks that argument is exact value or object.
   *
   * @param mixed $value
   *
   * @return Token\ExactValueToken
   */
  public static function exact($value) {
    return new Token\ExactValueToken($value);
  }

  /**
   * Checks that argument is of specific type or instance of specific class.
   *
   * @param string $type Type name (`integer`, `string`) or full class name
   *
   * @return Token\TypeToken
   */
  public static function type($type) {
    return new Token\TypeToken($type);
  }

  /**
   * Checks that argument object has specific state.
   *
   * @param string $methodName
   * @param mixed  $value
   *
   * @return Token\ObjectStateToken
   */
  public static function which($methodName, $value) {
    return new Token\ObjectStateToken($methodName, $value);
  }

  /**
   * Checks that argument matches provided callback.
   *
   * @param callable $callback
   *
   * @return Token\CallbackToken
   */
  public static function that($callback) {
    return new Token\CallbackToken($callback);
  }

  /**
   * Matches any single value.
   *
   * @return Token\AnyValueToken
   */
  public static function any() {
    return new Token\AnyValueToken();
  }

  /**
   * Matches all values to the rest of the signature.
   *
   * @return Token\AnyValuesToken
   */
  public static function cetera() {
    return new Token\AnyValuesToken();
  }

  /**
   * Checks that argument matches all tokens
   *
   * @param mixed ... a list of tokens
   *
   * @return Token\LogicalAndToken
   */
  public static function allOf() {
    return new Token\LogicalAndToken(func_get_args());
  }

  /**
   * Checks that argument array or countable object has exact number of elements.
   *
   * @param integer $value array elements count
   *
   * @return Token\ArrayCountToken
   */
  public static function size($value) {
    return new Token\ArrayCountToken($value);
  }

  /**
   * Checks that argument array contains (key, value) pair
   *
   * @param mixed $key   exact value or token
   * @param mixed $value exact value or token
   *
   * @return Token\ArrayEntryToken
   */
  public static function withEntry($key, $value) {
    return new Token\ArrayEntryToken($key, $value);
  }

  /**
   * Checks that arguments array entries all match value
   *
   * @param mixed $value
   *
   * @return Token\ArrayEveryEntryToken
   */
  public static function withEveryEntry($value) {
    return new Token\ArrayEveryEntryToken($value);
  }

  /**
   * Checks that argument array contains value
   *
   * @param mixed $value
   *
   * @return Token\ArrayEntryToken
   */
  public static function containing($value) {
    return new Token\ArrayEntryToken(self::any(), $value);
  }

  /**
   * Checks that argument array has key
   *
   * @param mixed $key exact value or token
   *
   * @return Token\ArrayEntryToken
   */
  public static function withKey($key) {
    return new Token\ArrayEntryToken($key, self::any());
  }

  /**
   * Checks that argument does not match the value|token.
   *
   * @param mixed $value either exact value or argument token
   *
   * @return Token\LogicalNotToken
   */
  public static function not($value) {
    return new Token\LogicalNotToken($value);
  }

  /**
   * @param string $value
   *
   * @return Token\StringContainsToken
   */
  public static function containingString($value) {
    return new Token\StringContainsToken($value);
  }

  /**
   * Checks that argument is identical value.
   *
   * @param mixed $value
   *
   * @return Token\IdenticalValueToken
   */
  public static function is($value) {
    return new Token\IdenticalValueToken($value);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Argument::allOf public static function Checks that argument matches all tokens
Argument::any public static function Matches any single value.
Argument::cetera public static function Matches all values to the rest of the signature.
Argument::containing public static function Checks that argument array contains value
Argument::containingString public static function
Argument::exact public static function Checks that argument is exact value or object.
Argument::is public static function Checks that argument is identical value.
Argument::not public static function Checks that argument does not match the value|token.
Argument::size public static function Checks that argument array or countable object has exact number of elements.
Argument::that public static function Checks that argument matches provided callback.
Argument::type public static function Checks that argument is of specific type or instance of specific class.
Argument::which public static function Checks that argument object has specific state.
Argument::withEntry public static function Checks that argument array contains (key, value) pair
Argument::withEveryEntry public static function Checks that arguments array entries all match value
Argument::withKey public static function Checks that argument array has key