platform/api/laravel/Validation/ValidationException.yaml
2024-09-02 10:44:11 -07:00

143 lines
3.4 KiB
YAML

name: ValidationException
class_comment: null
dependencies:
- name: Exception
type: class
source: Exception
- name: Arr
type: class
source: Illuminate\Support\Arr
- name: ValidatorFacade
type: class
source: Illuminate\Support\Facades\Validator
properties:
- name: validator
visibility: public
comment: '# * The validator instance.
# *
# * @var \Illuminate\Contracts\Validation\Validator'
- name: response
visibility: public
comment: '# * The recommended response to send to the client.
# *
# * @var \Symfony\Component\HttpFoundation\Response|null'
- name: status
visibility: public
comment: '# * The status code to use for the response.
# *
# * @var int'
- name: errorBag
visibility: public
comment: '# * The name of the error bag.
# *
# * @var string'
- name: redirectTo
visibility: public
comment: '# * The path the client should be redirected to.
# *
# * @var string'
methods:
- name: __construct
visibility: public
parameters:
- name: validator
- name: response
default: 'null'
- name: errorBag
default: '''default'''
comment: "# * The validator instance.\n# *\n# * @var \\Illuminate\\Contracts\\Validation\\\
Validator\n# */\n# public $validator;\n# \n# /**\n# * The recommended response\
\ to send to the client.\n# *\n# * @var \\Symfony\\Component\\HttpFoundation\\\
Response|null\n# */\n# public $response;\n# \n# /**\n# * The status code to use\
\ for the response.\n# *\n# * @var int\n# */\n# public $status = 422;\n# \n# /**\n\
# * The name of the error bag.\n# *\n# * @var string\n# */\n# public $errorBag;\n\
# \n# /**\n# * The path the client should be redirected to.\n# *\n# * @var string\n\
# */\n# public $redirectTo;\n# \n# /**\n# * Create a new exception instance.\n\
# *\n# * @param \\Illuminate\\Contracts\\Validation\\Validator $validator\n\
# * @param \\Symfony\\Component\\HttpFoundation\\Response|null $response\n#\
\ * @param string $errorBag\n# * @return void"
- name: withMessages
visibility: public
parameters:
- name: messages
comment: '# * Create a new validation exception from a plain array of messages.
# *
# * @param array $messages
# * @return static'
- name: summarize
visibility: protected
parameters:
- name: validator
comment: '# * Create an error message summary from the validation errors.
# *
# * @param \Illuminate\Contracts\Validation\Validator $validator
# * @return string'
- name: errors
visibility: public
parameters: []
comment: '# * Get all of the validation error messages.
# *
# * @return array'
- name: status
visibility: public
parameters:
- name: status
comment: '# * Set the HTTP status code to be used for the response.
# *
# * @param int $status
# * @return $this'
- name: errorBag
visibility: public
parameters:
- name: errorBag
comment: '# * Set the error bag on the exception.
# *
# * @param string $errorBag
# * @return $this'
- name: redirectTo
visibility: public
parameters:
- name: url
comment: '# * Set the URL to redirect to on a validation error.
# *
# * @param string $url
# * @return $this'
- name: getResponse
visibility: public
parameters: []
comment: '# * Get the underlying response instance.
# *
# * @return \Symfony\Component\HttpFoundation\Response|null'
traits:
- Exception
- Illuminate\Support\Arr
interfaces: []