Template Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	Template ($templateid='')
	getAll ()
	load ()
	save ()
	getTemplateIdsByValue ($text)
	getElementIds ()
	getElements ()
	getWritableElements ()
	getElementNames ()
	addElement ($name, $description='', $type='text')
	add ($name='')
	getDependentObjectIds ()
	delete ()
	mimeType ()
Öffentliche Attribute
	$templateid = 0
	$projectid = 0
	$name = 'unnamed'
	$modelid = 0
	$extension = ''
	$src = ''

---

Ausführliche Beschreibung

Definiert in Zeile 81 der Datei Template.class.php.

---

Dokumentation der Elementfunktionen

Template::add

(

$

name = ''

)

Hinzufuegen eines Templates

Parameter:

String

Name des Templates (optional)

Definiert in Zeile 376 der Datei Template.class.php.

Benutzt $db, $name, db_connection() und Session::getProject().

     {
          if   ( !empty($name) )
               $this->name = $name;

          $db = db_connection();

          $sql = new Sql('SELECT MAX(id) FROM {t_template}');
          $this->templateid = intval($db->getOne($sql->query))+1;

          $sql = new Sql( 'INSERT INTO {t_template}'.
                          ' (id,name,projectid)'.
                          ' VALUES({templateid},{name},{projectid})' );
          $sql->setInt   ('templateid',$this->templateid   );
          $sql->setString('name'      ,$name               );

          // Wenn Projektid nicht vorhanden, dann aus Session lesen
          if   ( !isset($this->projectid) || intval($this->projectid) == 0 )
          {
               $project = Session::getProject();
               $this->projectid = $project->projectid;
          }

          $sql->setInt   ('projectid' ,$this->projectid );

          $db->query( $sql->query );
     }

Template::addElement	(	$	name,
		$	description = '',
		$	type = 'text'
	)

Hinzuf?gen eines Elementes

Parameter:

String

Name des Elementes

Definiert in Zeile 359 der Datei Template.class.php.

Benutzt $name.

     {
          $element = new Element();
          $element->name       = $name;
          $element->desc       = $description;
          $element->type       = $type;
          $element->templateid = $this->templateid;
          $element->wiki       = true;
          $element->writable   = true;
          $element->add();
     }

Template::delete

(

)

Loeschen des Templates

Entfernen alle Templateinhalte und des Templates selber

Definiert in Zeile 426 der Datei Template.class.php.

Benutzt $db, db_connection() und getElementIds().

     {
          $db = db_connection();
          
          foreach( $this->getElementIds() as $elementid )
          {
               $element = new Element( $elementid );
               $element->delete();
          }

          $sql = new Sql( 'DELETE FROM {t_templatemodel}'.
                          ' WHERE templateid={templateid}' );
          $sql->setInt( 'templateid',$this->templateid );
          $db->query( $sql->query );

          $sql = new Sql( 'DELETE FROM {t_template}'.
                          ' WHERE id={templateid}' );
          $sql->setInt( 'templateid',$this->templateid );
          $db->query( $sql->query );
     }

Template::getAll

(

)

Ermitteln aller Templates in dem aktuellen Projekt.

Rückgabe:

Array mit Id:Name

Definiert in Zeile 136 der Datei Template.class.php.

Benutzt $db, $SESS, db_connection() und Session::getProject().

Wird benutzt von TemplateAction::add(), PageAction::changetemplate(), FolderAction::create(), FolderAction::createpage(), TemplateAction::listing(), PageAction::prop(), ElementAction::properties() und ProjectTree::templates().

     {
          global $SESS;
          $db = db_connection();

          $sql = new Sql( 'SELECT id,name FROM {t_template}'.
                          ' WHERE projectid={projectid}'.
                          ' ORDER BY name ASC '  );
          if   ( isset($this->projectid) )
               $sql->setInt( 'projectid',$this->projectid   );
          else
          {
               $project = Session::getProject();
               $sql->setInt( 'projectid',$project->projectid );
          }

          return $db->getAssoc( $sql->query );
     }

Template::getDependentObjectIds

(

)

Ermitteln alles Objekte (=Seiten), welche auf diesem Template basieren

Rückgabe:

Array Liste von Objekt-IDs

Definiert in Zeile 409 der Datei Template.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();

          $sql = new Sql( 'SELECT objectid FROM {t_page}'.
                          '  WHERE templateid={templateid}' );
          $sql->setInt( 'templateid',$this->templateid );

          return $db->getCol( $sql->query );
     }

