Formagic
Back to top  

Checks if validated value matches a specified counterpart.

category Formagic
package Rule
author Florian Sonnenburg
copyright Copyright (c) 2007-2011 Florian Sonnenburg
license New BSD License
version $Id: Equal.php 169 2012-05-06 20:16:16Z meweasle $

 Methods

Constructor

__construct(array $arguments) 
Inherited

The default error message that is displayed if the rule is violated can be overwritten by $errorMessage.

see \self::_init()
inherited_from \Formagic_Rule_Abstract::__construct()

Parameters

$arguments

array

The rule options.

Returns translated error message of rule

getMessage() : string
Inherited

inherited_from \Formagic_Rule_Abstract::getMessage()

Returns

stringMessage string

Returns rule type identification string.

getName() : string
Inherited

inherited_from \Formagic_Rule_Abstract::getName()

Returns

stringThe rule name

Sets the error message property.

setMessage(mixed $message) : \Formagic_Rule_Abstract
Inherited

Usually a rule will have one error message string that is used if the validation fails. If neccessary, Formagic_Rule_Abstract::_errorMessage can hold other variables, eg. an array of error messages for different outcomes of the validation process.

Implements a fluent interface pattern.

see \Formagic_Rule_Abstract::__construct()
inherited_from \Formagic_Rule_Abstract::setMessage()

Parameters

$message

mixed

The error message value.

Returns

\Formagic_Rule_Abstract$this object.

Performs rule check

validate(string $value) : boolean

Subclasses have to implement their behavior here.

Parameters

$value

string

Value to be checked

Returns

booleanTrue if the two values are identical

Allow subclass initialization.

_init(array $additionalArgs) : void

Supported keys:

item
:
The item which's value is compaired against

Parameters

$additionalArgs

array

Array of options

Exceptions

\Formagic_Exception If key "item" is not provided or has invalid value

Checks if value is not entered by a user or if the field has not been assigned to the form.

_isNoUserValue(\$value $value) : boolean
Inherited

The value 0 (zero) for example could be something the user entered willingly and would be skipped from rule checks when using empty().

inherited_from \Formagic_Rule_Abstract::_isNoUserValue()

Parameters

$value

\$value

mixed Value to be checked

Returns

boolean

 Properties

 

Item to be compared to

$_comparedItem : \Formagic_Item_Abstract

 

Default error message

$_message : string

 

Rule type identifier.

$_name : string
Inherited

inherited_from \Formagic_Rule_Abstract::$$_name