Scriptorama.nl

Goed nieuws voor degene die bij onze vorige posting nog hoopte dat PHP6 uberhaupt namespace ondersteuning zou krijgen. Die kogel is inmiddels door de kerk. Interessanter is dat inmiddels ook is besloten om de volgende versie in de PHP5 serie: PHP 5.3 ook ondersteuning voor Namespaces te geven.

Nadat duidelijk geworden wat ongeveer de verdere plannen zijn voor PHP 5.3, is vorige week een nieuwe ontwikkel branche aangemaakt voor PHP 5.3 en daarop is afgelopen vrijdag ondersteuning voor namespaces aan toegevoegd. In dit artikeltje kijken we wat namespaces zijn en hoe we ze kunnen gebruiken.

Update 1: De implementatie gebruikt nu 'use' in plaats van 'import'. Aangepast.
Update 2: '::' is niet langer de namespace separator, dat is nu '\'. Aangepast.

Waarom namespaces?

Nu PHP5 steeds meer gebruikt wordt, beginnen er allerlei frameworks te ontstaan. Denk bijvoorbeeld aan Zend Framework, Solar, Mojavi of CakePHP. Mensen pakken vaak van verschillende frameworks, maar ook kleinere libraries, een stukje en gebruiken dat in hun website. Dit levert een probleem op. Want het is mogelijk dat bepaalde klassenaam in 2 gebruikte projecten voorkomt. Dit levert een foutmelding op want je kan een klassenaam maar 1x gebruiken.

Bij de release van PHP 5.1 werd PHP zelf geplaagd door dit probleem. In PHP 5.1 werd de nieuwe Date klasse geintroduceerd. Deze klasse bood allerlei nieuwe functionaliteit aan, maar de ontwikkelaars van PHP hadden over het hoofd gezien dat de PEAR library zelf ook een klasse met de naam Date meeleverde. Deze twee klassen hadden echter een compleet andere API en functionaliteit wat natuurlijk de nodige problemen opleverde voor de mensen die de PEAR Date klasse gebruikten.

Fatal error: Cannot redeclare class Date in /home/mathieu/public_html/test.php on line 3

Uiteindelijk is de Date klasse er in PHP 5.1.1 tijdelijk uit PHP gehaald en later in PHP 5.2 weer toegevoegd met de naam DateTime. Over deze klasse hebben we op Scriptorama ook al het nodige geschreven: de DateTime klass in PHP 5.2.

Om naam-botsingen te voorkomen hebben verschillende frameworks (zoals bijvoorbeeld Zend Framework en PEAR) inmiddels gekozen voor "poor man's namespacing" wat zoveel inhoudt dat je je klassen een naam geeft die duidelijk aangeeft bij welk project en welk onderdeel van het project een klasse hoort.

Het vervelende daaraan is dat dat, zoals je hierboven ziet, in sommige gevallen erg lange klasse namen kan veroorzaken wat de leesbaarheid van je code weer tegen gaat.

Om ontwikkelaars bij deze problemen te ondersteunen zijn namespaces geintroduceerd.

Namespaces in PHP

Namespaces zijn een manier om onderdelen van je project te kunnen groeperen. De namespace zelf is in feite een extra laag om je klassen en functies heen. Binnen deze laag zijn alle namen weer uniek. Op het moment dat je een namespace definieert heb je dus in feite weer schone lei qua namen. Zo zou ik zowel binnen de namespace Scriptorama::SDK als binnen de namespace Scriptorama::Logging een klasse Database kunnen definiëren.

Om een namespace te definieren in PHP 5.3 of PHP 6.0 gebruik je het namespace keyword helemaal boven aan je bestand. Het is verplicht om deze als eerste statement in je PHP file te hebben. Hieronder definieer je vervolgens de rest van het bestand, zoals je dat normaal ook al deed:

Scriptorama/SDK/Database.php:

Scriptorama/Logging/Database.php:

Een namespace is niet beperkt tot 1 bestand. Je kunt dezelfde namespace definieren in verschillende bestanden. De klasse(n) uit de andere bestanden worden dan toegevoegd aan de al bestaande namespace:

Scriptorama/Logging/FileLogger.php:

Om deze klasse vervolgens aan te spreken kun je verschillende dingen doen. Je kunt de klasse volledig met zijn Namespace naam aanspreken:

Maar dan ben je natuurlijk niet veel beter af dan met poor man's namespacing. Je kunt daarom ook een willekeurig deel van de namespace 'importeren' in de huidige scope. Dit gebeurt met het use keyword.

Zo kun je dus een heel diepe namespace toewijzen aan een kortere naam wat makkelijker te gebruiken is. Zoals je misschien wel door hebt, is het niet daadwerkelijk importeren, zoals bijvoorbeeld in C# gebeurt, maar is het meer een soort aliasing. Overal waar je de klasse of interface wilt aanspreken (bij bijvoorbeeld het implements of extends keyword kun je deze aliasen gebruiken. In de rest van PHP blijft in de klassenaam altijd volledig.

De var_dump() aanroep in het vorige voorbeeld geeft dan ook het volgende resultaat:

Namespace gotcha's

Wanneer je over gaat naar PHP 5.3 of PHP 6.0 en namespaces gaat gebruiken, let dan op de volgende dingen:

1. Let op dat functies ook deel uitmaken van een namespace

Hoewel we in het voorbeeld hierboven eigenlijk alleen gebruik maakten van classes is het belangrijk dat je je realiseert dat ook functies deel uit maken van een namespace. Wanneer je dus een functie definieert in een bepaalde namespace, zul je ook de namespace of de alias naar de namespace moeten gebruiken om hem aan te kunnen roepen:

test.php

test2.php:

2. __autoload() moet mogelijk aangepast worden

Als je de __autoload() functionaliteit in PHP5 gebruikt in combinatie met namespaces op Windows, let dan op dat het Windows filesystem geen dubbele punten in de naam toestaat. Je zult deze dus moeten herschrijven:

Let op: Gotcha #1 is ook van toepassing op de functie __autoload(). Let op dat als je __autoload() gebruikt, dat je deze in de globale scope definieert en dus niet in een namespace, want dan vindt PHP de __autoload functie niet.

Wil je dit toch graag kwijt in een namespace, kun je de autoload functionaliteit uit de SPL gebruiken, welke sowieso aan te raden is, aangezien deze veel flexibeler is dan het standaard mechanisme.

Conclusie

Namespaces bieden je de mogelijkheid om je code te organizeren en om flexibeler om te gaan met klasse namen.

PHP 5.3 en PHP 6.0 zijn voorlopig nog niet final (PHP 5.3 staat gepland voor het eerste kwartaal van 2008) dus het is mogelijk dat er nog het een en ander veranderd. Als je zelf al wilt spelen met Namespaces kun je je wenden tot snaps.php.net waar je zowel de volledige source code als Windows builds van PHP 5.3 en PHP 6.0 kunt vinden.