Template::getElementIds

(

)

Ermitteln aller Elemente zu diesem Template Es wird eine Liste nur mit den Element-IDs ermittelt und zur?ckgegeben

Rückgabe:

Array

Definiert in Zeile 263 der Datei Template.class.php.

Benutzt $db und db_connection().

Wird benutzt von delete().

     {
          $db = db_connection();

          $sql = new Sql( 'SELECT id FROM {t_element}'.
                          '  WHERE templateid={templateid}'.
                          '  ORDER BY name ASC' );
          $sql->setInt( 'templateid',$this->templateid );
          return $db->getCol( $sql->query );
     }

Template::getElementNames

(

)

Ermitteln aller Elemente zu diesem Template Es wird eine Liste mit den Element-Namen zur?ckgegeben

Rückgabe:

Array

Definiert in Zeile 342 der Datei Template.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();

          $sql = new Sql( 'SELECT id,name FROM {t_element}'.
                          '  WHERE templateid={templateid}'.
                          '  ORDER BY name ASC' );
          $sql->setInt( 'templateid',$this->templateid );

          return $db->getAssoc( $sql->query );
     }

Template::getElements

(

)

Ermitteln aller Elemente zu diesem Template Es wird eine Liste mit den kompletten Elementen ermittelt und zurueckgegeben

Rückgabe:

Array

Definiert in Zeile 281 der Datei Template.class.php.

Benutzt $db und db_connection().

     {
          $list = array();
          $db = db_connection();

          $sql = new Sql( 'SELECT * FROM {t_element}'.
                          '  WHERE templateid={templateid}'.
                          '  ORDER BY name ASC' );
          $sql->setInt( 'templateid',$this->templateid );
          foreach( $db->getAll( $sql->query ) as $row )
          {
               $e = new Element( $row['id'] );
               $e->setDatabaseRow( $row );
               
               $list[$e->elementid] = $e;
               unset($e);
          }
          return $list;
     }

Template::getTemplateIdsByValue

(

$

text

)

Es werden Templates mit einem Inhalt gesucht

Parameter:

String

Suchbegriff

Rückgabe:

Array Liste der gefundenen Template-IDs

Definiert in Zeile 243 der Datei Template.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();

          $sql = new Sql( 'SELECT templateid FROM {t_templatemodel}'.
                          ' WHERE text LIKE {text} '.
                          '   AND projectmodelid={modelid}' );

          $sql->setInt   ( 'modelid',$this->modelid );
          $sql->setString( 'text'   ,'%'.$text.'%'  );
          
          return $db->getCol( $sql->query );
     }

Template::getWritableElements

(

)

Ermitteln aller Elemente zu diesem Template Es wird eine Liste mit den kompletten Elementen ermittelt und zurueckgegeben

Rückgabe:

Array

Definiert in Zeile 308 der Datei Template.class.php.

Benutzt $db und db_connection().

     {
          $list = array();
          $db = db_connection();

          $sql = new Sql( <<<SQL
SELECT * FROM {t_element}
  WHERE templateid={templateid}
    AND writable=1
    AND type NOT IN ({readonlyList})
  ORDER BY name ASC
SQL
);
          $sql->setInt       ( 'templateid'  ,$this->templateid        );
          $e = new Element();
          $sql->setStringList( 'readonlyList',$e->readonlyElementNames );
          foreach( $db->getAll( $sql->query ) as $row )
          {
               $e = new Element( $row['id'] );
               $e->setDatabaseRow( $row );
               
               $list[$e->elementid] = $e;
               unset($e);
          }
          return $list;
     }

Template::load

(

)

Laden des Templates aus der Datenbank und f?llen der Objekteigenschaften

Definiert in Zeile 159 der Datei Template.class.php.

Benutzt $db, $SESS und db_connection().

     {
          global $SESS;
          $db = db_connection();

          $sql = new Sql( 'SELECT * FROM {t_template}'.
                          ' WHERE id={templateid}' );
          $sql->setInt( 'templateid',$this->templateid );
          $row = $db->getRow( $sql->query );

          $this->name      = $row['name'     ];
          $this->projectid = $row['projectid'];

          $sql = new Sql( 'SELECT * FROM {t_templatemodel}'.
                          ' WHERE templateid={templateid}'.
                          '   AND projectmodelid={modelid}' );
          $sql->setInt( 'templateid',$this->templateid );
          $sql->setInt( 'modelid'   ,$this->modelid    );
          $row = $db->getRow( $sql->query );

          if   ( isset($row['extension']) )
          {
               $this->extension = $row['extension'];
               $this->src       = $row['text'];
          }
          
     }

