Die GalleryClass

Um die GalleryClass benutzen zu können muss sie erst eingebunden werden.
Anleitung:

class MeinPlugin extends Plugin {
    var $GalleryClass;
für $GalleryClass kann man sich auch was anders ausdenken z.B. $gc

in der function getContent($value) {
include_once($BASE_DIR."cms/"."GalleryClass.php");
$this->GalleryClass = new GalleryClass();

Zu dem jetzigen Zeitpunk existiert nur $this->GalleryClass->GalleriesArray mit allen Galerie Ordnern alerdings ohne Prüfung des Inhalts.

Als nächstes Initialisiert man die Galerie(n) die man benuzen möchte mit $this->GalleryClass->initial_Galleries().
Dies erstellt das $this->GalleryArray mit dem in den functionen gearbeitet wird.

Wenn man ein Menü braucht muss es auch erst Initialisiert werden mit $this->GalleryClass->initial_GalleryMenu().
Dies erstellt das $this->MenuArray mit dem in den functionen gearbeitet wird.

Default Bilder die benutzt werden: .jpg, .jpeg, .jpe, .gif, .png und .svg
Die Liste kann mit z.B. $this->GalleryClass->allowed_pics = array(".gif", ".png"); geändert werden

$Galleries = Eine Galerie als Text, ein array mit Galerien oder false für $this->currentGallery.
Die Galerien müssen wie sie im Dateisystem stehen eingegeben werden also mit %??.

$gallery = mit %?? oder false für $this->currentGallery
$image = mit %?? und extension


initial_Galleries(  $Galleries = false, $allowed_pics = false, $with_preview = false, $with_description = false  )
ACHTUNG initial_Galleries muss ausgeführt werden damit die nachfolgenden Funktionen verfügbar sind.
  • Hier werden die Variablen ($this->GalleryArray, $this->allowed_pics und $this->currentGallery) erzeugt mit denen intern gearbeitet wird.
    Achtung aus Geschwindigkeitsgründen sollten die Parameter mit Bedacht benutzt werden.
  • Parameter:
    • $allowed_pics:
      Ein array mit den erlaubten Bildendungen, Gross/Kleinschreibung ist egal sowie mit oder ohne Punkt, das Default $this->allowed_pics array wird mit diesen gesetzt, false es wird $this->allowed_pics benutzt
    • $with_preview:
      true Vorschaubilder benutzen, false keine Vorschaubilder benutzen
    • $with_description:
      true Bildbeschreibungen benutzen, false keine Bildbeschreibungen benutzen.
      Das kann mit $this->initial_GallerieDescription() auch Später Erfolgen
  • Return:
    true Initialisierung erfolgreich false Fehlgeschlagen

initial_GallerieDescription( $gallery = false )
Erzeugt die Bildbeschreibungen einer Galerie wenn dies nicht schon mit initial_Galleries() erledigt wurde.
  • $gallery:
    Galerie oder false ist gleich $this->currentGallery

get_RequestGalery()
Gibt die über die URL übergebene Galerie Dateisystemkonform zurück.
  • außerdem wird geprüft, ob die Galerie existiert
  • Return:
    Text oder false

sort_Galleries(  $sort_type = false, $flag = false  )
Sortiert die Galerien
  • Sollte nur bei mehreren Galerien benutzt werden.
    Der $flag wird nur bei sort, rsort, ksort und krsort verwendet.
    ksort und krsort sind die schnellsten, da direkt sortiert wird.
    Es ist auch möglich Galerien, die mit einer Zahl beginnen als Gruppe zu betrachten und an den Anfang oder das Ende der Galerien zu setzen.
    Mehr Infos zu den $flag siehe PHP Beschreibung von sort(), auch zu jeweilligen Sortierungsarten gibt es da mehr Infos.
  • Parameter:
    • $sort_type:
      Es gibt ksort, krsort, sort, rsort, natcasesort, rnatcasesort, natsort, rnatsort und none
      ksort und krsort stehen für sich und sind mit number_ nicht möglich.
      none gibt es nur in Verbindung mit number_.
      Um Galerien, die mit einer Zahl beginnen, als Gruppe zu sortieren setzt sich der $sort_type so zusammen
      number_(first oder last)_($sort_type Zahlen Galerie)_($sort_type alle anderen Galerien)
      z.B. number_first_sort_sort
    • $flag:
      false (Default) = SORT_REGULAR
      numeric = SORT_NUMERIC
      string = SORT_STRING
      locale = SORT_LOCALE_STRING
  • Return:
    kein Return

sort_Images(  $Galleries = false, $sort_type = false, $flag = false  )
Bilder einer Galerie sortieren
  • Der $flag wird nur bei sort, rsort, ksort und krsort verwendet.
    ksort und krsort sind die schnellsten, da direkt sortiert wird.
    Es ist auch möglich Bilder die mit einer Zahl beginnen als Gruppe zu betrachten und an den Anfang oder das Ende der Bilder zu setzen.
    Mehr Infos zu den $flag siehe PHP Beschreibung von sort(), auch zu jeweiligen Sortierungsarten gibt es da auch mehr Infos.
  • Parameter:
    • $sort_type:
      Es gibt ksort, krsort, sort, rsort, natcasesort, rnatcasesort, natsort, rnatsort und none
      ksort und krsort stehen für sich und sind mit number_ nicht möglich.
      none gibt e s nur in Verbindung mit number_.
      Um Bilder, die mit einer Zahl beginnen, als Gruppe zu sortieren setzt sich der $sort_type so zusammen
      number_(first oder last)_($sort_type Zahlen Bilder)_($sort_type alle anderen Bilder)
      z.B. number_first_sort_sort
    • $flag:
      false (Default) = SORT_REGULAR
      numeric = SORT_NUMERIC
      string = SORT_STRING
      locale = SORT_LOCALE_STRING
  • Return:
    kein Return

get_GalleriesArray()
Erzeugt ein Array mit allen Galerien.
  • Die Sortierung wird beibehalten.
  • Return:
    Ist immer ein Array

get_GalleryImagesArray(  $gallery = false  )
Erzeugt ein Array mit allen Bildern einer Galerie.
  • Die Sortierung wird beibehalten.
  • Return:
    Ist immer ein Array

get_ImageDescription(  $gallery = false, $image, $coded_as = false  )
Holt die Bildbeschreibung eines Bildes.
  • Parameter:
    • $coded_as:
      html als HTML formatierter Text
      url als URL (%??) formatierter Text
      false nicht formatierter
  • Return:
    Text oder NULL

get_ImagePath(  $gallery = false, $image, $preview = false  )
Erzeugt den Dateisystempfad des Bildes/Vorschaubildes.
  • ohne Prüfung auf Existenz
  • Parameter:
    • $preview:
      false das Bild
      true das Vorschaubild
  • Return:
    Text

get_ImageSrc(  $gallery = false, $image, $preview = false  )
Erzeugt den URL Pfad für alle HTML Tags die src= benutzen des Bildes/Vorschaubildes
  • ohne Prüfung auf Existenz
  • Parameter:
    • $preview:
      false das Bild
      true das Vorschaubild
  • Return:
    Text

get_ImageType(  $image  )
Gibt die Endung des Bildes zurück.
  • mit Punkt
  • Return:
    Endung mit Punkt oder false wenn keine Endung gefunden wurde

get_GalleryName(  $gallery = false  )
Gibt den Galerie Namen HTML-konform zurück.
  • Return:
    Text

initial_GalleryMenu(  $gallery = false, $cols = false, $rows = false  )
ACHTUNG initial_GalleryMenu muss ausgeführt werden, damit die nachfolgenden Funktionen verfügbar sind.
  • Hier werden die Variablen ($this->currentIndex, $this->currentGroup, $this->MenuArray, $this->Cols, $this-> und $this->Rows) erzeugt mit denen Intern gearbeitet wird.
  • Parameter:
    • $cols:
      Anzahl der Spalten oder false ist Zeilen durch Bilder aufgerundet
    • $rows:
      Anzah der Zeilen oder false ist Spalten durch Bilder aufgerundet
      Wenn $cols und $rows false sind dann eine Zeile mit allen Bildern
  • Return:
    Kein Return

set_currentGroupIndexFromRequest()
Setzt anhand der URL Parameter die $this->currentIndex und $this->currentGroup
  • Return:
    Kein Return

get_Href(  $preview = false, $index = false, $group = false  )
Erzeugt einen Bild Pfad URL-konform
  • wie er z.B. im a Tag href= verwendet wird
  • Parameter:
    • $preview:
      false das Bild
      true das Vorschaubild
  • Return:
    Text

get_Src(  $preview = false, $index = false, $group = false  )
Erzeugt einen Bild Pfad Tag-konform
  • wie er z.B. im img Tag src= verwendet wird
  • Parameter:
    • $preview:
      false das Bild
      true das Vorschaubild
  • Return:
    Text

get_HtmlName(  $index = false, $group = false  )
Erzeugt den Bildnamen HTML-konform
  • Return:
    Text

get_Name(  $index = false, $group = false  )
Gibt den Bildnamen zurück
  • wie er im Dateisystem steht
  • Return:
    Text


get_Description(  $coded_as = false, $index = false, $group = false  )
Holt die Bildbeschreibung aus der conf
  • Parameter:
    • $coded_as:
      false wie es in der conf steht
      html HTML-konform
      url URL-konform (%??)
  • Return:
    Text oder wenn es keine gibt false

get_GalIndexGroupUrl(  $index_group  )
Erzeugt eine URL mit den erforderlichen Request Parametern
  • mit den gal=, index=, group= und galtemplate=true Request Parametern.
    group= wird nur gesetzt, wenn es mehrere Guppen gibt und galtemplate=true wird erzeugt, wenn $this->GalleryTemplate true ist
  • Parameter:
    • $index_group_array: index oder ein array(index,group)
  • Return:
    Text

get_firstIndex()
Die erste Indexnummer der ersten Gruppe
  • Return:
    array( $index, $group )

get_lastIndex()
Die letzte Indexnummer der letzten Gruppe
  • Return:
    array( $index, $group )

get_nextIndex(  $circular = true  )
Die nächste Indexnummer
  • auch wenn der Index in der nächsten Gruppe ist
  • Parameter:
    • $circular:
      Bei true wird rotiert (von vorne begonnen)
  • Return:
    array( $index, $group )

get_previousIndex(  $circular = true  )
Die vorhergende Indexnummer
  • auch wenn der Index in der vorhergenden Gruppe ist
  • Parameter:
    • $circular:
      Bei true wird rotiert (von hinten begonnen)
  • Return:
    array( $index, $group )

get_firstGroup()
Die erste Gruppe
  • Return:
    array( $index, $group )

get_lastGroup()
Die letzte Gruppe
  • Return:
    array( $index, $group )

get_firstIndexFromGroup(  $group = false  )
Die erste Indexnummer der Gruppe
  • Return:
    array( $index, $group )

get_lastIndexFromGroup(  $group = false  )
Die letzte Indexnummer der Gruppe
  • Return:
    array( $index, $group )

get_nextGroup(  $circular = true  )
Die nächste Gruppe
  • Parameter:
    • $circular:
      Bei true wird rotiert (von vorne begonnen)
  • Return:
    array( $index, $group )

get_previousGroup(  $circular = true  )
Die vorhergende Gruppe
  • Parameter:
    • $circular:
      Bei true wird rotiert (von hinten begonnen)
  • Return:
    array( $index, $group )

get_currentIndexArray(  $group = false  )
Alle Indexnummern der Gruppe als Array
  • Return:
    array()

get_fromIndexGroupImage(  $group = false, $index = false  )
Anhand von der Index und Gruppennummer den Bildnamen holen
  • Dateisystemkonform holen
  • Return:
    Text Bildnamen Dateisystemkonform

create_ImgTag(  $alt = false, $css = false, $preview = false, $index = false, $group = false  )
Erzeugt ein HTML img Tag
  • Parameter:
    • $alt:
      Wenn angegeben wird der Alt Text HTML-konform gewandelt
      Bei false wird zuerst die Bildbeschreibung genommen, wenn es die nicht gibt, der Bildname
    • $css:
      Wenn angegeben wird eine class=$css erzeugt
    • $preview:
      false das Bild
      true das Vorschaubild
  • Return:
    Text

is_Activ(  $index  )
Ist die Indexnummer die Aktive
  • Achtung es muss eine Indexnummer übergeben werden.
  • Return:
    true oder false

get_CssActiv(  $index, $activtext = "active"  )
Gibt CSS activ zurück
  • Prüft ob die Indexnummer aktiv ist, wenn ja wird der $activtext zurückgegeben ansonsten nichts. Achtung es muss eine Indexnummer übergeben werden.
  • Parameter:
    • $activtext:
      Default active
  • Return:
    activtext oder leerer string

get_CssGroupActiv(  $group, $activtext = "active"  )
Gibt CSS activ zurück
  • Prüft ob die Gruppennummer aktiv ist, wenn ja wird der $activtext zurückgegeben ansonsten nichts. Achtung es muss eine Gruppennummer übergeben werden.
  • Parameter:
    • $activtext:
      Default active
  • Return:
    activtext oder leerer string

get_ColsRowsArray(  $group = false  )
Erzeugt ein Array mit Zeilen und Spalten der Indexnummern
  • Wenn es in der Letzten Zeile weniger Indexnummern als Spalten gibt werden sie mit false gefüllt
  • Return:
    Array