RuleNameMatch Class Reference

List of all members.

Public Member Functions
	setNotFoundValue ($mixNotFoundedValue)
	getNotFoundedValue ()
	setNameList ($arrNameList)
	getNameList ()
	addName ($strName, $mixValue=TRUE)
	found ($strName)
	isEmpty ()
	match ($strName)
Protected Attributes
	$arrNameList = array()
	$arrValueList = array()
	$mixNotFoundedValue = FALSE

---

Detailed Description

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

---

Member Function Documentation

addName	(	$	strName,
		$	mixValue = TRUE
	)

Add a class name into the name list

See also:

RuleMatchList->arrNameList

RuleMatchList::setNameList( String[] )

RuleMatchList::getNameList()

Parameters:

string

$strName

Returns:

RuleNameMacth me

Definition at line 101 of file RuleNameMatch.class.php.

    {
        $intKeyName = sizeof( $this->arrNameList );
        $this->arrNameList[ $intKeyName ] = $strName;
        $this->arrValueList[ $intKeyName ] = $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 116 of file RuleNameMatch.class.php.

    {
        if ( in_array( $strName , $this->arrNameList ) )
        {
            return TRUE;
        }
        else
        {
            return FALSE;
        }
    }

getNameList

(

)

get the array with the name list into the match

See also:

RuleMatchList->arrNameList

RuleMatchList::setNameList( String[] )

Returns:

String[] $arrNameList

Definition at line 87 of file RuleNameMatch.class.php.

    {
        return $this->arrNameList;
    }

getNotFoundedValue

(

)

Get the not founded value

See also:

RuleNameMatch->mixNotFoundedValue

RuleNameMatch::setNotFoundValue( mixer )

Returns:

mixer $mixNotFoundedValue

Definition at line 61 of file RuleNameMatch.class.php.

Referenced by match().

    {
        return $this->mixNotFoundedValue;
    }

isEmpty

(

)

Returns if the rule is empty

Returns:

boolean

Definition at line 133 of file RuleNameMatch.class.php.

    {
        return ( sizeof( $this->arrNameList ) == 0 );
    }

match

(

$

strName

)

Match the string name

Parameters:

string

$strName

Returns:

boolean

Definition at line 144 of file RuleNameMatch.class.php.

References getNotFoundedValue().

    {
        $intKeyFound = array_search( $strName , $this->arrNameList );
        if( $intKeyFound !== FALSE )
        {
            $mixReturn = $this->arrValueList[ $intKeyFound ];
        }
        else
        {
            $mixReturn = $this->getNotFoundedValue();
        }
        return $mixReturn;
    }

setNameList

(

$

arrNameList

)

Set the array with the name list into the match

See also:

RuleMatchList->arrNameList

RuleMatchList::getNameList()

Parameters:

String[]

$arrNameList

Returns:

RuleNameMatch me

Definition at line 74 of file RuleNameMatch.class.php.

References $arrNameList.

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

setNotFoundValue

(

$

mixNotFoundedValue

)

Set the not founded value

See also:

RuleNameMatch->mixNotFoundedValue

RuleNameMatch::getNotFoundValue()

Parameters:

mixer

$mixNotFoundedValue

Returns:

RuleNameMatch

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

References $mixNotFoundedValue.

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

---

Member Data Documentation

$arrNameList = array() [protected]

Array with the string name list what should be match

If is empty, anyone can enter.

string[]

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

Referenced by setNameList().

$arrValueList = array() [protected]

array with the values of the match if founded

array

Definition at line 29 of file RuleNameMatch.class.php.

$mixNotFoundedValue = FALSE [protected]

value of the match when the element not be found into the name list

Default: false

mixer

Definition at line 38 of file RuleNameMatch.class.php.

Referenced by setNotFoundValue().

---

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

• components/ruleMatchList/RuleNameMatch.class.php