RuleMatchList Class Reference

List of all members.

Public Member Functions
	__construct ()
	setIgnoredRuleMatch (RuleMatch $objIgnoredRuleMatch)
	getIgnoredMatchList ()
	addIgnoredName ($strIgnoredName)
	addIgnoredRegularExpression ($strIgnoredRegex)
	setExclusiveRuleMatch (RuleMatch $objExclusiveRuleMatch)
	getExclusiveMatchList ()
	addExclusiveName ($strExclusiveName, $mixValue=TRUE)
	addExclusiveRegularExpression ($strExclusiveRegex)
	setNotFoundValue ($mixValue)
	getNotFoundValue ()
	match ($strName)
Protected Attributes
	$objIgnoredRuleMatch = null
	$objExclusiveRuleMatch = null
	$mixNotFoundValue = TRUE

---

Detailed Description

Definition at line 12 of file RuleMatchList.class.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 32 of file RuleMatchList.class.php.

    {
        $this->objIgnoredRuleMatch = new RuleMatch();
        $this->objExclusiveRuleMatch = new ruleMatch();
    }

---

Member Function Documentation

addExclusiveName	(	$	strExclusiveName,
		$	mixValue = TRUE
	)

add a exclusive name into the rule

See also:

RuleMatch::addName( string , mixer )

Parameters:

	string	$strExclusiveName
	mixer	$mixValue value of the element. Beware!

Returns:

RuleMatchList me

Definition at line 111 of file RuleMatchList.class.php.

References getExclusiveMatchList().

    {
        $this->getExclusiveMatchList()->addName( $strExclusiveName , $mixValue);
        return $this;
    }

addExclusiveRegularExpression

(

$

strExclusiveRegex

)

See also:

RuleMatch::addRegularExpression( string , mixer )

Parameters:

string

$strIgnoreName

Returns:

RuleMatchList me

Definition at line 123 of file RuleMatchList.class.php.

    {
        return $this;
    }

addIgnoredName

(

$

strIgnoredName

)

See also:

RuleMatch::addName( string , mixer )

Parameters:

string

$strIgnoredName

Returns:

RuleMatchList me

Definition at line 64 of file RuleMatchList.class.php.

References getIgnoredMatchList().

    {
        $this->getIgnoredMatchList()->addName( $strIgnoredName , TRUE );
        return $this;
    }

addIgnoredRegularExpression

(

$

strIgnoredRegex

)

See also:

RuleMatch::addRegularExpression( string , mixer )

Parameters:

string

$strIgnoreName

Returns:

RuleMatchList me

Definition at line 76 of file RuleMatchList.class.php.

References getIgnoredMatchList().

    {
        $this->getIgnoredMatchList()->addRegularExpression( $strIgnoredRegex, TRUE );
        return $this;
    }

getExclusiveMatchList

(

)

Returns:

RuleMatch

Definition at line 98 of file RuleMatchList.class.php.

Referenced by addExclusiveName(), and match().

    {
        return $this->objExclusiveRuleMatch;
    }

getIgnoredMatchList

(

)

Returns:

RuleMatch

Definition at line 53 of file RuleMatchList.class.php.

Referenced by addIgnoredName(), addIgnoredRegularExpression(), and match().

    {
        return $this->objIgnoredRuleMatch;
    }

getNotFoundValue

(

)

Get the value what shoul be return when the name not be found into any list

Returns:

mixer

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

Referenced by match().

    {
        return $this->mixNotFoundValue;
    }

match

(

$

strName

)

Match the string name

Parameters:

string

$strName

Returns:

mixer

Definition at line 156 of file RuleMatchList.class.php.

References getExclusiveMatchList(), getIgnoredMatchList(), and getNotFoundValue().

    {
        if( $this->getExclusiveMatchList()->isEmpty() == FALSE )
        {
            return ( $this->getExclusiveMatchList()->match( $strName ) );
        }
        else
        {
            if( $this->getIgnoredMatchList()->isEmpty() == FALSE )
            {
                if( $this->getIgnoredMatchList()->found( $strName ) )
                {
                    return FALSE;
                }
            }
        }
        return $this->getNotFoundValue();
    }

setExclusiveRuleMatch

(

RuleMatch $

objExclusiveRuleMatch

)

Parameters:

RuleMatch

$objExclusiveRuleMatch

Returns:

RuleMatchList me

Definition at line 88 of file RuleMatchList.class.php.

    {
        $this->objExclusiveRuleMatch = $objExclusiveRuleMatch;
        return $this;
    }

setIgnoredRuleMatch

(

RuleMatch $

objIgnoredRuleMatch

)

Definition at line 43 of file RuleMatchList.class.php.

    {
        $this->objIgnoredRuleMatch = $objIgnoredRuleMatch;
        return $this;
    }

setNotFoundValue

(

$

mixValue

)

Set the value what should be return when the name not be found into any list

Parameters:

mixer

$mixValue

Definition at line 134 of file RuleMatchList.class.php.

    {
        $this->mixNotFoundValue = $mixValue;
    }

---

Member Data Documentation

$mixNotFoundValue = TRUE [protected]

mixer

Definition at line 30 of file RuleMatchList.class.php.

$objExclusiveRuleMatch = null [protected]

RuleMatch

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

$objIgnoredRuleMatch = null [protected]

RuleMatch

Definition at line 18 of file RuleMatchList.class.php.

---

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

• components/ruleMatchList/RuleMatchList.class.php