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

Inheritance diagram for ilDidacticTemplateFilterPattern:

Collaboration diagram for ilDidacticTemplateFilterPattern:

Public Member Functions
	__construct (int $a_pattern_id=0)

	setPatternId (int $a_id)

	getPatternId ()

	setParentId (int $a_id)

	getParentId ()

	setParentType (string $a_type)

	getParentType ()

	setPatternType (int $a_type)

	getPatternType ()

	setPatternSubType (int $a_subtype)

	getPatternSubType ()

	setPattern (string $a_pattern)

	getPattern ()

	valid (string $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 Returns new pattern id. More...

	delete ()

	__clone ()

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...

Protected Attributes
ilDBInterface	$db

ilLogger	$logger

Private Attributes
int	$pattern_id = 0

int	$parent_id = 0

string	$parent_type = ''

string	$pattern = ''

int	$pattern_type = 0

int	$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 25 of file class.ilDidacticTemplateFilterPattern.php.

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateFilterPattern::__construct ( int $a_pattern_id = 0 )

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

References $DIC, getPatternId(), ILIAS\Repository\logger(), read(), and setPatternId().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->logger = $DIC->logger()->otpl();
 
         $this->setPatternId($a_pattern_id);
         if ($this->getPatternId()) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilDidacticTemplateFilterPattern::__clone ( )

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

References setParentId(), and setPatternId().

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

Here is the call graph for this function:

◆ delete()

ilDidacticTemplateFilterPattern::delete ( )

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

References getPatternId().

                             : void
     {
         $query = 'DELETE FROM didactic_tpl_fp ' .
             'WHERE pattern_id = ' . $this->db->quote($this->getPatternId(), 'integer');
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ getParentId()

ilDidacticTemplateFilterPattern::getParentId ( )

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

References $parent_id.

Referenced by save(), and update().

                                  : int
     {
         return $this->parent_id;
     }

Here is the caller graph for this function:

◆ getParentType()

ilDidacticTemplateFilterPattern::getParentType ( )

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

References $parent_type.

Referenced by save(), and update().

                                    : string
     {
         return $this->parent_type;
     }

Here is the caller graph for this function:

◆ getPattern()

ilDidacticTemplateFilterPattern::getPattern ( )

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

References $pattern, toXml(), and valid().

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

                                 : string
     {
         return $this->pattern;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPatternId()

ilDidacticTemplateFilterPattern::getPatternId ( )

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

References $pattern_id.

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

                                   : int
     {
         return $this->pattern_id;
     }

Here is the caller graph for this function:

◆ getPatternSubType()

ilDidacticTemplateFilterPattern::getPatternSubType ( )

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

References $pattern_sub_type.

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

                                        : int
     {
         return $this->pattern_sub_type;
     }

Here is the caller graph for this function:

◆ getPatternType()

ilDidacticTemplateFilterPattern::getPatternType ( )

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

References $pattern_type.

Referenced by save(), and update().

                                     : int
     {
         return $this->pattern_type;
     }

Here is the caller graph for this function:

◆ read()

ilDidacticTemplateFilterPattern::read ( )

protected

Read pattern definition from db.

Returns: void

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

References $res, ilDBConstants\FETCHMODE_OBJECT, getPatternId(), setPattern(), setPatternSubType(), and setPatternType().

Referenced by __construct().

                              : void
     {
         $query = 'SELECT * FROM didactic_tpl_fp ' .
             'WHERE pattern_id = ' . $this->db->quote($this->getPatternId(), 'integer');
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setPatternType((int) $row->pattern_type);
             $this->setPatternSubType((int) $row->pattern_sub_type);
             $this->setPattern($row->pattern);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilDidacticTemplateFilterPattern::save ( )

Create new pattern Returns new pattern id.

Returns: int

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

References getParentId(), getParentType(), getPattern(), getPatternId(), getPatternSubType(), getPatternType(), and setPatternId().

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

Here is the call graph for this function:

◆ setParentId()

ilDidacticTemplateFilterPattern::setParentId ( int $a_id )

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

Referenced by __clone().

                                           : void
     {
         $this->parent_id = $a_id;
     }

Here is the caller graph for this function:

◆ setParentType()

ilDidacticTemplateFilterPattern::setParentType ( string $a_type )

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

                                                  : void
     {
         $this->parent_type = $a_type;
     }

◆ setPattern()

ilDidacticTemplateFilterPattern::setPattern ( string $a_pattern )

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

Referenced by read().

                                                  : void
     {
         $this->pattern = $a_pattern;
     }

Here is the caller graph for this function:

◆ setPatternId()

ilDidacticTemplateFilterPattern::setPatternId ( int $a_id )

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

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

                                            : void
     {
         $this->pattern_id = $a_id;
     }

Here is the caller graph for this function:

◆ setPatternSubType()

ilDidacticTemplateFilterPattern::setPatternSubType ( int $a_subtype )

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

Referenced by read().

                                                      : void
     {
         $this->pattern_sub_type = $a_subtype;
     }

Here is the caller graph for this function:

◆ setPatternType()

ilDidacticTemplateFilterPattern::setPatternType ( int $a_type )

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

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

                                                : void
     {
         $this->pattern_type = $a_type;
     }

Here is the caller graph for this function:

◆ toXml()

ilDidacticTemplateFilterPattern::toXml ( ilXmlWriter $writer )

abstract

Get xml representation of pattern.

Parameters

ilXmlWriter $writer

Returns: string

Referenced by getPattern().

Here is the caller graph for this function:

◆ update()

ilDidacticTemplateFilterPattern::update ( )

Update pattern definition.

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

References $res, getParentId(), getParentType(), getPattern(), getPatternId(), getPatternSubType(), and getPatternType().

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