dokumentation vervollständigt

src/class.StringBuilder.php

@@ -146,33 +146,33 @@ class StringBuilder {
     }
 
     /**
-     * 
-     * @return string 
+     * Abfrage des aktuell gesetzten Prefix der Variablenbezeichnungen.
+     * @return string Prefix der Variablenbezeichnungen
      */
     public function getVarPrefix() : string {
         return $this->varPrefix;
     }
 
     /**
-     * 
-     * @return string 
+     * Abfrage des aktuell gesetzten Suffix der Variablenbezeichnungen
+     * @return string Suffix der Variablenbezeichnungen
      */
     public function getVarSuffix() : string {
         return $this->varSuffix;
     }
 
     /**
-     * 
-     * @return array 
+     * Abfrage aller Teile im StringBilder, aus welchem sich der String zusammensetzen wird.
+     * @return array Alle Teile aus welchem sich der Strin zusammensetzen wird.
      */
     public function getParts() : array {
         return $this->parts;
     }
 
     /**
-     * 
-     * @param array $parts 
-     * @return StringBuilder 
+     * Ersetzt/Setzt alle aktuellen Teile, aus welchen sich der String zusammensetzen wird.
+     * @param array $parts Teile aus welchen sich der String zusammensetzen wird
+     * @return StringBuilder $this
      */
     public function setParts(array $parts=[]) : StringBuilder {
         $this->parts = $parts;
@@ -180,9 +180,9 @@ class StringBuilder {
     }
 
     /**
-     * 
-     * @param string $part 
-     * @return StringBuilder 
+     * Einen Teil am Ende des Strings hinzufügen.
+     * @param string $part Teil des Strings welches hinzugefügt werden soll
+     * @return StringBuilder $this
      */
     public function append(string $part, bool $trim=false) : StringBuilder {
         if($trim) $part = trim($part);
@@ -193,9 +193,9 @@ class StringBuilder {
     }
 
     /**
-     * 
-     * @param string $part 
-     * @return StringBuilder 
+     * Einen Teil am Ende des Strings hinzufügen, sofern nicht berits an beliebiger Stelle vorhanden.
+     * @param string $part Teil des Strings welches hinzugefügt werden soll
+     * @return StringBuilder $this
      */
     public function appendUnique(string $part, bool $trim=false) : StringBuilder {
         if($trim) $part = trim($part);
@@ -206,9 +206,9 @@ class StringBuilder {
     }
 
     /**
-     * 
-     * @param string $part 
-     * @return StringBuilder 
+     * Einen Teil am Anfang des Strings hinzufügen.
+     * @param string $part Teil des Strings welches hinzugefügt werden soll
+     * @return StringBuilder $this
      */
     public function prepend(string $part, bool $trim=false) : StringBuilder {
         if($trim) $part = trim($part);
@@ -219,9 +219,9 @@ class StringBuilder {
     }
 
     /**
-     * 
-     * @param string $part 
-     * @return StringBuilder 
+     * Einen Teil am Anfang des Strings hinzufügen, sofern nicht berits an beliebiger Stelle vorhanden.
+     * @param string $part Teil des Strings welches hinzugefügt werden soll
+     * @return StringBuilder $this
      */
     public function prependUnique(string $part, bool $trim=false) : StringBuilder {
         if($trim) $part = trim($part);
@@ -233,26 +233,24 @@ class StringBuilder {
 
 
     /**
-     * 
-     * @param string $seperator 
-     * @return string 
+     * Alle Teile zu einem String zusammenfügen.
+     * @return string Zusammengesetzter gesamt String
      */
     public function join() : string {
         return implode($this->getSeperator(), $this->parts);
     }
 
     /**
-     * 
-     * @param string $seperator 
-     * @return string 
+     * Alle Teile zu einem String zusammenfügen, wärend doppelt vorkommende Teile nicht erneut vorkommen.
+     * @return string Zusammengesetzter gesamt String
      */
     public function joinUnique() : string {
         return implode($this->getSeperator(), array_unique($this->parts));
     }
 
     /**
-     * 
-     * @return string 
+     * Alle Teile zu einem String zusammenfügen, und dann variablen im gesamt String ersetzen.
+     * @return string Gesamt-String mit Variablen ersetzt.
      */
     public function render() : string {
         $tpl = $this->join();