api/laravel/Testing/Constraints/ArraySubset.yaml
2024-09-26 02:03:21 -07:00

132 lines
3 KiB
YAML

name: ArraySubset
class_comment: null
dependencies:
- name: ArrayObject
type: class
source: ArrayObject
- name: Constraint
type: class
source: PHPUnit\Framework\Constraint\Constraint
- name: ComparisonFailure
type: class
source: SebastianBergmann\Comparator\ComparisonFailure
- name: Exporter
type: class
source: SebastianBergmann\Exporter\Exporter
- name: Traversable
type: class
source: Traversable
properties:
- name: subset
visibility: protected
comment: '# * @var iterable'
- name: strict
visibility: protected
comment: '# * @var bool'
methods:
- name: __construct
visibility: public
parameters:
- name: subset
- name: strict
default: 'false'
comment: "# * @var iterable\n# */\n# protected $subset;\n# \n# /**\n# * @var bool\n\
# */\n# protected $strict;\n# \n# /**\n# * Create a new array subset constraint\
\ instance.\n# *\n# * @param iterable $subset\n# * @param bool $strict\n#\
\ * @return void"
- name: evaluate
visibility: public
parameters:
- name: other
- name: description
default: ''''''
- name: returnResult
default: 'false'
comment: '# * Evaluates the constraint for parameter $other.
# *
# * If $returnResult is set to false (the default), an exception is thrown
# * in case of a failure. null is returned otherwise.
# *
# * If $returnResult is true, the result of the evaluation is returned as
# * a boolean value instead: true in case of success, false in case of a
# * failure.
# *
# * @param mixed $other
# * @param string $description
# * @param bool $returnResult
# * @return bool|null
# *
# * @throws \PHPUnit\Framework\ExpectationFailedException
# * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException'
- name: toString
visibility: public
parameters: []
comment: '# * Returns a string representation of the constraint.
# *
# * @return string
# *
# * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException'
- name: failureDescription
visibility: protected
parameters:
- name: other
comment: '# * Returns the description of the failure.
# *
# * The beginning of failure messages is "Failed asserting that" in most
# * cases. This method should return the second part of that sentence.
# *
# * @param mixed $other
# * @return string
# *
# * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException'
- name: toArray
visibility: protected
parameters:
- name: other
comment: '# * Returns the description of the failure.
# *
# * The beginning of failure messages is "Failed asserting that" in most
# * cases. This method should return the second part of that sentence.
# *
# * @param iterable $other
# * @return array'
traits:
- ArrayObject
- PHPUnit\Framework\Constraint\Constraint
- SebastianBergmann\Comparator\ComparisonFailure
- SebastianBergmann\Exporter\Exporter
- Traversable
interfaces: []