PHP Class ActiveRecord\Errors

Inheritance: implements IteratorAggregat\IteratorAggregate

Show file Open project: jpfuentes2/php-activerecord Class Usage Examples

Public Properties

Property	Type	Description
$DEFAULT_ERROR_MESSAGES

Public Methods

Method	Description
__construct ( ActiveRecord\Model $model ) : Errors	Constructs an {@link Errors} object.
__get ( string $attribute ) : array	Retrieve error messages for an attribute.
__toString ( ) : string	Convert all error messages to a String.
add ( string $attribute, string $msg )	Add an error message.
add_on_blank ( string $attribute, string $msg )	Adds the error message only if the attribute value was null or an empty string.
add_on_empty ( string $attribute, string $msg )	Adds an error message only if the attribute value is {@link http://www.php.net/empty empty}.
clear ( )	Clears out all error messages.
clear_model ( )	Nulls $model so we don't get pesky circular references. $model is only needed during the validation process and so can be safely cleared once that is done.
full_messages ( ) : array	Returns all the error messages as an array.
getIterator ( ) : ArrayIterator	Returns an iterator to the error messages.
get_raw_errors ( )	Returns the internal errors object.
is_empty ( ) : boolean	Returns true if there are no error messages.
is_invalid ( string $attribute ) : boolean	Returns true if the specified attribute had any error messages.
on ( string $attribute ) : string/array	Returns the error message(s) for the specified attribute or null if none.
size ( ) : integer	Returns the number of error messages there are.
to_array ( callable $closure = null ) : array	Returns all the error messages as an array, including error key.

Method Details

__construct() public method

Constructs an {@link Errors} object.

public __construct ( ActiveRecord\Model $model ) : Errors
$model	ActiveRecord\Model	The model the error is for
return	Errors

__get() public method

Retrieve error messages for an attribute.

public __get ( string $attribute ) : array
$attribute	string	Name of an attribute on the model
return	array	or null if there is no error.

__toString() public method

This function is called implicitely if the object is casted to a string:


echo $error;

# "Name can't be blank\nState is the wrong length (should be 2 chars)"

public __toString ( ) : string
return	string

add() public method

Add an error message.

public add ( string $attribute, string $msg )
$attribute	string	Name of an attribute on the model
$msg	string	The error message

add_on_blank() public method

Adds the error message only if the attribute value was null or an empty string.

public add_on_blank ( string $attribute, string $msg )
$attribute	string	Name of an attribute on the model
$msg	string	The error message

add_on_empty() public method

Adds an error message only if the attribute value is {@link http://www.php.net/empty empty}.

public add_on_empty ( string $attribute, string $msg )
$attribute	string	Name of an attribute on the model
$msg	string	The error message

clear() public method

Clears out all error messages.

public clear ( )

clear_model() public method

Nulls $model so we don't get pesky circular references. $model is only needed during the validation process and so can be safely cleared once that is done.

public clear_model ( )

full_messages() public method


$model->errors->full_messages();

# array(
#  "Name can't be blank",
#  "State is the wrong length (should be 2 chars)"
# )

public full_messages ( ) : array
return	array

getIterator() public method

This will allow you to iterate over the {@link Errors} object using foreach.


foreach ($model->errors as $msg)
  echo "$msg\n";

public getIterator ( ) : ArrayIterator
return	ArrayIterator

get_raw_errors() public method


$model->errors->get_raw_errors();

# array(
#  "name" => array("can't be blank"),
#  "state" => array("is the wrong length (should be 2 chars)",
# )

public get_raw_errors ( )

is_empty() public method

Returns true if there are no error messages.

public is_empty ( ) : boolean
return	boolean

is_invalid() public method

Returns true if the specified attribute had any error messages.

public is_invalid ( string $attribute ) : boolean
$attribute	string	Name of an attribute on the model
return	boolean

on() public method

Returns the error message(s) for the specified attribute or null if none.

public on ( string $attribute ) : string/array
$attribute	string	Name of an attribute on the model
return	string/array

size() public method

Returns the number of error messages there are.

public size ( ) : integer
return	integer

to_array() public method


$model->errors->errors();

# array(
#  "name" => array("Name can't be blank"),
#  "state" => array("State is the wrong length (should be 2 chars)")
# )

public to_array ( callable $closure = null ) : array
$closure	callable	Closure to fetch the errors in some other format (optional) This closure has the signature function($attribute, $message) and is called for each available error message.
return	array

Property Details

$DEFAULT_ERROR_MESSAGES public static property

public static $DEFAULT_ERROR_MESSAGES