Mastering Namespaces in PHP

MASTERING NAMESPACES! Nick Belhomme January 29, 2011 – PHPBenelux Conference

About Me @NickBelhomme Freelance PHP Consultant International Conference Speaker Zend Framework 2.0 Cookbook Author Contributor to various Open Source Projects ZCE ZFCE

Passions Life Traveling People Sharing Ideas Networking

Dreams A world of unbounded potential. Where everybody believes they can Be, do and have whatever they think about. Think your idea Act upon your idea Refine later

Why Other big programming languages support them Introduced in PHP 5.3 – One and a half years ago Modern Next Gen Frameworks (Symfony 2.0, Zend Framework 2.0 and others) Job market demands it Use it or loose it

What are they? Abstract container created to hold a logical grouping of unique identifiers. Unique identifiers are names. (in practice: classes, functions, constants) Each identifier is associated with the namespace where it is defined.

PEAR Naming Convention R.I.P. No more clever workaround for lack of namespace support No more very long function and class names

Welcome Readability new Zend_Layout_Controller_Action_Helper_Layout() new Layout() class NbeZf_Model_User extends Nbe_Model_Abstract class User extends AbstractModel

How to create the container space <?php namespace Nbe\Collection; <?php declare(encoding='UTF-8'); namespace Nbe\Collection; Per file <?php /** * @namespace */ namespace Nbe\Collection;

How to create the container space <?php namespace Nbe\Model; const LIBRARY_PATH = '/www/libs/Nbe'; class AbstractModel { /* ... */ } function draw() { /* ... */ } namespace NbeZf; const LIBRARY_PATH = '/www/libs/NbeZf'; class AbstractModel { /* ... */ } function sayHello() { /* ... */ } Mixing spaces per file <?php namespace Nbe\Model { const LIBRARY_PATH = '/www/libs/Nbe'; class AbstractModel { /* ... */ } function draw() { /* ... */ } } namespace { const APP_PATH = '/www/libs/NbeZf'; function __autoload() { /* ... */ } }

Common Mistakes <?php namespace \Nbe; // rest of code Fatal error: Undefined constant 'Nbe' <?php namespace Nbe; class Interface {} <?php namespace Nbe; class Abstract {} Parse error: syntax error, unexpected T_INTERFACE Parse error: syntax error, unexpected T_ABSTRACT

Different name types Fully Qualified Name \Nbe\Model\AbstractModel Qualified Name Model\AbstractModel Unqualified Name AbstractModel

Autoloading namespaces function __autoload($class) { require_once str_replace( '\\', DIRECTORY_SEPARATOR, $class ) . '.php'; } new \NbeZf\Model\User() maps to NbeZf\Model\User require_once /NbeZf/Model/User.php

Autoloading namespaces <?php namespace Nbe\Loader; function autoLoader($className) { require_once \str_replace('\\', \DIRECTORY_SEPARATOR, $className) . '.php'; } <?php require 'Nbe/Loader/autoloader.php'; spl_autoload_register('Nbe\\Loader\\autoloader'); $user = new Nbe\Entity\User();

Resolving namespace calls <?php namespace Nbe; class Model {} $model = new Model(); echo get_class($model); Output: Nbe\Model <?php namespace Nbe; function model() { return __FUNCTION__; } echo model(); Output: Nbe\model

Consequences <?php namespace Nbe; $collection = new ArrayObject(); Fatal error: Class 'Nbe\ArrayObject' not found <?php namespace Nbe; $collection = new \ArrayObject(); Indicate global namespace with a single backslash <----

Function fallbacks <?php namespace Nbe; var_dump(explode(';', ' some;cool;words ')); <?php namespace Nbe; \var_dump( \ explode(';', 'some;cool;words')); Better practice. Explicitly call global space FULLY QUALIFIED NAMES Compile time <---- Runtime and potential happy debugging feature <----

Constants fallbacks <?php namespace { const APP = 'test'; } namespace Nbe { const E_ERROR = 10; echo APP; echo E_ERROR; } Better practice. Explicitly call global space Fully quaylified names, compile time <?php namespace { const APP = 'test'; } namespace Nbe { const E_ERROR = 10; echo \APP; echo E_ERROR; } Runtime and potential happy debugging feature

Magic constants beware <?php namespace Nbe; echo __LINE__; echo __FILE__; echo __DIR__; echo __FUNCTION__; echo __CLASS__; echo __METHOD__; echo __NAMESPACE__; Magic constants cannot be overwritten so no global namespace prefix is allowed

