PHP triky
Weblog o elegantním programování v PHP pro mírně pokročilé
SimpleXML: jmenné prostory
Extenzi SimpleXML mám v oblibě pro velice jednoduchou práci s XML dokumenty. Konec konců jsem se jí nechal inspirovat při tvorbě NotORM. Např. pro získání hodnoty atributu <meta charset>
se dá použít jednoduché $html->meta["charset"]
. Pro složitější dotazy se dá použít XPath, např. všechny tabulky v dokumentu pomocí $html->xpath("//table")
.
Když dokument obsahuje jmenné prostory, tak je práce složitější a část magie mizí. Mějme takovýto dokument:
<movies xmlns="http://default" xmlns:a="http://a">
<movie xml:id="movie1" a:link="IMDB">
<a:actor>Onlivia Actora</a:actor>
</movie>
</movies>
Dá se s ním pracovat takhle:
<?php $movies = simplexml_load_string($file); // Namespace http://www.w3.org/XML/1998/namespace is available as "xml". echo $movies->movie->attributes("xml", true)["id"] . "\n"; // Namespaced attributes can be accessed with attributes(). echo $movies->movie->attributes("a", true)["link"] . "\n"; // Using namespace URI allows document to use any namespace alias. echo $movies->movie->attributes("http://a")["link"] . "\n"; // Children can be accessed with children(). echo $movies->movie->children("http://a")->actor . "\n"; // Using xpath() with namespace requires registering it first. $movies->registerXPathNamespace("a", "http://a"); echo count($movies->xpath("//a:actor")) . "\n"; // Even the default namespace must be registered. $movies->registerXPathNamespace("default", "http://default"); echo count($movies->xpath("//default:movie")) . "\n"; ?>
Adminer 5.3.0 - možnosti indexů
Největší změna v Admineru 5.3.0 je podpora algoritmu indexu (bug #1030). PostgreSQL podporuje šest algoritmů, MySQL jen dva a to jen u některých typů tabulek.
Druhou novinkou jsou částečné indexy. V PostgreSQL lze nastavit podmínku, při které se hodnota do indexu uloží (bug #1048).
Do PostgreSQL a CockroachDB jsem přidal možnost vytvářet tabulky s oddíly (bug #1031). PostgreSQL bohužel nedovoluje oddíly změnit po vytvoření tabulky a automatická migrace (jako ji v některých případech dělá ovladač pro SQLite) mi přišla trochu riskantní. S tím souvisí i přesun oddílů v PostgreSQL z menu do rodičovské tabulky.
Další změny jsou menší:
- Výsledky funkcí vracejících číslo (např.
COUNT(*)
neboCHAR_LENGTH()
jsem nechal zarovnat doprava stejně jako číselné sloupce. V PostgreSQL se z hodnotyCOUNT(*)
vytvoří odkaz stejně jako v MySQL. - Autocomplete SQL nyní podporuje aliasy tabulek.
- Verze 5.1.1 rozbila vytváření uložených funkcí, nová verze typovou chybu opravuje (bug #1053).
- Akce sloupečků zobrazené po najetí myši mají nyní rámeček (bug #1072).
- Hodnoty typu
money
jsem nechal zarovnat doprava stejně jako čísla (bug #1071). - V MySQL jsem opravil varování při zobrazení dat z tabulek s fulltext indexem (bug #1036).
- Verze 5.1.1 rozbila připojování přes
localhost:3306
, zkoušel se hledat socket 3306. Nová verze to opravuje (bug #1057). - V PostgreSQL mohou uživatelské funkce vracet tabulku, kterou Adminer při zavolání funkce nyní ukáže (bug #1040).
- Do PostgreSQL jsem přidal operátor
NOT ILIKE
(bug #1062). - V Editoru jsem opravil vyhledávání podle sloupců
bit
aenum
(bug #1062). - Pokud uživatelský styl v souboru
adminer.css
podporuje přepínání do tmavého režimu, tak Adminer svůj tmavý styl nevypne. - Pluginy můžou v metodě
css()
určit, zda styl podporuje tmavý vzhled. Výchozí implementace u souboruadminer.css
zkoumá přítomnostprefers-color-scheme: dark
. - Pluginům jsem dal možnost přidat třídu do
<body class>
. Adminer tam přidává tříduadminer
, Editor třídueditor
. - Přibyl překlad do hindštiny.
Adminer 5.2.0
Uživatelsky nejviditelnější změna v Admineru 5.2.0 je našeptávač pro SQL. Dále jsem udělal několik drobnějších změn:
- Při hromadné editaci záznamů přes odkaz Změnit se nevytvoří políčka pro hodnotu
NULL
. Tento jednoduchý formulář totiž nerozlišuje prázdný řetězec aNULL
, takže pouhé uložení nezměněného formuláře přepsaloNULL
na prázdný řetězec. Políčka s hodnotouNULL
se v tomto formuláři dají změnit pomocí Ctrl+klik, což používám primárně já (bug #967). - Předchozí verze rozbila akce cizích klíčů.
- V MySQL se v
GROUP BY
dotazech zobrazuje počet nalezených řádek, což rozbila předchozí verze. - SQL příkaz pro PostgreSQL podporuje příkaz
COPY FROM stdin
, který generujepgdump
(bug #942). - V ne-MySQL se
--
bere jako začátek komentáře, v MySQL za tím musí být ještě mezera (bug SF-842). - V exportu MS SQL je počet řádků v jednom
INSERT
omezen na 1000 (bug #983). - Udělal jsem maličký facelift – přidal logo, zaoblil nějaké rohy, přidal nějaké stíny. Alternativní designy jsem upravil, aby fungovaly na mobilu.
- Možnost rozesílat hromadné e-maily z Adminer Editoru jsem přesunul do pluginu. Jednak to asi není moc používané a jednak to jde teď naopak použít i v Admineru.
- Do pluginů jsem přidal možnost překladů. Ty nově můžou dědit ze třídy
Adminer\Plugin
, která jim dá metodulang()
. Pokud pluginy používají nějaké fráze z Admineru, tak můžou nadále volatAdminer\lang()
. - Pro Adminer Editor jsem přidal plugin pro jednodušší nastavení ovladače, serveru a databáze.
Konfigurace
Před představením dalších dvou nových pluginů udělám trochu odbočku. Čas od času po mně někdo chce, abych třeba změnil odkazy na tabulky z menu. Že používá jen odkaz pro výpis dat, druhý odkaz je zbytečný a způsobuje menší přehlednost menu. Někdo naopak usoudil, že je zbytečný odkaz pro výpis dat a nechal jen odkaz na strukturu tabulky. Další lidi po mně chtějí, ať pro to přidám možnost konfigurace. Nebo ať o podobných věcech nechám hlasovat uživatele. Většinou to rychle smetu ze stolu pomocí „použij plugin nebo vlastní vzhled“, ale zamyslel jsem se nad tím trochu víc.
Chování Admineru ovlivňují tři různé strany:
- Vývojář: Rozhoduje o výchozím chování a poskytuje hooky pro pluginy
- Admin: Instaluje Adminer, vybírá pluginy a výchozí vzhled
- Uživatel: Používá Adminer
Díky tomu, že je Adminer k dispozici v jednom souboru a že jeho cílová skupina jsou především programátoři, tak Admin je často ta stejná osoba jako Uživatel. Ale zdaleka to neplatí vždy. Pokud si ve WordPressu nainstaluji plugin pro Adminer, tak jsem jeho Uživatel, ale ne jeho Admin. Nebo pokud mi hosting dá Adminer předinstalovaný.
Adminer na Uživatele myslí jen trochu. Třeba kromě vzhledu v souboru adminer.css
(o tom rozhoduje Admin) existuje i plugin designs
, který vzhledy dovoluje přepínat uživateli.
Nově přidávám plugin config
, který dovoluje chování Admineru změnit Uživateli. Nastavení ukládá do cookie. Pokud chci stejné nastavení použít na více zařízeních, tak se dá URL s konfigurací uložit do záložky a tu pak otevřít jinde. Samotný plugin config
momentálně dovoluje vypnout načítání vzhledu adminer.css
a použít vestavěný vzhled Admineru. Dají se na něj ale napojit další pluginy.
Druhý plugin s nastavením pro uživatele je menu-links
, který dovoluje změnit ono chování odkazů na tabulky v menu. Dá se použít jako normální plugin, kde může Admin přepnout chování natvrdo všem uživatelům. Ale v kombinaci s config
si Uživatel toto chování může změnit sám pro sebe.
Možností konfigurace uživateli možná časem přidám víc. Zvažoval jsem i dát uživatelům možnost vypnout některé pluginy, ale třeba možnost vypnout bezpečnostní pluginy by mít neměli. Časem možná plugin config
integruji i přímo do Admineru, stejně jako se to stalo s pluginem plugin
, který dovoloval pluginy používat.
Adminer 5.2.1 opravuje především chyby odhalené díky typové kontrole.
Autocomplete pro SQL
Našeptávače ve webových editorech kódu jsou převážně tupé. Mají seznam klíčových slov, která jednoduše doplňují podle toho, co začnete psát. V SQL jim můžete dát ještě seznam tabulek a jejich sloupců a doplňují pak i ty. Ale když napíšete třeba SELECT * FROM tabulka WHERE |
tak netuší, že mají doplňovat sloupce jen z tabulky tabulka
. Třeba v CodeMirror musíte napsat WHERE tabulka.|
, aby se zobrazily sloupce jen z dané tabulky.
Rozhodl jsem se to vzít za jiný konec. Místo, aby se za všech okolností napovídalo všechno, tak se napovídá jen to, co v daném kontextu dává smysl. Takže třeba:
- Za
SELECT
se napovídají sloupce ze všech tabulek. Pokud jich je moc, tak se napovídátabulka.
pro všechny tabulky. Když to vyberete, ukážou se sloupce jen z dané tabulky. - Pokud ale někde vpravo už máte
FROM tab1 JOIN tab2
, tak se napovídají jen sloupce z tabulektab1
atab2
. - U dotazu
SELECT * FROM tab ORDER BY id
se nenapovídáWHERE
, protože to patří předORDER BY
. Napovídá se aleLIMIT
. - U
CREATE TABLE
se nenapovídá nic, název tabulky bude určitě jiný. - Když necháte doplnit
INSERT
, tak se rovnou doplníINSERT INTO
, protože to je nejčastější varianta. Můžete se ale vrátit a nechat si dopnitIGNORE
. - Když máte někde v dotazu identifikátor uzavřený do
`idf`
(v MySQL), tak se tabulky a sloupce defaultně nabízí taky takto uzavřené.
phpMyAdmin má plnohodnotný parser SQL, ale pro autocomplete ho nepoužívá. Navíc parser běží na serveru, takže se s každým napsaným písmenkem musí odesílat požadavek a čekat na odpověď. Já jsem si napsal pár regulárních výrazu v JavaScriptu, které nakonec udělají mnohem víc muziky. Když jsem to dokončil, tak jsem nemohl uvěřit vlastním očím: Je to v podstatě SQL wizard, ve kterém celý dotaz sestavíte skoro jen pomocí šipky dolů a Enteru. Ale když chcete něco speciálního, tak se snaží nepřekážet.
Živá ukázka
Jistě sami přijdete na to, jaké tabulky a sloupce jsou definované. Začněte psát SQL dotaz:
Adminer 5.1.1 - refaktoring
Adminer prodělal asi největší refaktoring od přidání podpory pro ne-MySQL databáze.
PHP
Začalo to celkem nevinným komentářem, který mě vybídl k lepšímu popisu tvarů polí v dokumentačních komentářích. To bylo většinou jakž-takž popsané v textu komentáře, ale ne zcela přesně. Např. informace o sloupci v databázi mají trochu jiný tvar než informace o parametru uložené procedury, některé funkce ale dokáží pracovat s oběma formáty. K popisu jsem použil syntaxi PHPStanu a pro časté typy jsem vytvořil aliasy. Vyzkoušel jsem i náhradu polí za value objekty, ale nepracuje se s tím tak pohodlně, tak jsem zůstal u polí.
Původní kód:/** @return array ["Timing" => [], "Event" => [], "Type" => []] */ |
Nový kód:/** @return array{Timing: list<string>, Event: list<string>, Type: list<string>} */ |
Když už jsem měl typy popsané, tak jsem si řekl, že by bylo škoda je nevyužít pro kontrolu Admineru PHPStanem. Jenže PHPStan vyžaduje opakování názvu parametru ve značce @param
a Adminer uváděl jen typ podle pořadí parametru. Nesnáším opakování, tak jsem se rozhodl, že typ parametrů deklaruji přímo v kódu a značku @param
nechám jen v případě, že parametr bude mít nějaký popis nebo typ specifičtější než PHP (např. literal-string
nebo list<int>
). Totéž jsem udělal i pro návratový typ a vlastnosti objektů. Použil jsem syntaxi PHP 7.4, kterou nyní spuštění Admineru ze zdrojových kódů vyžaduje. Při kompilaci do jednoho souboru se typy zase odstraní, čímž jednosouborová verze zůstala kompatibilní s PHP 5.3. Vedlejší efekt je i ten, že v některých zákoutích kódu může být typ špatně, takže nová verze tyto případy hned nerozbije. Byl jsem opravdu hodně vděčný za bohaté end-to-end testy, díky kterým jsem většinu typových chyb snad našel.
Původní kód:/** Get INI boolean value * @param string * @return bool */ function ini_bool($ini) |
Nový kód:/** Get INI boolean value */ function ini_bool(string $ini): bool |
PHPStan našel i řadu dalších, většinou drobných chyb. Kód Admineru teď s několika výjimkami prochází PHPStan levelem 6.
Adminer pro každou z 12 podporovaných PHP extenzi (+ další v pluginech) definuje třídu Db
. Těm jsem nyní dal společného předka, což kód v některých případech i zjednodušilo. Zvažoval jsem použití rozhraní, protože Db
pro MySQLi je potomek třídy mysqli
, takže jiného předka mít nemůže. Ale kód by pak musel mít stejné typy jako mysqli
, takže by nebyl kompatibilní zároveň se starými a novými verzemi PHP. Rozhraní navíc nedovoluje deklarovat vlastnosti. Lepší by bylo dědění z mysqli
zahodit a předělat to na proxy.
Změnil jsem implementaci třídy Plugins
pro nahrávání pluginů. Tu jsem tak nesnášel, že před verzí 5.1 jsem jejích zkompilovaných 7 kB odmítl dát přímo do Admineru a uživatele pluginů ji nutil nahrát zvlášť. Původně byla tato třída potomek třídy Adminer
a po zavolání pluginů zavolala výchozí implementaci ve třídě Adminer
. Teď jsem to změnil tak, že třída Plugins
prostě zaregistruje Adminer
jako nejspodnější plugin a volá ji stejně jako všechny ostatní pluginy. Kód třídy Adminer
jsem musel změnit tak, aby metody místo na $this
volala na adminer()
, což je svým způsobem i přesnější. Je z toho totiž jasné, že se zavolají nejprve pluginy a ne nutně implementace ve třídě Adminer
.
Původní kód:function name() { $args = func_get_args(); return $this->applyPlugin(__FUNCTION__, $args); } function credentials() { $args = func_get_args(); return $this->applyPlugin(__FUNCTION__, $args); } // kilometr dalšího kódu na stejné brdo |
Nový kód:function __call(string $name, array $args) { foreach ($this->hooks[$name] as $plugin) { $value = call_user_func_array(array($plugin, $name), $args); if ($value !== null) { return $value; } } } |
Smazal jsem všechny globální proměnné. V minulosti jich měl Adminer maximálně 23.
Kód ve verzi 4.8.1:global $adminer, $connection, $driver, $drivers, $edit_functions, $enum_length, $error, $functions, $grouping, $HTTPS, $inout, $jush, $LANG, $langs, $on_actions, $permanent, $structured_types, $has_token, $token, $translations, $types, $unsigned, $VERSION; |
Nový kód:// nic |
Přestal jsem ignorovat chybu Trying to access array offset on null, kterou PHP vyvolá třeba s kódem $_GET["where"]["_id"]
. Našlo to jeden okrajový problém.
JavaScript
Do JavaScriptu jsem přidal 'use strict'
, což si v kódu nevyžádalo žádnou změnu.
CSS
Adminer používá obrázky prakticky jen pro tlačítka ve změně struktury tabulky. Byly vložené pomocí <input type="image">
, což komplikovalo jejich stylování. Autoři designů si s tím i tak poradili, ale v nové verzi vkládám obrázky přes CSS background-image
, což stylování zjednodušuje. Stávající designy jsem na to přehodil. Při kompilaci jsem url(plus.gif)
změnil na url(data:image/gif;base64,...)
, což dovolilo odstranit kód pro servírování obrázků Adminerem. Pak jsem to zjedodušil ještě víc, obrázky inlinoval ručně a z repozitáře je smazal. Stejně se prakticky nemění a v případě potřeby je jde z CSS zase vytáhnout, upravit a vložit zpátky. Při vývoji Admineru mám vypnuté kešování a tato změna odstranila kratičké probliknutí před tím, než se obrázky stáhly.
Do CSS jsem doplnil alespoň dvě proměnné pro výchozí barvu pozadí a popředí a ve stávajících barevných designech ji nadefinoval. Důvodem je, že někdy ve výchozím vzhledu potřebuji tyto barvy použít na dalších místech a pokud s tím designy nepočítají, tak se rozbijí. Do budoucna to také umožní jednodušší vytváření nových designů.
Původní kód:/* default.css */ body { background: #fff; } .footer > div { background: #fff; } #tables a { background: #fff; } .footer { border-top-color: rgba(255, 255, 255, .7); } /* dark.css */ body { background: #002240; } .footer > div { background: #002240; } #tables a { background: #002240; } .footer { border-top-color: rgba(0, 34, 64, .7); } |
Nový kód:/* default.css */ html { --bg: #fff; } body { background: var(--bg); } .footer > div { background: var(--bg); } #tables a { background: var(--bg); } .footer { border-top-color: rgb(from var(--bg) r g b / .7); } /* dark.css */ html { --bg: #002240; } |
Za všimnutí stojí hlavně použití funkce rgb(from)
.
Testy
Přidal jsem si skript na vytvoření stejného testu pro všechny databáze a přidal s ním několik dalších testů. Doplnil jsem také alespoň základní test pro Elasticsearch.
Rozčilovalo mě, že screenshoty na homepage nejsou pro aktuální verzi, ale samozřejmě se mi je nechce dělat s každou novou verzí znovu. Tak jsem si napsal test, který mi je udělá.
Funkční změny
Žádná z těchto změn by se neměla navenek nijak projevit, proto nedošlo k žádnému bombastickému zvýšení čísla verze. Viditelných změn je jen pár:
- Opravil jsem TAR export rozbitý přidáním viditelnosti vlastností ve verzi 5.0.3. To odhalil PHPStan.
- Opravil jsem řazení podle sloupce
COUNT(*)
rozbité verzí 5.0.2 (bug #966). - Pro získání sloupců grafického schématu databáze se nově klade jen jeden dotaz. Metodu jsem zpřístupnil i pluginům, využívají to editory kódu s podporou doplňování názvů sloupců.
- Plugin pro Elasticsearch jsem opravil, aby fungoval s verzí 8 – snad jsem ho tím nerozbil pro starší verze.
- Na mobilu (nebo obecně při malém rozlišení) se menu nyní úplně schová a zobrazí se až pomocí tlačítka. Ikonu tlačítka jsem mimochodem vzal ze 12 let staré nedokončené větve.
- V tmavém vzhledu jsem invertoval ikony. Díky jejich stylovatelnosti by se daly i vyměnit, ale inverze stačila.
- Metodě
csp()
posílám aktuální CSP, což dovoluje nastavení CSP více pluginům najednou. - Přidal jsem pluginy pro editory a zvýrazňovače kódu Prism a Monaco Editor. S žádným z pěti nyní podporovaných zvýrazňovačů kódu ale nejsem úplně spokojen, takže vylepším interní JUSH. Více v samostatném článku.
Starší články naleznete v archivu.

