MatchGroup Class Reference

Inheritance diagram for MatchGroup:

List of all members.

Public Member Functions
	__construct ()
	setMatchName (MatchName $objMatchName)
	getMatchName ()
	setMatchRegularExpression (MatchRegularExpression $objMatchName)
	getMatchRegularExpression ()
	setNotFoundValue ($objNotFoundValue)
	getNotFoundValue ()
	addItemName ($strItemName, $objValue=null)
	addItemRegularExpression ($strItemRegex, $objValue=null)
	match ($strName)
	found ($strName)
	isEmpty ()
Protected Attributes
	$objMatchName
	$objMatchRegularExpression
	$objNotFoundValue = false

---

Detailed Description

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

---

Constructor & Destructor Documentation

__construct

(

)

constructor of the group

Definition at line 59 of file MatchGroup.class.php.

    {
        $this->objMatchName = new MatchName();
        $this->objMatchRegularExpression = new MatchRegularExpression();
    }

---

Member Function Documentation

addItemName	(	$	strItemName,
		$	objValue = null
	)

proxy to add item into the match name

Parameters:

	string	$strItemName
	object	$objValue

Returns:

MatchGroup

Definition at line 140 of file MatchGroup.class.php.

References getMatchName().

    {
        $this->getMatchName()->addItem( $strItemName , $objValue );
        return $this;
    }

addItemRegularExpression	(	$	strItemRegex,
		$	objValue = null
	)

proxy to add item into the match regular expression

Parameters:

	string	$strItemRegex
	object	$objValue

Returns:

MatchGroup

Definition at line 153 of file MatchGroup.class.php.

References getMatchRegularExpression().

    {
        $this->getMatchRegularExpression()->addItem( $strItemRegex , $objValue );
        return $this;
    }

found

(

$

strName

)

Found the name into the match group

Parameters:

string

$strName

Returns:

boolean

Implements MatchInterface.

Definition at line 185 of file MatchGroup.class.php.

References getMatchName(), and getMatchRegularExpression().

Referenced by match().

    {
        return
        (
            ( $this->getMatchName()->found( $strName ) )
        ||
            ( $this->getMatchRegularExpression()->found( $strName ) )
        );
    }

getMatchName

(

)

Get the match name

Returns:

MatchName $objMatchName

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

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

    {
        return $this->objMatchName;
    }

getMatchRegularExpression

(

)

Get the match regular expression

Returns:

MatchName $objMatchRegularExpression

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

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

    {
        return $this->objMatchRegularExpression;
    }

getNotFoundValue

(

)

Get the not found value

Returns:

object

$objValue

Implements MatchInterface.

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

Referenced by match().

    {
        return $this->objNotFoundValue;
    }

isEmpty

(

)

Inform if the match inside the group are empty

Returns:

boolean

Definition at line 200 of file MatchGroup.class.php.

References getMatchName(), and getMatchRegularExpression().

    {
        return
        (
            ( $this->getMatchName()->isEmpty() )
        &&
            ( $this->getMatchRegularExpression()->isEmpty() )
        );
    }

match

(

$

strName

)

Match the string name

See also:

MatchName::match( string )

MatchRegularExpression::match( string )

Returns:

object <value>

Implements MatchInterface.

Definition at line 166 of file MatchGroup.class.php.

References found(), getMatchName(), getMatchRegularExpression(), and getNotFoundValue().

    {
        if( $this->getMatchName()->found( $strName ) )
        {
            return $this->getMatchName()->match( $strName );
        }
        if( $this->getMatchRegularExpression()->found( $strName ) )
        {
            return $this->getMatchRegularExpression()->match( $strName );
        }
        return $this->getNotFoundValue();
    }

setMatchName

(

MatchName $

objMatchName

)

Set the match name

Parameters:

MatchName

$objMatchName

Returns:

Match

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

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

setMatchRegularExpression

(

MatchRegularExpression $

objMatchName

)

Set the match regular expression

Parameters:

MatchName

$objMatchRegularExpression

Returns:

MatchGroup

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

References $objMatchRegularExpression.

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

setNotFoundValue

(

$

objNotFoundValue

)

Set the not found value

Parameters:

object

$objValue

Returns:

MatchGroup

Implements MatchInterface.

Definition at line 115 of file MatchGroup.class.php.

References $objNotFoundValue, getMatchName(), and getMatchRegularExpression().

    {
        $this->objNotFoundValue = $objNotFoundValue;
        $this->getMatchName()->setNotFoundValue( $objNotFoundValue );
        $this->getMatchRegularExpression()->setNotFoundValue( $objNotFoundValue );
        return $this;
    }

---

Member Data Documentation

$objMatchName [protected]

Match Name of the group

MatchName

Definition at line 39 of file MatchGroup.class.php.

$objMatchRegularExpression [protected]

Match Regular Expression of the group

MatchName

Definition at line 46 of file MatchGroup.class.php.

Referenced by setMatchRegularExpression().

$objNotFoundValue = false [protected]

Object to be return when the received <name> unmatch in the match() method

object

Definition at line 54 of file MatchGroup.class.php.

Referenced by setNotFoundValue().

---

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

• components/match/MatchGroup.class.php