ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilDidacticTemplateFilterPattern Class Reference

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 ilDB $ilDB. More...
 
 delete ()
 Delete pattern 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

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

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

33  {
34  $this->setPatternId($a_pattern_id);
35  if($this->getPatternId())
36  {
37  $this->read();
38  }
39  }
+ 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.

References setParentId(), and setPatternId().

227  {
228  $this->setParentId(0);
229  $this->setPatternId(0);
230  }
+ Here is the call graph for this function:

◆ delete()

ilDidacticTemplateFilterPattern::delete ( )

Delete pattern ilDB $ilDB.

Returns
bool

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

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

214  {
215  global $ilDB;
216 
217  $query = 'DELETE FROM didactic_tpl_fp '.
218  'WHERE pattern_id = '.$ilDB->quote($this->getPatternId(),'integer');
219  $ilDB->manipulate($query);
220  return true;
221  }
global $ilDB
+ 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.

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.

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.

References toXml(), and valid().

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

145  {
146  return $this->pattern;
147  }
+ Here is the call graph for this function:
+ 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.

References $pattern_id.

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

+ Here is the caller graph for this function:

◆ getPatternSubType()

ilDidacticTemplateFilterPattern::getPatternSubType ( )

◆ getPatterType()

ilDidacticTemplateFilterPattern::getPatterType ( )

Get pattern type.

Returns
int

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

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.

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

Referenced by __construct().

238  {
239  global $ilDB;
240 
241  $query = 'SELECT * FROM didactic_tpl_fp '.
242  'WHERE pattern_id = '.$ilDB->quote($this->getPatternId(),'integer');
243  $res = $ilDB->query($query);
244  while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
245  {
246  $this->setPatternType($row->pattern_type);
247  $this->setPatternSubType($row->pattern_sub_type);
248  $this->setPattern($row->pattern);
249  }
250  return void;
251  }
const DB_FETCHMODE_OBJECT
Definition: class.ilDB.php:11
global $ilDB
setPatternSubType($a_subtype)
Set pattern sub type.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ save()

ilDidacticTemplateFilterPattern::save ( )

Create new pattern ilDB $ilDB.

Returns
int

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

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

191  {
192  global $ilDB;
193 
194  $this->setPatternId($ilDB->nextId('didactic_tpl_fp'));
195  $query = 'INSERT INTO didactic_tpl_fp (pattern_id,pattern_type,pattern_sub_type,pattern,parent_id,parent_type) '.
196  'VALUES ( '.
197  $ilDB->quote($this->getPatternId(),'integer').', '.
198  $ilDB->quote($this->getPatterType(),'integer').', '.
199  $ilDB->quote($this->getPatternSubType(),'integer').', '.
200  $ilDB->quote($this->getPattern(),'text').', '.
201  $ilDB->quote($this->getParentId(),'integer').', '.
202  $ilDB->quote($this->getParentType(),'text').' '.
203  ')';
204  $ilDB->manipulate($query);
205  return $this->getPatternId();
206  }
global $ilDB
+ 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.

Referenced by __clone().

64  {
65  $this->parent_id = $a_id;
66  }
+ 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.

82  {
83  $this->parent_type = $a_type;
84  }

◆ setPattern()

ilDidacticTemplateFilterPattern::setPattern (   $a_pattern)

Set pattern.

Parameters
string$a_pattern

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

Referenced by read().

136  {
137  $this->pattern = $a_pattern;
138  }
+ 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.

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

46  {
47  $this->pattern_id = $a_id;
48  }
+ 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.

Referenced by read().

118  {
119  $this->pattern_sub_type = $a_subtype;
120  }
+ 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.

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

100  {
101  $this->pattern_type = $a_type;
102  }
+ Here is the caller graph for this function:

◆ toXml()

ilDidacticTemplateFilterPattern::toXml ( ilXmlWriter  $writer)
abstract

Get xml representation of pattern.

Parameters
ilXmlWriter$writer
Returns
void

Referenced by getPattern().

+ Here is the caller graph for this function:

◆ update()

ilDidacticTemplateFilterPattern::update ( )

Update pattern definition.

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

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

170  {
171  global $ilDB;
172 
173  $query = 'UPDATE didactic_tpl_fp '.
174  'SET '.
175  'pattern_type = '.$ilDB->quote($this->getPatterType(),'integer').', '.
176  'pattern_sub_type = '.$ilDB->quote($this->getPatternSubType(),'integer').' '.
177  'pattern = '.$ilDB->quote($this->getPattern(),'text').' '.
178  'parent_id = '.$ilDB->quote($this->getParentId(),'integer').', '.
179  'parent_type = '.$ilDB->quote($this->getParentType(),'text').', '.
180  'WHERE pattern_id = '.$ilDB->quote($this->getPatternId(),'integer');
181  $res = $ilDB->manipulate($query);
182  return void;
183  }
global $ilDB
+ Here is the call graph for this function:

◆ valid()

ilDidacticTemplateFilterPattern::valid (   $a_source)
abstract

Check if pattern matches.

Parameters
mixed
Returns
bool

Referenced by getPattern().

+ Here is the caller graph for this function:

Field Documentation

◆ $parent_id

ilDidacticTemplateFilterPattern::$parent_id = 0
private

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

Referenced by getParentId().

◆ $parent_type

ilDidacticTemplateFilterPattern::$parent_type = ''
private

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

Referenced by getParentType().

◆ $pattern_id

ilDidacticTemplateFilterPattern::$pattern_id = 0
private

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

Referenced by getPatternId().

◆ $pattern_sub_type

ilDidacticTemplateFilterPattern::$pattern_sub_type = 0
private

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

Referenced by getPatternSubType().

◆ $pattern_type

ilDidacticTemplateFilterPattern::$pattern_type = 0
private

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

Referenced by getPatterType().

◆ PATTERN_EXCLUDE

const ilDidacticTemplateFilterPattern::PATTERN_EXCLUDE = 2

◆ PATTERN_INCLUDE

const ilDidacticTemplateFilterPattern::PATTERN_INCLUDE = 1

◆ PATTERN_SUBTYPE_REGEX

const ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX = 1

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