SideBarMenu

Datenklassen

Benutzer

Aktuellen Benutzer finden

User::findCurrent();

Wert aus der Benutzer-Konfiguration auslesen

$wert = UserConfig::get(User::findCurrent()->id)->getValue('WERT_NAME');

Wert in der Benutzer-Konfiguration speichern

UserConfig::get(User::findCurrent()->id)->store('WERT_NAME', $wert);

WICHTIG: $wert wird standardmäßig als String gespeichert, sofern nichts anderes in der Config-Tabelle angegeben ist! Arrays sollten vorher mit json_encode(studip_utf8encode($array)); kodiert werden!

Prüfen, ob ein Benutzer Administrator ist

$perm->have_perm('admin')

Liefert true zurück, wenn der Benutzer entweder 'root'- oder 'admin'-Berechtigungen hat, ansonsten false.

SimpleORMap

Veranstaltungen

Courses (/lib/models/Course.class.php)

Archivierte Veranstaltungen

ArchivedCourses (/lib/models/ArchivedCourse.class.php)

Dozenten

User-Klasse, alle Objekte, bei welchen das Attribut "perms" auf "dozent" gesetzt ist.

Benutzer

User (/lib/models/User.class.php), Erweiterung von AuthUserMd5, welche die Grunddaten (z.B. Vorname, Nachname, Benutzername) eines Benutzers enthält.

Controller-relevante Klassen

URLs

URL erzeugen

URLHelper::getLink('dispatch.php/CONTROLLER);, wobei CONTROLLER der aufzurufende Controller ist.

WICHTIG: getLink ändert URLS so ab, sodass diese in HTML-Code eingebettet werden können. Beispielsweise wird aus & ein &. Will man diese Umwandlung nicht, sollte URLHelper::getURL(); verwendet werden.

URL-Erzeugung im Plugin

PluginEngine::getLink(PLUGIN, PARAMETER, PFAD);, PLUGIN = $this->plugin (im Controller) oder $plugin (im Template), PARAMETER = assoziatives Array, PFAD = Pfad zum Controller)

WICHTIG: getLink ändert URLS so ab, sodass diese in HTML-Code eingebettet werden können. Beispielsweise wird aus & ein &. Will man diese Umwandlung nicht, sollte PluginEngine::getURL(); verwendet werden.

Sobald man sich in einer Trails-App befindet, sollte allerdings die Controller-Methode url_for() genutzt werden, welche den obigen Aufruf kapselt und vereinfacht.

Icon-Erzeugung

Icon::create(SYMBOL, KATEGORIE)->asImg(GRÖßE);, SYMBOL = das anzuzeigende Symbol, KATEGORIE = farbliche Einordnung des Symbols (z.B. "clickable"), GRÖßE = Angabe in Pixeln (z.B. "12px")

URL-Parameter "dauerhaft" machen

Um einen Parameter beim Aufruf der nächsten Seite mitgeben zu können, verwendet man die Methode addLinkParam von URLHelper:

URLHelper::addLinkParam('name', WERT);

