manae
/
PHP-StringBuilder
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

dokumentation vervollständigt

This commit is contained in:
Marcel Naeve 2024-04-20 17:37:04 +02:00
parent 9dae115ad4
commit 039fd102ae
Signed by: manae
GPG Key ID: 3BB68BF9EA669981
1 changed files with 27 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
src/class.StringBuilder.php
View File

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