MatchGatekeeper Class Reference

Inheritance diagram for MatchGatekeeper:

List of all members.

Public Member Functions
	__construct ()
	setForbidenMatch (Match $objForbidenMatch)
	getForbiddenMatch ()
	setAllowedMatch (Match $objAllowedMatch)
	getAllowedMatch ()
	setNotFoundValue ($objValue)
	getNotFoundValue ()
	setDeniedValue ($objValue)
	getDeniedValue ()
	match ($strName)
	found ($strName)
Protected Attributes
	$objForbidenMatch
	$objAllowedMatch
	$objNotFoundValue = true
	$objDeniedValue = false

---

Detailed Description

Thiago Henrique Ramos da Mata <thiago.henrique.mata@gmail.com>

Since:

2009-06-12

Gate opener make a match using white list , with the allowed names and black list, with the forbiden names.

Example:

   $objMatch = new MatchGatekeeper();
   $objMatch->getAllowedMatch()->addItemName( "just" );
   $objMatch->getAllowedMatch()->addItemName( "us" );
         if ( $objMatch->match( "other" ) !== false ) return false;
   return true;

returns

 true 

Example:

   $objMatch = new MatchGatekeeper();
   $objMatch->getForbiddenMatch()->addItemRegularExpression( "^set*" );
   $objMatch->getForbiddenMatch()->addItemRegularExpression( "^get*" );
   $objMatch->getForbiddenMatch()->addItemName( "play" );
         if ( $objMatch->match( "setSomething" ) !== false ) return false;
         if ( $objMatch->match( "getSomething" ) !== false ) return false;
         if ( $objMatch->match( "play" ) !== false ) return false;
         if ( $objMatch->match( "other" ) !== true) return false;
   return true;

returns

 true 

Definition at line 35 of file MatchGatekeeper.class.php.

---

Constructor & Destructor Documentation

__construct

(

)

constructor create the class matchs

Definition at line 68 of file MatchGatekeeper.class.php.

    {
        $this->objForbidenMatch = new MatchGroup();
        $this->objAllowedMatch = new MatchGroup();
    }

---

Member Function Documentation

found

(

$

strName

)

Found the string name

Parameters:

string

$strName

Returns:

object <value>

Implements MatchInterface.

Definition at line 210 of file MatchGatekeeper.class.php.

References getAllowedMatch(), and getForbiddenMatch().

Referenced by match().

    {
         // if forbidden list exists //
        if( $this->getForbiddenMatch()->isEmpty() == false )
        {
            // if is forbidden //
            if( $this->getForbiddenMatch()->found( $strName ) )
            {
                // return false //
                return false;
            }
        }
        // if allowed restriction list exists //
        if( $this->getAllowedMatch()->isEmpty() == false )
        {
            // if is allowed //
            if( $this->getAllowedMatch()->found( $strName ) )
            {
                // return true //
                return true;
            }
        }
        // the element was not founded in any list //
        return false;
    }

getAllowedMatch

(

)

Get the allowed list match

Returns:

MatchGroup

Definition at line 113 of file MatchGatekeeper.class.php.

Referenced by found(), match(), and setNotFoundValue().

    {
        return $this->objAllowedMatch;
    }

getDeniedValue

(

)

Get the value of a name into the forbidden list

Returns:

object <value>

Definition at line 161 of file MatchGatekeeper.class.php.

Referenced by match().

    {
        return $this->objDeniedValue;
    }

getForbiddenMatch

(

)

get the forbiden list match

Returns:

MatchGroup

Definition at line 91 of file MatchGatekeeper.class.php.

Referenced by found(), match(), and setNotFoundValue().

    {
        return $this->objForbidenMatch;
    }

getNotFoundValue

(

)

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

Returns:

object <value>

Implements MatchInterface.

Definition at line 139 of file MatchGatekeeper.class.php.

Referenced by match().

    {
        return $this->objNotFoundValue;
    }

match

(

$

strName

)

Match the string name

Parameters:

string

$strName

Returns:

object <value>

Implements MatchInterface.

Definition at line 172 of file MatchGatekeeper.class.php.

References found(), getAllowedMatch(), getDeniedValue(), getForbiddenMatch(), and getNotFoundValue().

    {
        // if forbidden list exists //
        if( $this->getForbiddenMatch()->isEmpty() == false )
        {
            // if is forbidden //
            if( $this->getForbiddenMatch()->found( $strName ) )
            {
                // return denied value //
                return $this->getDeniedValue();
            }
        }
        // if allowed restriction list exists //
        if( $this->getAllowedMatch()->isEmpty() == false )
        {
            // if is allowed //
            if( $this->getAllowedMatch()->found( $strName ) )
            {
                // return the allowed value //
                return $this->getAllowedMatch()->match( $strName );
            }
            else
            {
                // else return the denied value //
                return $this->getDeniedValue();
            }
        }
        // else return the not found value //
        return $this->getNotFoundValue();
    }

setAllowedMatch

(

Match $

objAllowedMatch

)

Set the allowed list match

Parameters:

Match

$objAllowedMatch

Returns:

MatchGatekeeper me

Definition at line 102 of file MatchGatekeeper.class.php.

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

setDeniedValue

(

$

objValue

)

Set the value of a name into the forbidden list

Parameters:

object

$objValue

Returns:

MatchGatekeeper

Definition at line 150 of file MatchGatekeeper.class.php.

    {
        $this->objDeniedValue = $objValue;
        return $this;
    }

setForbidenMatch

(

Match $

objForbidenMatch

)

Definition at line 80 of file MatchGatekeeper.class.php.

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

setNotFoundValue

(

$

objValue

)

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

Parameters:

object

$objValue

Returns:

MatchGatekeeper

Implements MatchInterface.

Definition at line 125 of file MatchGatekeeper.class.php.

References getAllowedMatch(), and getForbiddenMatch().

    {
        $this->objNotFoundValue = $objValue;
        $this->getAllowedMatch->setNotFoundValue( $objValue );
        $this->getForbiddenMatch->setNotFoundValue( $objValue );
        return $this;
    }

---

Member Data Documentation

$objAllowedMatch [protected]

Match Group of the Allowed List

MatchGroup

Definition at line 49 of file MatchGatekeeper.class.php.

$objDeniedValue = false [protected]

Value what should return when the name match into the forbiden list

Definition at line 63 of file MatchGatekeeper.class.php.

$objForbidenMatch [protected]

Match Group of the Forbidden List

MatchGroup

Definition at line 42 of file MatchGatekeeper.class.php.

$objNotFoundValue = true [protected]

Value what should return when the name dont match with the allowed list even with the forbiden list

object

Definition at line 57 of file MatchGatekeeper.class.php.

---

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

• components/match/MatchGatekeeper.class.php