Motivy

Vykreslit boxy pro daný slot.

Možné sloty se definují v plugin.json v layouts. Viz také další nastavení boxů.

Vrátí true, pokud daný slot obsahuje alespoň 1 box, jinak false.

(Dostupné od verze 8.2.0).

Vykreslit odkazy motivu.

Metodě je možné předat pole s následujícími klíči:

• cms - vykreslit odkaz na web SunLight CMS
  • true - ano (výchozí)
  • false - ne
• admin - vykreslit odkaz na administraci
  • true - vždy
  • false - nikdy
  • null - pokud má uživatel právo (výchozí)

<ul>
    <?= Template::links(['admin' => false]) ?>
</ul>

Vykreslit menu.

<?= Template::menu() ?>

Pomocí argumentů je možné definovat rozsah pořadí a definovat class:

<?= Template::menu(0, 10, 'main-menu') ?>

Vykreslit stromové menu.

<?= Template::treeMenu(['css_class' => 'tree-menu']) ?>

Pomocí pole je možné předat více nastavení:

• page_id - ID stránky, pro kterou se má menu vykreslit (-1 = aktuální)
• children_only - vykreslit pouze potomky stránky (true/false)
• max_depth - maximální hloubka stromu
• ord_start - limit pořadí od
• ord_end - limit pořadí do
• css_class - vlastní CSS třída

(Pokročilejší možnosti jsou popsány v dokumentaci metody ve zdrojovém kódu.)

Vykreslit drobečkovou navigaci.

<?= Template::breadcrumbs() ?>

Pomocí argumentů lze předat vlastní drobečky (seznam polí s klíči "title" a "url") a vypnout drobečky, pokud je pouze jeden:

<?= Template::breadcrumbs([], true) ?>

Vykreslit uživatelské menu.

<?= Template::userMenu() ?>

Pomocí argumentů je možné vypnout odkaz na profil a odkaz do administrace:

<?= Template::userMenu(false, false) ?>

Vykreslit absolutní URL ke hlavní stránce.

<?= _e(Template::siteUrl()) ?>

Vykreslit cestu ke hlavní stránce.

<?= _e(Template::sitePath()) ?>

Cesta k JSON schématu. Pomáhá editorům v napovídání klíčů a validaci plugin.json. Nepovinné.

"$schema": "../../../system/schema/template.json"

Seznam autorů pluginu.
Klíče "name" a "url" je možné libovolně kombinovat.

"authors": [
    {"name": "Author1", "url": "https://example.com/"},
    {"name": "Author2"},
    {"url": "https://example.com/"}
]

• system - požadovaná verze systému (viz formát)
• php - požadovaná verze PHP (viz formát)
• php_extensions - požadované PHP rozšíření
• db_engine - požadovaný formát databázového úložiště (SL 8.2.0+)
• debug - požadovaný debug mód
  • true - plugin aktivní pouze v debug režimu
  • false - plugin aktivní pouze mimo debug režim
  • null - plugin vždy aktivní

"environment": {
    "system": "^8.3.1",
    "php": ">=7.4",
    "php_extensions": ["curl", "iconv"],
    "debug": null
}

Mapa možných variant motivu.

• layout "default" musí být definován
• layouty je možné přiřazovat ke stránkám
• sloty slouží k přiřazování boxů na místa v dané šabloně
• layouty i sloty by měly mít definovány popisky ve slovníku, viz lang_dir

"layouts": {
    "default": {
        "template": "template.php",
        "slots": ["right"]
    }
}

Viz také popis možného obsahu šablony.

"css": [
    "style.css",
    "another-style.css"
]

"js": [
    "template.js",
    "another-script.js"
]

<meta name="viewport" content="width=device-width, initial-scale=1">

Pokud je nastaveno na true, je motiv považován za tmavý. Pro tmavé motivy se používá tmavé téma lightboxu. Výchozí stav je false.

Zobrazit BBCode tlačítka při psání příspěvků a komentářů. Výchozí stav je true.

Název tagu, který obalí boxy. Výchozí je "" (vypnuto).

Název tagu, který obalí jednotlivé boxy. Výchozí je "div".

Název tagu, který obalí titulek boxu. Výchozí je "h3".

Příznak, zda má být titulek uvnitř boxu nebo před ním. Výchozí je false (titulek je před boxem).

Název adresáře, kde jsou umístěny popisky layoutů a slotů. Výchozí je "labels".

