Die CatPageClass
Die CatPageClass kann mit global $CatPage; überall genutzt werden.Zu Beachten:
- Die übergebenden Werte $cat (Kategorie) und $page (Inhaltsseite) müssen UrlCodiert sein (wie im Dateisystem mit den %??)
Ansonsten braucht man sich um die Position, Endung, mit Link oder wie auch immer keine Gedanken zu machen
Beispiel:
catpage
catpage.txt
link-_blank-http://www.test.de
Das alles ist gültig - Wenn es nur um die $cat (Kategorie) geht wird $page mit false übergeben.
get_FirstCatPage()
Gibt die erste Inhaltsseite der ersten Kategorie zurück.
- Wenn im "Admin --> Einstellungen" "Als Standardseite für Kategorien, wenn es deren erste Inhaltsseite ist" aktiviert ist kann es auch eine versteckte Inhaltsseite sein
- Return:
array( Kategorie, Inhaltsseite ) wenn nicht gefunden array( "", "" )
get_FirstPageOfCat( $cat )
Gibt die erste Inhaltsseite der übergebenen $cat zurück.
- Wenn im "Admin --> Einstellungen" "Als Standardseite für Kategorien, wenn es deren erste Inhaltsseite ist" aktiviert ist kann es auch eine versteckte Inhaltsseite sein
- Return:
Inhaltsseite wenn nicht gefunden false
get_CatArray( $any = false, $showlink = true, $containspage = false )
Erzeugt ein array mit Kategorien.
- array ist ein durchnummeriertes array mit Kategorien in richtiger Reihenfolge
- Parameter:
- $anny:
wenn true werden alle Kategorien, egal welche, genommen.
$containspage wird übergangen - $showlink:
wenn false werden keine Links genommen - $containspage:
wenn es ein array ist, mit den Inhaltsseiten Status(en) die in der Kategorie enthalten sein muss, sonst wird die Kategorie nicht mitgenommen.
Der Status muss mit Punkt angegeben werden z.B. ".txt"
- $anny:
- Return:
ist immer ein array kann aber leer sein - Beispiele:
- get_CatArray() = alle Kategorien die mindestens eine Inhaltsseite oder Link haben
- get_CatArray(true) = alle Kategorien egal ob die Kategorie eine Inhaltsseite oder einen Link hat oder selber ein Link ist
- get_CatArray(false,true,array(".hid")) = alle Kategorien die mindestens eine Versteckte Inhaltsseite haben
- get_CatArray(false,false,array(".hid")) = alle Kategorien die mindestens eine Versteckte Inhaltsseite haben, die Kategorie darf kein Link sein
- get_CatArray(false,false,array(".hid",".lnk")) = alle Kategorien die mindestens eine Versteckte Inhaltsseite oder Link haben, die Kategorie darf kein Link sein
get_PageArray( $cat, $showext = false, $hidecatnamedpages = false )
Erzeugt ein array mit Inhaltsseiten
- array ist ein durchnummeriertes array mit Inhaltsseiten aus der mit $cat übergebenen Kategorie in richtiger Reihenfolge
- Parameter:
- $showext:
wenn es ein array ist, dann nur die Inhaltsseiten mit den Status(en)
Der Staus muss mit Punkt angegeben werden z.B. ".txt" - $hidecatnamedpages:
wenn true wird die im "Admin --> Einstellungen" "Legen Sie fest, ob Inhaltsseiten, die genau wie die Kategorie heißen, im Detailmenü versteckt werden sollen:" übergangen
- $showext:
- Return:
ist immer ein array kann aber leer sein - Beispiele:
- get_PageArray( $cat ) = alle Links und Inhaltsseiten mit dem Status "normal" und keine Inhaltsseiten die so lauten wie die Kategorie
- get_PageArray( $cat, false, true ) = alle Links und Inhaltsseiten mit dem Status "normal" und Inhaltsseiten die so lauten wie die Kategorie
- get_PageArray( $cat, array( ".hid" ) ) = nur Inhaltsseiten mit dem Status "versteckt" und keine Inhaltsseiten die so lauten wie die Kategorie, auch wenn sie den Status "versteckt" haben
- get_PageArray( $cat, array( ".hid", ".lnk" ), true ) = nur Inhaltsseiten mit dem Status "versteckt" und Links auch Inhaltsseiten die so lauten wie die Kategorie und den Staus "versteckt" haben
get_FileArray( $cat, $only_ext = false )
Erzeugt ein array mit Dateien einer Kategorie
- mit allen Dateien die in einer Kategorie im "dateien" Ordner sind
- Parameter:
- $only_ext:
wenn es ein array ist mit Dateiendungen, dann werden nur diese genommen.
Die Endung muss mit Punkt angegeben werden z.B. ".jpg", Gross/Kleinschreibung ist egal
- $only_ext:
- Return:
ist immer ein array kann aber leer sein - Beispiele:
- get_FileArray( $cat ) es werden alle Datein genommen
- get_FileArray( $cat, array( ".png", ".jpg" ) ) es werden nur Dateien mit der Endung ".png" und ".jpg" genommen
get_FileType( $file )
Gibt die Dateiendung einer Datei
- $file muss Name/Pfad der Datei sein
- Return:
Dateiendung, wenn keine Dateiendung gefunden wurde false
create_LinkTag( $url, $urltext, $css = false, $titel = false, $target = false, $id = false )
Erzeugt einen HTML Link
- Parameter:
- $url:
Die URL für den href - $urltext:
Der Link Text
- $url:
- Optionale Parameter:
- $css:
Der CSS Class Name oder false - $titel:
Der Titel für das title Attribut oder false - $target:
Target "_self" oder "_blank" oder false - $id:
Der id Name oder false
- $css:
- Return:
Ein HTML a Tag
create_ActionLinkTag( $action,$cssprefix = "" )
Erzeugt eine Link mit der Aktion search oder sitemap
- Parameter:
- $action:
search oder sitemap - $cssprefix:
Class Namen die verwendet werden sollen
- $action:
- Return:
Der Action Link oder NULL
create_AutoLinkTag( $cat, $page, $css )
Erzeugt einen mozilo HTML Link
- Benutzt die Kategorie und Inhaltsseite für das Titel und href Attribut sowie den Link Text
- Parameter:
- $css:
Der CSS Class Name, wenn die Kategorie oder Inhaltsseite aktiv ist wird ein "active" angehängt
- $css:
- Return:
Ein HTML a Tag
get_CssActiv( $cat, $page, $activtext = "active" )
Gibt CSS active zurück
- Prüft ob die Kategorie oder Inhaltsseite aktiv ist wenn ja wird der $activtext zurückgegeben ansonsten nichts
- Parameter:
- $activtext:
Default active
- $activtext:
- Return:
activtext oder leerer String
get_AsKeyName( $name, $change_chars = false )
Gibt nur den Namen zurück
- ohne Position, Endung oder Links
- Parameter:
- $change_chars:
Wandelt Sonderzeichen nach %??. Achtung nur benutzen wenn nötig, wegen der Geschwindigkeit
- $change_chars:
- Return:
Name - Beispiele:
- get_AsKeyName( "01_MeineCatPage" ) = MeineCatPage
- get_AsKeyName( "01_MeineCatPage.txt" ) = MeineCatPage
- get_AsKeyName( "01_MeinLink-_blank-http://www.link.de" ) = MeinLink
is_ParaString( $name )
Auf Text Prüfen.
- Prüft ob $name ein Text ist. Nur ein Leerzeichen ist kein Text
- Return:
true oder false
get_UrlCoded( $name, $protectUrlChr = false )
Gibt $name Url codiert zurück.
- z.B. "Über uns" wird zu "%C3%9Cber%20uns"
- Parameter:
- $protectUrlChr:
Bei true werden alle "%3A","%2F","%3F","%26","%3D" und "%23" nach ":","/","?","&","=" und "#" gewandelt
- $protectUrlChr:
- Return:
Name
get_FileSystemName( $cat, $page )
Gibt die Kategorie oder Inhaltsseite Dateisystemkonform zurück.
- Return:
Kategorie, Inhaltsseite oder false wenn nicht existiert
split_CatPage_fromSyntax( $syntax_catpage , $file = false )
Liefert array( Kategorie, Inhaltsseite/Datei ) zurück.
- Erzeugt aus dem Text Kategorie:Inhaltsseite/Datei, wie es in Syntaxelementen benutzt wird, ein array() mit den Kategorie Namen und Inhaltsseiten/Datei Namen.
- Parameter:
- $file:
muss true sein bei einer Datei
- $file:
- Return:
array( Kategorie, Inhaltsseite/Datei)
exists_CatPage( $cat, $page )
Prüft ob die Kategorie oder Inhaltsseite existiert.
- Return:
true oder false
is_Protectet( $cat, $page )
Prüft ob die Kategorie oder Inhaltsseite Password geschützt ist.
- Return:
true oder false
set_Protectet( $cat,$page,$status = true )
Setzen des Password Schutzes
- Parameter:
- $status:
true = Password Schutzes oder false = nicht Geschutzt
- $status:
- Return:
true oder false
exists_File( $cat, $file )
Prüft ob die Datei existiert.
- Return:
true oder false
get_Type( $cat, $page )
Gibt den Type der Kategorie oder Inhaltsseite zurück.
- Return:
Kategorie: cat oder .lnk
Inhaltsseite: .txt .hid .lnk oder .tmp
get_Time( $cat, $page )
Gibt den Timestamp der letzten Änderung der Kategorie oder Inhaltsseite zurück.
- Return:
Timestamp
get_Query( $query = false )
Gibt Default den $_SERVER['QUERY_STRING'] zurück.
- Bei Angabe von $query werden die beiden verglichen und doppelte Einträge entfernt. Alle & werden nach $amp; gewandelt
- Parameter:
- $query:
Text mit & oder $amp;
- $query:
- Return:
Text
get_Href( $cat, $page, $request = false )
Erzeugt eine URL von Kategorie und Inhaltsseite.
- in Abhängigkeit von $CMS_CONF->get("modrewrite") und hängt bei bedarf $request an. Wenn $cat und $page false sind oder nicht existieren wird index.php benutzt. Alle & werden nach $amp; gewandelt
- Parameter:
- $request:
Text mit & oder $amp;
- $request:
- Return:
Text
get_HrefFile( $cat, $datei )
Erzeugt eine download.php URL.
- und Prüft ob die Datei existiert
- Return:
Text existiert die Datei nicht false
get_srcFile( $cat, $file, $twice = false )
Erstelt eine URL für alle HTML Tags die src= verwenden.
- und Prüft ob die Datei existiert. Bei Browser Plugins wie z.B. Flashplayer solte $twice true sein
- Parameter:
- $twice:
Wenn true werden alle % mit %25 esetzt
- $twice:
- Return:
Text existiert die Kategorie oder Inhaltsseite nicht false
get_pfadFile( $cat,$file )
Gibt die Datei Dateisystemkonform zurück.
- Return:
Text existiert die Datei nicht false
get_FileText( $cat, $file )
Gibt den Namen der Datei HTML Komform zurück.
- Return:
Text existiert die Date nicht NULL
get_HrefTarget( $cat, $page )
Gibt den Target der Kategorie oder Inhaltsseite zurück.
- Return:
_self, _blank wenn Kategorie oder Inhaltsseite kein Link ist false
get_HrefText( $cat, $page )
Gibt den Namen der Kategorie oder Inhaltsseite HTML Komform zurück.
- Return:
Text existiert die Kategorie oder Inhaltsseite nicht NULL
is_Activ( $cat, $page )
Prüft ob die Kategorie oder Inhaltsseite die grade Aufgerufene ist.
- Return:
Wenn Aktiv true ansonsten false
change_Name( $cat, $page, $newname )
Ändert den Namen von der Kategorie oder Inhaltsseite.
- im CatPageArray für get_HrefText().
- Parameter:
- $newname:
Nur Text oder Sonderzeichen keine Codierten Sonderzeichen
- $newname:
- Return:
Bei Erfolg true ansonsten false
unchange_Name( $cat, $page )
Stelt den Original Namen von der Kategorie oder Inhaltsseite wieder her.
- im CatPageArray
- Return:
Bei Erfolg true ansonsten false
delete_Cat( $cat )
Löscht die Kategorie
- im CatPageArray inklusive aller Inhaltsseiten und Dateien.
- Return:
Bei Erfolg true ansonsten false
delete_Page( $cat, $page )
Löscht die Inhaltsseite.
- im CatPageArray.
- Return:
Bei Erfolg true ansonsten false
undelete_Cat( $cat, $includepage = true )
Stelt die Kategorie wieder her
- im CatPageArray, Inhaltsseiten und Dateien wieder herstellen.
- Parameter:
- $includepage:
Wenn false werden die Inhaltsseiten nicht wieder hergestellt
- $includepage:
- Return:
Bei Erfolg true ansonsten false
undelete_Page( $cat, $page )
Stellt die Inhaltsseite wieder her.
- im CatPageArray
- Return:
Bei Erfolg true ansonsten false
get_PageContent( $cat, $page, $for_syntax = false, $convert_content = false )
Gibt den Inhalt einer Inhaltsseite zurück.
- Die Syntax und Plug-in-Elemente werden bei bedarf aufgelöst.
Der Status Protect wird berücksichtigt.
Bei Erfolg wird der Inhaltsseiten Inhalt zurückgegeben ansonsten false
- Parameter:
- $for_syntax:
Wenn true dann wird aus der Syntax.php preparePageContent() benutzt - $convert_content:
Wenn true dann wird aus der Syntax.php convertContent() in Abhängikeit von $for_syntax benutzt
- $for_syntax:
- Return:
Text oder false
make_DummyCat( $cat )
Erzeugt eine Temporäre Kategorie.
- Parameter:
- $cat:
Muss nicht URL Codiert sein
- $cat:
- Return:
Bei Erfolg true ansonsten false
make_DummyPage( $cat,$page,$type = EXT_PAGE,$content = false )
Erzeugt eine Temporäre Inhaltsseite.
- Parameter:
- $cat, $page:
Muss nicht URL Codiert sein - $type:
EXT_PAGE, EXT_HIDDEN oder EXT_DRAFT. Default ist EXT_PAGE. - $content:
Optinal der Inhalt der Inhaltsseite.
- $cat, $page:
- Return:
Bei Erfolg true ansonsten false