Class: Formagic_Rule_Equal

Source Location: /Rule/Equal.php

Class Overview

Formagic_Rule_Abstract
   |
   --Formagic_Rule_Equal

Checks if value is given

Author(s):

Florian Sonnenburg

Version:

$Id: Equal.php 126 2011-05-18 18:41:58Z meweasle $

Copyright:

Variables

Methods

Inherited Variables

Class: Formagic_Rule_Abstract

Formagic_Rule_Abstract::$_name

Inherited Methods

Class: Formagic_Rule_Abstract

Formagic_Rule_Abstract::__construct(): Constructor
Formagic_Rule_Abstract::getMessage(): Returns translated error message of rule
Formagic_Rule_Abstract::getName(): Returns rule type identification string.
Formagic_Rule_Abstract::setMessage(): Sets the error message property.
Formagic_Rule_Abstract::validate(): Abstract of main validate method. Returns boolean value of check success.
Formagic_Rule_Abstract::_init(): Allows subclass initialization.

Class Details

[line 42]
Checks if value is given

Tags:

author:	Florian Sonnenburg
version:	$Id: Equal.php 126 2011-05-18 18:41:58Z meweasle $
copyright:	Copyright (c) 2007-2011 Florian Sonnenburg
license:	New BSD License

[ Top ]

Class Variables

$_comparedItem =

[line 54]

Item to be compared to

Tags:

access:

protected

Type:

Formagic_Item_Abstract

[ Top ]

$_message = 'Values do not match'

[line 48]

Default error message

Tags:

access:

protected

Type:	string
Overrides:	Array

[ Top ]

Class Methods

method validate [line 81]

boolean validate(
string
$value)

Performs rule check

Mandatory rule checks if value is given. Throws formagicRuleException if not.

Tags:

return:	True if the two values are identical
access:	public

Overrides Formagic_Rule_Abstract::validate() (Abstract of main validate method. Returns boolean value of check success.)

Parameters:

string

$value

Value to be checked

[ Top ]

method _init [line 62]

void _init(

$additionalArgs)

Allow subclass initialization.

Tags:

access:

protected

Overrides Formagic_Rule_Abstract::_init() (Allows subclass initialization.)

Parameters:

array

$additionalArgs

Array of options

[ Top ]

Documentation generated on Sun, 22 May 2011 22:40:10 +0200 by phpDocumentor 1.4.3