Represents a filter pattern for didactic template actions. More...

Inheritance diagram for ilDidacticTemplateFilterPattern:

Collaboration diagram for ilDidacticTemplateFilterPattern:

Public Member Functions
	__construct ($a_pattern_id=0)
	Constructor. More...

	setPatternId ($a_id)
	set pattern id More...

	getPatternId ()
	Get pattern id. More...

	setParentId ($a_id)
	Set parent id. More...

	getParentId ()
	Get parent id. More...

	setParentType ($a_type)
	Set parent type. More...

	getParentType ()
	Get parent type. More...

	setPatternType ($a_type)
	Set pattern type. More...

	getPatterType ()
	Get pattern type. More...

	setPatternSubType ($a_subtype)
	Set pattern sub type. More...

	getPatternSubType ()
	Get pattern sub type. More...

	setPattern ($a_pattern)
	Set pattern. More...

	getPattern ()
	Get pattern. More...

	valid ($a_source)
	Check if pattern matches. More...

	toXml (ilXmlWriter $writer)
	Get xml representation of pattern. More...

	update ()
	Update pattern definition. More...

	save ()
	Create new pattern @global ilDB $ilDB. More...

	delete ()
	Delete pattern @global ilDB $ilDB. More...

	__clone ()
	Magic clone method. More...

Data Fields
const	PATTERN_INCLUDE = 1

const	PATTERN_EXCLUDE = 2

const	PATTERN_SUBTYPE_REGEX = 1

Protected Member Functions
	read ()
	Read pattern definition from db. More...

Private Attributes
	$pattern_id = 0

	$parent_id = 0

	$parent_type = ''

	$pattern_type = 0

	$pattern_sub_type = 0

Detailed Description

Represents a filter pattern for didactic template actions.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateFilterPattern::__construct ( $a_pattern_id = 0 )

Constructor.

Parameters

int $a_pattern_id

Reimplemented in ilDidacticTemplateExcludeFilterPattern, and ilDidacticTemplateIncludeFilterPattern.

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

        {
                $this->setPatternId($a_pattern_id);
                if($this->getPatternId())
                {
                        $this->read();
                }
        }

References getPatternId(), read(), and setPatternId().

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilDidacticTemplateFilterPattern::__clone ( )

Magic clone method.

Definition at line 226 of file class.ilDidacticTemplateFilterPattern.php.

        {
                $this->setParentId(0);
                $this->setPatternId(0);
        }

References setParentId(), and setPatternId().

Here is the call graph for this function:

◆ delete()

ilDidacticTemplateFilterPattern::delete ( )

Delete pattern @global ilDB $ilDB.

Returns: bool

Definition at line 213 of file class.ilDidacticTemplateFilterPattern.php.

        {
                global $ilDB;
 
                $query = 'DELETE FROM didactic_tpl_fp '.
                        'WHERE pattern_id = '.$ilDB->quote($this->getPatternId(),'integer');
                $ilDB->manipulate($query);
                return true;
        }

References $ilDB, $query, and getPatternId().

Here is the call graph for this function:

◆ getParentId()

ilDidacticTemplateFilterPattern::getParentId ( )

Get parent id.

Returns: int

Definition at line 72 of file class.ilDidacticTemplateFilterPattern.php.

        {
                return $this->parent_id;
        }

References $parent_id.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getParentType()

ilDidacticTemplateFilterPattern::getParentType ( )

Get parent type.

Returns: string

Definition at line 90 of file class.ilDidacticTemplateFilterPattern.php.

        {
                return $this->parent_type;
        }

References $parent_type.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getPattern()

ilDidacticTemplateFilterPattern::getPattern ( )

Get pattern.

Returns: string

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

        {
                return $this->pattern;
        }

Referenced by save(), ilDidacticTemplateExcludeFilterPattern\toXml(), ilDidacticTemplateIncludeFilterPattern\toXml(), update(), ilDidacticTemplateExcludeFilterPattern\valid(), and ilDidacticTemplateIncludeFilterPattern\valid().

Here is the caller graph for this function:

◆ getPatternId()

ilDidacticTemplateFilterPattern::getPatternId ( )

Get pattern id.

Returns: int

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

        {
                return $this->pattern_id;
        }

References $pattern_id.

Referenced by __construct(), delete(), read(), save(), and update().

Here is the caller graph for this function:

◆ getPatternSubType()

ilDidacticTemplateFilterPattern::getPatternSubType ( )

Get pattern sub type.

Returns: int

Definition at line 126 of file class.ilDidacticTemplateFilterPattern.php.

        {
                return $this->pattern_sub_type;
        }

References $pattern_sub_type.

Referenced by save(), ilDidacticTemplateExcludeFilterPattern\toXml(), ilDidacticTemplateIncludeFilterPattern\toXml(), update(), ilDidacticTemplateExcludeFilterPattern\valid(), and ilDidacticTemplateIncludeFilterPattern\valid().

Here is the caller graph for this function:

◆ getPatterType()

ilDidacticTemplateFilterPattern::getPatterType ( )

Get pattern type.

Returns: int

