Výchozí hodnoty nepovinných parametrů v PHP dokumentaci

Školení, která pořádám

Když jsem zjistil, že formát Docbook, ve kterém je napsaná PHP dokumentace, podporuje uvádění výchozích hodnot nepovinných parametrů v deklaracích funkcí (a že tuto značku podporuje i PhD), rozhodl jsem se tyto výchozí parametry do dokumentace doplnit pokud možno u všech funkcí, kde to dává smysl (implementace některých funkcí se rozhodují podle počtu parametrů, takže výchozí hodnota nemá význam).

Bylo to samozřejmě obrovské množství práce, nakonec se mi ji ale podařilo dokončit. Kromě poučného pohledu do PHP zdrojáků jsem se místy i pobavil. Nejvíc asi u metody Phar::convertToExecutable, kde je výchozí hodnota parametrů format a method nastavena na magické číslo 9021976 (parametry přitom můžou nabývat hodnot od 0 do 3). Ve zdrojovém kódu je to dokonce i vysvětleno jako:

Číslo, které není 0, 1 ani 2 (což jsou taky Gregovy narozeniny)

Takže Gregu, 15.4. vše nejlepší…

Jakub Vrána, Ze zákulisí, 26.1.2009, diskuse: 5 (nové: 0)

Diskuse

ikona Joelp:

Při přechodu na PhD se "ztratila" CS verze. Fyzicky tam je, ale asi jen jako Docbook.
Bude i v PhD časem čeština?

ikona Jakub Vrána OpenID:

Česká verze se přestala exportovat proto, že je velmi zastaralá a neudržovaná. Obsahuje tedy matoucí informace. Nicméně je stále k dispozici na http://www.php.net/manual/cs/, jen už na ni nevede odkaz.

ikona Joelp:

V této staré verzi je přehledný obsah a jeho struktura mi sedí víc. Lépe se mi v něm hledá, když potřebuji fci, kde vím +- co by měla dělat, ale neznám její jméno. V té nové (aktuálně odkazované na php.net) se nedokážu orientovat.

ikona Jakub Vrána OpenID:

Mě také stará struktura vyhovovala lépe a byl jsem její zastánce. Abecední seznam extenzí se přesunul z obsahu na http://www.php.net/manual/en/extensions.alphabetical.php.

ikona david@grudl.com:

Skvělá práce!

Vložit komentář

Používejte diakritiku. Vstup se chápe jako čistý text, ale URL budou převedeny na odkazy a PHP kód uzavřený do <?php ?> bude zvýrazněn. Pokud máte dotaz, který nesouvisí s článkem, zkuste raději diskusi o PHP, zde se odpovědi pravděpodobně nedočkáte.

Jméno: URL:

avatar © 2005-2018 Jakub Vrána. Publikované texty můžete přetiskovat pouze se svolením autora. Ukázky kódu smíte používat s uvedením autora a URL tohoto webu bez dalších omezení Creative Commons. Můžeme si tykat. Skripty předpokládají nastavení: magic_quotes_gpc=Off, magic_quotes_runtime=Off, error_reporting=E_ALL & ~E_NOTICE a očekávají předchozí zavolání mysql_set_charset. Skripty by měly být funkční v PHP >= 4.3 a PHP >= 5.0.