RuleMatch Class Reference

List of all members.

Public Member Functions
	__construct ()
	addName ($strName, $mixValue=TRUE)
	setNameList ($arrNameList)
	getNameList ()
	addRegularExpression ($strtRegularExpression, $mixValue=TRUE)
	setRegularExpressionList ($arrRegularExpressionList)
	getRegularExpressionList ()
	setNotFoundValue ($mixNotFoundedValue)
	getNotFoundValue ()
	found ($strName)
	isEmpty ()
	match ($strName)
Protected Attributes
	$objNameRuleList = null
	$objRegexRuleList = null

---

Detailed Description

Definition at line 11 of file RuleMatch.class.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 24 of file RuleMatch.class.php.

    {
        $this->objNameRuleList = new RuleNameMatch();
        $this->objRegexRuleList = new RuleRegularExpressionMatch();
    }

---

Member Function Documentation

addName	(	$	strName,
		$	mixValue = TRUE
	)

See also:

RuleNameMatch::addName( string , mixer )

Parameters:

	string	$strName
	mixer	$mixValue

Returns:

RuleMatch

Definition at line 37 of file RuleMatch.class.php.

    {
        $this->objNameRuleList->addName( $strName , $mixValue );
        return $this;
    }

addRegularExpression	(	$	strtRegularExpression,
		$	mixValue = TRUE
	)

See also:

RuleNameMatch::addtRegularExpression( string , mixer )

Parameters:

	string	$strtRegularExpression
	mixer	$mixValue

Returns:

RuleMatch

Definition at line 71 of file RuleMatch.class.php.

    {
        $this->objRegexRuleList->addRegularExpression( $strtRegularExpression , $mixValue );
        return $this;
    }

found

(

$

strName

)

Search the element into the array and returns true if founded and false if not

Parameters:

string

$strName

Returns:

boolean

Definition at line 128 of file RuleMatch.class.php.

    {
        if ( $this->objNameRuleList->found( $strName ) )
        {
            return TRUE;
        }
        else
        {
            return $this->objRegexRuleList->found( $strName );
        }
    }

getNameList

(

)

See also:

RuleNameMatch::getNameList()

Returns:

string[]

Definition at line 58 of file RuleMatch.class.php.

    {
        return $this->objNameRuleList->getNameList();
    }

getNotFoundValue

(

)

See also:

RuleNameMatch::getNotFoundValue()

RuleRegularExpressionMatch::getNotFoundValue()

Returns:

mixer

Definition at line 116 of file RuleMatch.class.php.

Referenced by match().

    {
        return $this->objNameRuleList->getNotFoundedValue();
    }

getRegularExpressionList

(

)

See also:

RuleRegularExpressionMatch::getRegularExpressionList()

Returns:

string[]

Definition at line 93 of file RuleMatch.class.php.

    {
        return $this->objRegexRuleList->getRegularExpressionList();
    }

isEmpty

(

)

Returns if the rule is empty

Returns:

boolean

Definition at line 145 of file RuleMatch.class.php.

    {
        return ( $this->objNameRuleList->isEmpty() && $this->objRegexRuleList->isEmpty() );
    }

match

(

$

strName

)

Match the string name

See also:

RuleNameMatch::match( string )

RuleRegularExpressionMatch::match( string )

Returns:

mixer

Definition at line 157 of file RuleMatch.class.php.

References getNotFoundValue().

    {
        if( $this->objNameRuleList->found( $strName ) )
        {
            return $this->objNameRuleList->match( $strName );
        }
        if( $this->objRegexRuleList->found($strRegularExpression))
        {
            return $this->objNameRuleList->match( $strName );
        }
        return $this->getNotFoundValue();
    }

setNameList

(

$

arrNameList

)

See also:

RuleNameMatch::setNameList( string[] )

Parameters:

array

$arrNameList

Returns:

RuleMatch

Definition at line 48 of file RuleMatch.class.php.

    {
        $this->objNameRuleList->setNameList( $arrNameList );
        return $this;
    }

setNotFoundValue

(

$

mixNotFoundedValue

)

See also:

RuleNameMatch::setNotFoundValue()

RuleRegularExpressionMatch::setNotFoundValue()

Returns:

RuleMatch

Definition at line 104 of file RuleMatch.class.php.

    {
        $this->objNameRuleList->setNotFoundValue( $mixNotFoundedValue );
        $this->objRegexRuleList->setNotFoundValue( $mixNotFoundedValue );
        return $this;
    }

setRegularExpressionList

(

$

arrRegularExpressionList

)

See also:

RuleRegularExpressionMatch::setRegularExpressionList( string[] )

Parameters:

string[]

$arrRegularExpressionList

Returns:

RuleMatch

Definition at line 82 of file RuleMatch.class.php.

    {
        $this->objRegexRuleList->setRegularExpressionList( $arrRegularExpressionList );
        return $this;
    }

---

Member Data Documentation

$objNameRuleList = null [protected]

RuleNameMatch

Definition at line 16 of file RuleMatch.class.php.

$objRegexRuleList = null [protected]

RuleRegularExpressionMatch

Definition at line 22 of file RuleMatch.class.php.

---

The documentation for this class was generated from the following file:

• components/ruleMatchList/RuleMatch.class.php