Definition at line 108 of file class.ilDidacticTemplateFilterPattern.php.

        {
                return $this->pattern_type;
        }

References $pattern_type.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ read()

ilDidacticTemplateFilterPattern::read ( )

protected

Read pattern definition from db.

Returns: void

Definition at line 237 of file class.ilDidacticTemplateFilterPattern.php.

        {
                global $ilDB;
 
                $query = 'SELECT * FROM didactic_tpl_fp '.
                        'WHERE pattern_id = '.$ilDB->quote($this->getPatternId(),'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->setPatternType($row->pattern_type);
                        $this->setPatternSubType($row->pattern_sub_type);
                        $this->setPattern($row->pattern);
                }
                return void;
        }

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, getPatternId(), setPattern(), setPatternSubType(), and setPatternType().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilDidacticTemplateFilterPattern::save ( )

Create new pattern @global ilDB $ilDB.

Returns: int

Definition at line 190 of file class.ilDidacticTemplateFilterPattern.php.

        {
                global $ilDB;
 
                $this->setPatternId($ilDB->nextId('didactic_tpl_fp'));
                $query = 'INSERT INTO didactic_tpl_fp (pattern_id,pattern_type,pattern_sub_type,pattern,parent_id,parent_type) '.
                        'VALUES ( '.
                        $ilDB->quote($this->getPatternId(),'integer').', '.
                        $ilDB->quote($this->getPatterType(),'integer').', '.
                        $ilDB->quote($this->getPatternSubType(),'integer').', '.
                        $ilDB->quote($this->getPattern(),'text').', '.
                        $ilDB->quote($this->getParentId(),'integer').', '.
                        $ilDB->quote($this->getParentType(),'text').' '.
                        ')';
                $ilDB->manipulate($query);
                return $this->getPatternId();
        }

References $ilDB, $query, getParentId(), getParentType(), getPattern(), getPatternId(), getPatternSubType(), getPatterType(), and setPatternId().

Here is the call graph for this function:

◆ setParentId()

ilDidacticTemplateFilterPattern::setParentId ( $a_id )

Set parent id.

Parameters

int $a_id

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

        {
                $this->parent_id = $a_id;
        }

Referenced by __clone().

Here is the caller graph for this function:

◆ setParentType()

ilDidacticTemplateFilterPattern::setParentType ( $a_type )

Set parent type.

Parameters

string $a_type

Definition at line 81 of file class.ilDidacticTemplateFilterPattern.php.

        {
                $this->parent_type = $a_type;
        }

◆ setPattern()

ilDidacticTemplateFilterPattern::setPattern ( $a_pattern )

Set pattern.

Parameters

string $a_pattern

Definition at line 135 of file class.ilDidacticTemplateFilterPattern.php.

        {
                $this->pattern = $a_pattern;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setPatternId()

ilDidacticTemplateFilterPattern::setPatternId ( $a_id )

set pattern id

Parameters

int $a_id

Definition at line 45 of file class.ilDidacticTemplateFilterPattern.php.

        {
                $this->pattern_id = $a_id;
        }

Referenced by __clone(), __construct(), and save().

Here is the caller graph for this function:

◆ setPatternSubType()

ilDidacticTemplateFilterPattern::setPatternSubType ( $a_subtype )

Set pattern sub type.

Parameters

int $a_subtype

Definition at line 117 of file class.ilDidacticTemplateFilterPattern.php.

        {
                $this->pattern_sub_type = $a_subtype;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setPatternType()

ilDidacticTemplateFilterPattern::setPatternType ( $a_type )

Set pattern type.

Parameters

int $a_type

Definition at line 99 of file class.ilDidacticTemplateFilterPattern.php.

        {
                $this->pattern_type = $a_type;
        }

Referenced by ilDidacticTemplateExcludeFilterPattern\__construct(), ilDidacticTemplateIncludeFilterPattern\__construct(), and read().

Here is the caller graph for this function:

◆ toXml()

ilDidacticTemplateFilterPattern::toXml ( ilXmlWriter $writer )

abstract

Get xml representation of pattern.

Parameters

ilXmlWriter $writer

Returns: void

Reimplemented in ilDidacticTemplateExcludeFilterPattern, and ilDidacticTemplateIncludeFilterPattern.

◆ update()

ilDidacticTemplateFilterPattern::update ( )

Update pattern definition.

Definition at line 169 of file class.ilDidacticTemplateFilterPattern.php.

        {
                global $ilDB;
 
                $query = 'UPDATE didactic_tpl_fp '.
                        'SET '.
                        'pattern_type = '.$ilDB->quote($this->getPatterType(),'integer').', '.
                        'pattern_sub_type = '.$ilDB->quote($this->getPatternSubType(),'integer').' '.
                        'pattern = '.$ilDB->quote($this->getPattern(),'text').' '.
                        'parent_id = '.$ilDB->quote($this->getParentId(),'integer').', '.
                        'parent_type = '.$ilDB->quote($this->getParentType(),'text').', '.
                        'WHERE pattern_id = '.$ilDB->quote($this->getPatternId(),'integer');
                $res = $ilDB->manipulate($query);
                return void;
        }