api/laravel/Validation/InvokableValidationRule.yaml

155 lines
4.3 KiB
YAML
Raw Normal View History

2024-09-26 09:03:21 +00:00
name: InvokableValidationRule
class_comment: null
dependencies:
- name: DataAwareRule
type: class
source: Illuminate\Contracts\Validation\DataAwareRule
- name: ImplicitRule
type: class
source: Illuminate\Contracts\Validation\ImplicitRule
- name: InvokableRule
type: class
source: Illuminate\Contracts\Validation\InvokableRule
- name: Rule
type: class
source: Illuminate\Contracts\Validation\Rule
- name: ValidationRule
type: class
source: Illuminate\Contracts\Validation\ValidationRule
- name: ValidatorAwareRule
type: class
source: Illuminate\Contracts\Validation\ValidatorAwareRule
- name: CreatesPotentiallyTranslatedStrings
type: class
source: Illuminate\Translation\CreatesPotentiallyTranslatedStrings
- name: CreatesPotentiallyTranslatedStrings
type: class
source: CreatesPotentiallyTranslatedStrings
properties:
- name: invokable
visibility: protected
comment: '# * The invokable that validates the attribute.
# *
# * @var \Illuminate\Contracts\Validation\ValidationRule|\Illuminate\Contracts\Validation\InvokableRule'
- name: failed
visibility: protected
comment: '# * Indicates if the validation invokable failed.
# *
# * @var bool'
- name: messages
visibility: protected
comment: '# * The validation error messages.
# *
# * @var array'
- name: validator
visibility: protected
comment: '# * The current validator.
# *
# * @var \Illuminate\Validation\Validator'
- name: data
visibility: protected
comment: '# * The data under validation.
# *
# * @var array'
methods:
- name: __construct
visibility: protected
parameters:
- name: invokable
comment: "# * The invokable that validates the attribute.\n# *\n# * @var \\Illuminate\\\
Contracts\\Validation\\ValidationRule|\\Illuminate\\Contracts\\Validation\\InvokableRule\n\
# */\n# protected $invokable;\n# \n# /**\n# * Indicates if the validation invokable\
\ failed.\n# *\n# * @var bool\n# */\n# protected $failed = false;\n# \n# /**\n\
# * The validation error messages.\n# *\n# * @var array\n# */\n# protected $messages\
\ = [];\n# \n# /**\n# * The current validator.\n# *\n# * @var \\Illuminate\\Validation\\\
Validator\n# */\n# protected $validator;\n# \n# /**\n# * The data under validation.\n\
# *\n# * @var array\n# */\n# protected $data = [];\n# \n# /**\n# * Create a new\
\ explicit Invokable validation rule.\n# *\n# * @param \\Illuminate\\Contracts\\\
Validation\\ValidationRule|\\Illuminate\\Contracts\\Validation\\InvokableRule\
\ $invokable\n# * @return void"
- name: make
visibility: public
parameters:
- name: invokable
comment: '# * Create a new implicit or explicit Invokable validation rule.
# *
# * @param \Illuminate\Contracts\Validation\ValidationRule|\Illuminate\Contracts\Validation\InvokableRule $invokable
# * @return \Illuminate\Contracts\Validation\Rule|\Illuminate\Validation\InvokableValidationRule'
- name: passes
visibility: public
parameters:
- name: attribute
- name: value
comment: '# * Determine if the validation rule passes.
# *
# * @param string $attribute
# * @param mixed $value
# * @return bool'
- name: invokable
visibility: public
parameters: []
comment: '# * Get the underlying invokable rule.
# *
# * @return \Illuminate\Contracts\Validation\ValidationRule|\Illuminate\Contracts\Validation\InvokableRule'
- name: message
visibility: public
parameters: []
comment: '# * Get the validation error messages.
# *
# * @return array'
- name: setData
visibility: public
parameters:
- name: data
comment: '# * Set the data under validation.
# *
# * @param array $data
# * @return $this'
- name: setValidator
visibility: public
parameters:
- name: validator
comment: '# * Set the current validator.
# *
# * @param \Illuminate\Validation\Validator $validator
# * @return $this'
traits:
- Illuminate\Contracts\Validation\DataAwareRule
- Illuminate\Contracts\Validation\ImplicitRule
- Illuminate\Contracts\Validation\InvokableRule
- Illuminate\Contracts\Validation\Rule
- Illuminate\Contracts\Validation\ValidationRule
- Illuminate\Contracts\Validation\ValidatorAwareRule
- Illuminate\Translation\CreatesPotentiallyTranslatedStrings
- CreatesPotentiallyTranslatedStrings
interfaces:
- Rule
- ImplicitRule