openrat-cms

commit 4513ed2ffa65eb6c2cc1290fc9dc2b51ba47af6e
parent d7689a76c80cbf39eb40bb3364cca2c8bde44483
Author: Jan Dankert <devnull@localhost>
Date:   Mon,  8 Apr 2013 19:32:08 +0200

Dokumentation der Methoden, die in dynamischen Klassen zur Verfügung stehen.

Diffstat:
util/Dynamic.class.php
 | 
98
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------

1 file changed, 80 insertions(+), 18 deletions(-)
diff --git a/util/Dynamic.class.php b/util/Dynamic.class.php
@@ -33,80 +33,142 @@ class Dynamic
 	var $page;
 	var $parameters  = array();
 	var $description = '';
+
+	
+	/**
+	 * Ausführen des Makros. Diese Methode sollte durch die Unterklasse überschrieben werden.
+	 */
+	public function execute()
+	{
+		// overwrite this in subclasses
+	}
 	
 	
-	function db()
+	/**
+	 * Holt die aktuellen Datenbankverbindung.
+	 */
+	public function db()
 	{
 		return db_connection();
 	}
 
-	function getObjectId()
+	
+	/**
+	 * Holt die aktuelle Objekt-Id.
+	 * @return number
+	 */
+	public function getObjectId()
 	{
 		return $this->objectid;
 	}
 
-	function &getObject()
+	
+	/**
+	 * Holt das aktuelle Objekt.
+	 * @return Object
+	 */
+	public function &getObject()
 	{
 		return Session::getObject();
 	}
 
-	function setObjectId( $objectid )
+	
+	/**
+	 * Setzt eine Objekt-Id.
+	 * @param unknown_type $objectid
+	 */
+	public function setObjectId( $objectid )
 	{
 		$this->objectid = $objectid;
 	}
 
-	function getRootObjectId()
+	
+	/**
+	 * Ermittelt die Id des Wurzelordners im aktuellen Projekt. 
+	 */
+	public function getRootObjectId()
 	{
 		$project = Session::getProject();
 		return $project->getRootObjectId();
 	}
 
-	function folderid()
+	
+	/**
+	 * DO NOT USE.
+	 */
+	public function folderid()
 	{
 		global $SESS;
 		return $SESS['folderid'];
 	}
 
 
-	function execute()
-	{
-		// overwrite this in subclasses
-	}	
-	
-	function delOutput()
+	/**
+	 * Löscht die bisher erzeugte Ausgabe.
+	 */
+	public function delOutput()
 	{
 		$this->output = '';
 	}
 	
-	function output( $text )
+	/**
+	 * Ergänzt die Standardausgabe um den gewünschten Wert. 
+	 */
+	public function output( $text )
 	{
 		$this->output .= $text;
 	}
 
-	function outputLn( $text )
+	
+	/**
+	 * Ergänzt die Standardausgabe um den gewünschten Wert. Es wird ein Zeilenendezeichen ergänzt. 
+	 */
+	public function outputLn( $text )
 	{
 		$this->output .= $text."\n";
 	}
 
 
-	function getOutput()
+	/**
+	 * Ermittelt die bisher erstellte Ausgabe.
+	 * @return string
+	 */
+	public function getOutput()
 	{
 		return $this->output;
 	}
 	
-	function setSessionVar( $var,$value )
+	
+	/**
+	 * Setzt eine Sitzungsvariable.
+	 * 
+	 * @param String $var
+	 * @param Object $value
+	 */
+	public function setSessionVar( $var,$value )
 	{
 		Session::set( $var,$value );
 	}
 
 
-	function getSessionVar( $var )
+	/**
+	 * Ermittelt eine Sitzungsvariable.
+	 * 
+	 * @param String $var
+	 * @return string
+	 */
+	public function getSessionVar( $var )
 	{
 		return Session::get( $var );
 	}
 
 
-	function pathToObject( $obj )
+	
+	/**
+	 * Ermittelt den Pfad auf ein Objekt.
+	 * @param Objekt oder Objekt-Id
+	 */
+	public function pathToObject( $obj )
 	{
 		if	( is_object($obj) )
 			return $this->page->path_to_object($obj->objectid);