Template::mimeType

(

)

Ermittelt den Mime-Type zu diesem Template

Rückgabe:

String Mime-Type

Definiert in Zeile 453 der Datei Template.class.php.

Benutzt $conf und $extension.

     {
          global $conf;
          $mime_types = $conf['mime-types'];

          $extension = strtolower($this->extension);

          if   ( !empty($mime_types[$extension]) )
               $this->mime_type = $mime_types[$extension];
          else
               // Wenn kein Mime-Type gefunden, dann Standartwert setzen
               $this->mime_type = 'application/octet-stream';
               
          return( $this->mime_type );
     }

Template::save

(

)

Abspeichern des Templates in der Datenbank

Definiert in Zeile 191 der Datei Template.class.php.

Benutzt $db, db_connection() und lang().

     {
          if   ( $this->name == "" )
               $this->name = lang('GLOBAL_TEMPLATE').' #'.$this->templateid;

          $db = db_connection();

          $sql = new Sql( 'UPDATE {t_template}'.
                          '  SET name={name}'.
                          '  WHERE id={templateid}' );
          $sql->setString( 'name'      ,$this->name       );
          $sql->setInt   ( 'templateid',$this->templateid );
          $db->query( $sql->query );

          $sql = new Sql( 'SELECT COUNT(*) FROM {t_templatemodel}'.
                          ' WHERE templateid={templateid}'.
                          '   AND projectmodelid={modelid}' );
          $sql->setInt   ( 'templateid'    ,$this->templateid     );
          $sql->setInt   ( 'modelid'       ,$this->modelid );

          if   ( intval($db->getOne($sql->query)) > 0 )
          {         
               $sql = new Sql( 'UPDATE {t_templatemodel}'.
                               '  SET extension={extension},'.
                               '      text={src} '.
                               ' WHERE templateid={templateid}'.
                               '   AND projectmodelid={modelid}' );
          }
          else
          {
               $sql = new Sql('SELECT MAX(id) FROM {t_templatemodel}');
               $nextid = intval($db->getOne($sql->query))+1;
               $sql = new Sql( 'INSERT INTO {t_templatemodel}'.
                               '        (id,templateid,projectmodelid,extension,text) '.
                               ' VALUES ({id},{templateid},{modelid},{extension},{src}) ');
               $sql->setInt   ( 'id',$nextid         );
          }

          $sql->setString( 'extension'     ,$this->extension      );
          $sql->setString( 'src'           ,$this->src            );
          $sql->setInt   ( 'templateid'    ,$this->templateid     );
          $sql->setInt   ( 'modelid'       ,$this->modelid        );
          
          $db->query( $sql->query );
     }

Template::Template

(

$

templateid = ''

)

Definiert in Zeile 120 der Datei Template.class.php.

Benutzt $templateid, Session::getProject() und Session::getProjectModel().

     {
          $model   = Session::getProjectModel();
          $project = Session::getProject();
          $this->modelid   = $model->modelid;
          $this->projectid = $project->projectid;

          if   ( is_numeric($templateid) )
               $this->templateid = $templateid;
     }

---

Dokumentation der Datenelemente

Template::$extension = ''

Dateierweiterung dieses Templates (abh?ngig von der Projektvariante) String

Definiert in Zeile 111 der Datei Template.class.php.

Wird benutzt von mimeType().

Template::$modelid = 0

ID der Projektvariante Integer

Definiert in Zeile 105 der Datei Template.class.php.

Template::$name = 'unnamed'

Logischer Name String

Definiert in Zeile 99 der Datei Template.class.php.

Wird benutzt von add() und addElement().

Template::$projectid = 0

Projekt-ID des aktuell ausgew?hlten Projektes Integer

Definiert in Zeile 93 der Datei Template.class.php.

Template::$src = ''

Inhalt des Templates (abh?ngig von der Projektvariante) String

Definiert in Zeile 117 der Datei Template.class.php.

Template::$templateid = 0

ID dieses Templates Integer

Definiert in Zeile 87 der Datei Template.class.php.

Wird benutzt von Template().

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• objectClasses/Template.class.php