An die URL wird nun der Parameter name mit dem Wert WERT angehängt (z.B.: http://example.org?name=WERT).

Darstellung

Navigationselemente

Navigationselement auf der Startseite hinzufügen

<?php
$navigation = new Navigation('LINKBESCHREIBUNG', 'EINE_URL'); //Erzeugen des Navigationselementes mit einem passenden Text und der gewünschten URL
Navigation::addItem('/start/ID', $navigation); //ID = eindeutige Bezeichnung des Navigationselementes. /start/ muss auf jeden Fall dorthin, damit das Element auf der Startseite angezeigt wird

Reiternavigation (Tabs) erzeugen

<?php
$navigation = new Navigation('LINKBESCHREIBUNG', 'EINE_URL');
Navigation::addItem('/ID', $navigation); //ID = eindeutiger Pfad. Dieser liegt in der "Wurzel", also nicht unterhalb anderer Pfade wie z.B. /start/

In dem Controller, welcher über obiges Navigationselement erreichbar ist, muss das Navigationselement aktiviert werden:

<?php
Navigation::activateItem('/ID');

Hinweis: Natürlich sind auch hier Unterpfade, z.B. /ID/NOCHEINEID möglich.

Icon in Reiternavigation einfügen

Beim Hinzufügen von Icons in die Reiternavigation muss beachtet werden, dass das Icon eines aktiven Reiters eine andere Farbe hat als das Icon eines inaktiven Reiters. Deshalb muss der Wechsel des Icons bei der Aktivierung eines Reiters durchgeführt werden.

Definition des Reiters in der Navigationsstruktur:

<?php
$navigation = new Navigation(
    'Text',
    PluginEngine::getUrl('ein/link')
    );
$navigation->setImage(Icon::create('edit', 'info_alt'));
Navigation::addItem('/navigations/pfad', $navigation);

Damit wurde ein Reiter mitsamt Icon definiert. "info_alt" bezeichnet nach aktuellem Stand (2016-07-27) eine weiße Icon-Farbe. Um das Icon in einem aktiven Reiter anders zu färben, aktiviert man diesen und setzt das Icon neu:

<?php
if(Navigation::hasItem('/navigations/pfad')) {
    $nav = Navigation::getItem('/navigations/pfad');
    $nav->setImage(Icon::create('assessment', 'info'));
    Navigation::activateItem('/navigations/pfad');
}

Damit wird der Farbwechsel beim Aktivieren (Besuchen) und Deaktivieren (Verlassen) eines Reiters durchgeführt.

Hinweistexte

Möglichkeiten für Hinweistexte:

  • MessageBox::error -> Fehlermeldungen
  • MessageBox::info -> Informationen
  • MessageBox::warning -> Warnmeldungen (aber keine Fehler)
  • MessageBox::success -> Erfolgsbestätigungen (Aktionen, die erfolgreich abgeschlossen wurden)

Mehr Informationen: Messagebox

Hinweistexte vom Controller heraus ausgeben

<?php
PageLayout::postMessage(MessageBox::error(_('Fehler!')));

Mehr zu PageLayout: PageLayout

Sidebar

Navigations-Bereich hinzufügen

<?php
$navigation = new NavigationWidget();
$navigation->setTitle('Titel des Bereiches');

//hier wird ein Link hinzugefügt:
$navigation->addLink(
    'Ein Linktitel',
    PluginEngine::getLink($this->plugin, array(),
    'show')
    );

Sidebar::Get()->addWidget($navigation); //Navigations-Bereich in die Sidebar einhängen

Link auf Dialog im ActionsWidget hinzufügen

<?php
$actions = new ActionsWidget();
$actions->addLink('Beschreibung',
                URLHelper::getLink('dispatch.php/CONTROLLER'),
                Icon::create(SYMBOL, KATEGORIE)
                )->asDialog();

CONTROLLER ist der aufzurufende Controller, SYMBOL das ausgewählte Symbol, dessen Farbe durch die Kategorie KATEGORIE gesetzt wird. Mit der Methode asDialog() (Klasse LinkElement in /lib/classes/sidebar) wird das HTML-Attribut "data-dialog" beim Erstellen des HTML-Codes des Links gesetzt.

Schnellsuche (Suche mit Drop-Down-Menü) zu einem Suchfeld der Sidebar hinzufügen

<?php
$searchWidget = new SearchWidget(PluginEngine::getLink($this->plugin, array(), 'search'));
$searchWidget->setTitle(_('Suche'));
$searchWidget->setMethod('post');

$sqlSearch = new SQLSearch("SELECT auth_user_md5.user_id as userId FROM auth_user_md5 " .
    "WHERE ((vorname like CONCAT('%', :input, '%') " .
    "OR (nachname like CONCAT('%', :input, '%')) ",
    _('Benutzername')
    );

//QuickSearch zum SearchWidget hinzufügen:
$searchWidget->addNeedle(
    _('Benutzername'),
    'userId',
    _('Benutzername'),
    $sqlSearch
    );
 

Mehr zu QuickSearch: QuickSearch

Templates

Button erzeugen

<?= \Studip\Button::create(_('Speichern')); ?>

Button für Dialog erzeugen

<div data-dialog-button>
    <?= \Studip\Button::create(_('Speichern')); ?>
</div>

Plugins

Herausfinden, ob ein anderes Plugin aktiviert ist

Dies ist z.B. sinnvoll, wenn ein Plugin von einem anderen Plugin oder dessen Klassen abhängig ist. Folgender Code prüft, ob ein anderes Plugin aktiviert ist:

$pluginManager = PluginManager::getInstance();
$pluginManager->getPluginInfo('AnderesPlugin');
//$pluginManager enthält nun Daten über das gesuchte andere Plugin.
if ($pluginManager['enabled']) {
    //das andere Plugin ist angeschaltet: Nun können z.B. Klassen dieses Plugins eingebunden werden oder andere Dinge gemacht werden, die dieses Plugin voraussetzen
}

JavaScript

foreach in JavaScript

for (var element of someArray) {
    doSomething(element);
}

Siehe: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...of

JavaScript-Datei eines Plugins einbinden

In der Plugin-Klasse wird im Konstruktor folgender Code eingefügt, falls das JavaScript auf allen Seiten verfügbar sein soll. Ansonsten muss der folgende Code in der perform()-Methode des Plugins eingefügt werden, damit das JavaScript nur auf den Pluginseiten zur Verfügung steht:

<?php

PageLayout::addScript($this->getPluginURL() . '/assets/javascript/JavaScriptDatei.js');

Mehr zu PageLayout: PageLayout

URL in JavaScript erzeugen

In JavaScript ist ebenfalls ein URLHelper implementiert, welcher sich ähnlich aufrufen lässt, wie der URLHelper in PHP:

STUDIP.URLHelper.getURL(URL, {"parameter" : WERT});

Das Objekt, welches in JSON-Notation hinter der URL angegeben wird, beinhaltet Parameter, welche an die URL angehängt werden.

Letzte Änderung am 28.07.2016 09:36 Uhr von tleilax.