Namespaces are per file <?php function sayHello() { echo 'hello'; } <?php namespace Nbe; require '/utils.php'; \sayHello();

But what about using other namespaces? Fully Qualified namespace calling is still tedious. So how do we solve this? ?

Importing to the rescue! <?php namespace DancingQueen\Entity; use NbeZf\Entity\AbstractEntity, Zend\Validator\StaticValidator; class User extends AbstractEntity { public function setId($id) { If (!StaticValidator::execute($id, 'digits')) { throw new InvalidArgumentException('User id needs to be numeric'); } ... } }

OOOH Noes a naming collision :((( <?php namespace NbeZf\Validator; use Zend\Validator\StaticValidator; class StaticValidator extends StaticValidator { public static function getBroker() { if (null === self::$broker) { static::setBroker(new ValidatorBroker()); } return self::$broker; } } Fatal error: Cannot declare class NbeZf\Validator\StaticValidator because the name is already in use

Aliasing to the rescue! <?php namespace NbeZf\Validator; use Zend\Validator\StaticValidator as ZfStaticValidator; class StaticValidator extends ZfStaticValidator { public static function getBroker() { if (null === self::$broker) { static::setBroker(new ValidatorBroker()); } return self::$broker; } }

Aliasing is in-explicitly used <?php namespace DancingQueen\Entity; use NbeZf\Entity\AbstractEntity as AbstractEntity, Zend\Validator\StaticValidator as StaticValidator; class User extends AbstractEntity { public function setId($id) { If (!StaticValidator::execute($id, 'digits')) { throw new InvalidArgumentException('User id needs to be numeric'); } ... } }

Dynamic Loading <?php namespace Nbe; $class = 'ArrayObject'; $object = new $class(); echo get_class($object); Output: ArrayObject Always Absolute Path

Dynamic Loading from other namespace <?php namespace Nbe; $class = '\Zend\View\PhpRenderer'; $object = new $class(); echo get_class($object); Ouput: Zend\View\PhpRenderer Fully qualified names

Dynamic Loading from current <?php namespace Nbe; $class = __NAMESPACE__ . '\\' . 'ArrayObject'; $object = new $class(); echo get_class($object); Output: Nbe\ArrayObject

Resolution Rules <?php namespace Nbe; use Tata\Nbe; $object = new ArrayObject(); <?php namespace Nbe; use Tata\Nbe; $object = new Nbe\ArrayObject(); Resolves to Nbe\ArrayObject Resolves to Tata\Nbe\ArrayObject

Resolution Rules for Dummies When an alias is available – and there is always an alias available when importing - all unqualified and qualified names are translated using the current import rules. When no alias is available all unqualified and qualified names have the current namespace prepended. Constants and functions have fallbacks to global namespace for unqualified names.

Explicitly Loading from current <?php namespace Nbe; class Exception extends \Exception{} ?> <?php namespace Nbe; use Exception; const ERROR_INFO = 10; try { try { if (1===1) { throw new Exception('instantiates \Exception'); } } catch (\Exception $e) { throw new namespace\Exception('instantiates \Nbe\Exception', ERROR_INFO, $e); } } catch (namespace\Exception $e) { echo 'error: '.$e->getMessage(); echo PHP_EOL; echo 'nested exception error: '.$e->getPrevious()->getMessage(); } File 1 File 2 namespace keyword

Coming to an end, but first some Timeline changes PHP4 class constructor has the same name as the class > PHP5 class constructor is __construct but accepts PHP4 convention >5.3 namespaces are introduced, nothing changes >= 5.3.3 Backward compatibility change. Only __construct is now regarded as the constructor for namespaced code.

And some cool resources The PHP manual http://www.php.net/namespaces Ralph Schindlers namespace convert tool https://github.com/ralphschindler/PHPTools Plus comments on it by Cal Evan http://blog.calevans.com/2010/03/27/zends-new-namespace-converter/ Google: php namespaces http://www.google.be/search?q=php+namespaces Zend Framework 2.0 Cookbook http://blog.nickbelhomme.com/php/zend-framework-2-0-cookbook_324

And we reached the end, Any questions?

The End! THANK YOU [email_address] Slideshare, Twitter, IRC: NickBelhomme http://blog.nickbelhomme.com

Mastering Namespaces in PHP

More Related Content

What's hot (20)

Similar to Mastering Namespaces in PHP (20)

More from Nick Belhomme (6)

Recently uploaded (20)

Mastering Namespaces in PHP