Overview

Namespaces

  • Charcoal
    • Loader
    • Model
      • Service
      • ServiceProvider
    • Source
      • Database
    • Validator

Classes

  • AbstractValidator
  • ValidatorResult

Interfaces

  • ValidatableInterface
  • ValidatorInterface

Traits

  • ValidatableTrait
  • Overview
  • Namespace
  • Class

Class AbstractValidator

An abstract class that implements most of ValidatorInterface.

The only abstract method in the class is validate()

Charcoal\Validator\AbstractValidator implements Charcoal\Validator\ValidatorInterface

Direct known subclasses

Charcoal\Model\ModelValidator
Abstract
Namespace: Charcoal\Validator
Located at Charcoal/Validator/AbstractValidator.php
Methods summary
public
# __construct( Charcoal\Validator\ValidatableInterface $model )

Parameters

$model
The object to validate.
public Charcoal\Validator\ValidatorInterface
# error( string $msg, string|null $ident = null )

Parameters

$msg
The error message.
$ident
Optional result ident.

Returns

Charcoal\Validator\ValidatorInterface

Implementation of

Charcoal\Validator\ValidatorInterface::error()
public Charcoal\Validator\ValidatorInterface
# warning( string $msg, string|null $ident = null )

Parameters

$msg
The warning message.
$ident
Optional result ident.

Returns

Charcoal\Validator\ValidatorInterface

Implementation of

Charcoal\Validator\ValidatorInterface::warning()
public Charcoal\Validator\ValidatorInterface
# notice( string $msg, string|null $ident = null )

Parameters

$msg
The notice message.
$ident
Optional result ident.

Returns

Charcoal\Validator\ValidatorInterface

Implementation of

Charcoal\Validator\ValidatorInterface::notice()
public Charcoal\Validator\ValidatorInterface
# log( string $level, string $msg, string|null $ident = null )

Parameters

$level
The validation level.
$msg
The validation message.
$ident
Optional result ident.

Returns

Charcoal\Validator\ValidatorInterface

Implementation of

Charcoal\Validator\ValidatorInterface::log()
public Charcoal\Validator\AbstractValidator
# addResult( array|Charcoal\Validator\ValidatorResult $result )

Parameters

$result
The result object or array.

Returns

Charcoal\Validator\AbstractValidator
Chainable

Throws

InvalidArgumentException
If result is not an array or object.
public array
# results( )

Returns

array

Implementation of

Charcoal\Validator\ValidatorInterface::results()
public array
# errorResults( )

Returns

array
public array
# warningResults( )

Returns

array
public array
# noticeResults( )

Returns

array
public Charcoal\Validator\ValidatorInterface
# merge( Charcoal\Validator\ValidatorInterface $v, string $ident_prefix = null )

Parameters

$v
The validator to merge.
$ident_prefix
Optional identigfier prefix.

Returns

Charcoal\Validator\ValidatorInterface
Chainable
abstract public boolean
# validate( )

Returns

boolean

Implementation of

Charcoal\Validator\ValidatorInterface::validate()
Constants summary
string ERROR
# 'error'
string WARNING
# 'warning'
string NOTICE
# 'notice'
Properties summary
protected Charcoal\Validator\ValidatableInterface $model
#
API documentation generated by ApiGen