<?php

return array(
    'default.label' => 'výchozí',
    'default.slot.right' => 'pravý sloupec',
);

Pokud je váš motiv určen pro širší distribuci, je doporučeno mít popisky alespoň v češtině (cs.php) a angličtině (en.php).

Seznam událostí, které motiv zpracovává.

Viz dokumentace callbacků pro více informací o specifikaci callbacků.

"events": [
    {"event": "tpl.title", "script": "event/title.php"}
]

Klíč "event" specifikuje název události, na který se má callback napojit.

Motiv musí být aktivní v okamžiku vyvolání události, aby na ni mohl reagovat. Tzn. může reagovat na událost index.init nebo pozdější.

(Před verzí 8.2.0 mohou motivy reagovat až po události tpl.start.)

Mapa pluginů, na kterých tento plugin závisí a jejich požadovaných verzí (viz formát).

Názvy pluginů jsou ve formátu typ.název, případně pouze název - v takovém případě se předpokládá template.

"dependencies": {
    "extend.some-plugin": "^1.0",
    "another-plugin": "*"
}

Relativní cesta ke skriptu, který vrátí instalátor pluginu.

Poznámka: Instalátor se spouští během načítání pluginů a nejsou tedy dostupné ostatní pluginy ani autoloading class samotného pluginu.

"installer": "installer.php"

Příklad instalátoru:

<?php

use Sunlight\Plugin\PluginInstaller;
use Sunlight\Database\Database as DB;

return new class extends PluginInstaller {
    protected function verify(): bool
    {
        return empty(
            $this->checkTables([
                DB::table('example'),
            ])
        );
    }

    protected function doInstall(): void
    {
        $this->loadSqlString(<<<'SQL'
            CREATE TABLE `sunlight_example` (
                `id` int NOT NULL AUTO_INCREMENT PRIMARY KEY,
                `title` varchar(255) NOT NULL
            ) ENGINE='InnoDB';
        SQL);
    }

    protected function doUninstall(): void
    {
        $this->dropTables([
            DB::table('example'),
        ]);
    }
};

Dodatečné nastavení autoloadingu ve stejném formátu, jako má Composer. Viz dokumentace.

• jsou podporovaný pouze klíče "psr-0", "psr-4" a "classmap"
• každý plugin má automaticky nastaven PSR-4 autoloading do svého class podadresáře
• composer závislosti mohou být načteny automaticky, viz klíč inject_composer
• namespace pluginu je řízen pomocí klíče namespace

Název vlastní třídy pluginu.

• pokud není uveden jiný namespace, je před název třídy automaticky přidán plugin namespace
• vlastní třída musí dědit Sunlight\Plugin\TemplatePlugin

Namespace pluginu.

Pokud není uveden žádný namespace, je vytvořen z kombinace SunlightTemplate a názvu pluginu převedeného na CamelCase. Např. pro plugin template/my-plugin bude namespace SunlightTemplate\MyPlugin

Povolit automatickou integraci Composer závislostí pluginu. Výchozí stav je true.

• pokud je integrace povolena a v adresáři pluginu existuje composer.json, budou do autoloadingu přidány i tyto závislosti
• s pluginem je potřeba distribuovat i vendor adresář, případně před použitím pluginu spustit composer install v jeho adresáři
• pokud stejnou závislost poskytuje více pluginů, je preferována její nejnovější možná verze
• systémové závislosti není možné nahradit

Vlastní akce pluginu, které je možné spouštět v administraci ve správě rozšíření.

"actions": {
    "custom-action": "CustomActionClass"
}

• třída akce musí dědit Sunlight\Plugin\Action\PluginAction
• pokud není uveden jiný namespace, je před název třídy automaticky přidán plugin namespace

Výchozí nastavení pluginu.

"config_defaults": {
    "example_toggle": true,
    "example_string": "hello world!"
}

• ke konfiguraci je možné přistoupit zavoláním $this->getConfig()
• uvedením výchozí konfigurace se aktivuje akce Konfigurovat u daného pluginu v administraci
• výchozí implementace akce umí editovat pouze boolean a textové hodnoty
• implementaci akce je možné přetížit definováním vlastní akce s názvem "config" v actions
• konfigurace se ukládá do adresáře plugins/config/

Extra nastavení pluginu pro účely jiných pluginů.

Je možné k nim přistupovat pomocí metody getExtraOption() na instanci daného pluginu.