Namespaces
"A file containing a namespace must declare the namespace at the top of the file before any other code"
It might be obvious, but this means that you *can* include comments and white spaces before the namespace keyword.
<?php
// Lots
// of
// interesting
// comments and white space
namespace Foo;
class Bar {
}
?>
Namespace definition
The namespace is declared using namespace keyword, which should be at the very beginning of the file. Example:
Example#1 Defining namespace
<?php
namespace MyProject::DB;
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
?>
Namespace can contain class, constant and function definitions, but no free code.
Namespace definition does the following:
- Inside namespace, all class, function and constant names in definitions are automatically prefixed with namespace name. The class name is always the full name, i.e. in the example above the class is called MyProject::DB::Connection.
- Constant definitions create constant which is composed of namespace name and constant name. Like class constants, namespace constant can only contains static values.
-
Unqualified class name (i.e., name not containing ::) is resolved at runtime following this procedure:
- Class is looked up inside the current namespace (i.e. prefixing the name with the current namespace name) without attempting to autoload.
- Class is looked up inside the global namespace without attempting to autoload.
- Autoloading for name in current namespace is attempted.
- If previous failed, lookup fails.
-
Unqualified function name (i.e., name not containing ::) is looked up at runtime first in the current namespace and then in the global space.
-
Unqualified constant names are looked up first at current namespace and then among globally defined constants.
add a note
User Contributed NotesNamespace definition
huskyr at gmail dot com
05-Oct-2009 01:20
05-Oct-2009 01:20
jurrien at jpdokter dot nl
04-Aug-2009 10:21
04-Aug-2009 10:21
I have written a Packager class that allows to use packages and namespaces. It does require the folder layout. If the __autoload function is not yet "re-implemented", it'll create its own __autoload function.
It is written in PHP5 and does not require > PHP5.3, moreover, I don't have PHP5.3 since XAMPP is not adding it yet. Don't ask me why.
Since it's over 300 lines long, I am not going to post it here. But if someone would like to have a look?
Basic uses:
<?php
# /classes
# /package1
# class34.class.php
# /package2
# classone.class.php
require_once('packager.class.php');
#Packager::debug(true);
Packager::addClasspath(dirname(__FILE__).'/classes', true); // true means that it overrules the predefined set.
Packager::addClassSuffix(array('.class.php'),true); // true means that it overrules the predefined set.
Packager::import("package1.Class34"); // java-style
Packager::import("package2::ClassOne"); // php-style
echo Packager::dump(); // show us what you got!
?>
jeremeamia at gmail dot com
14-Jul-2009 05:43
14-Jul-2009 05:43
You should not try to create namespaces that use PHP keywords. These will cause parse errors.
Examples:
<?php
namespace Project/Classes/Function; // Causes parse errors
namespace Project/Abstract/Factory; // Causes parse errors
?>
danbettles at yahoo dot co dot uk
14-Apr-2009 09:02
14-Apr-2009 09:02
Regarding constants defined with define() inside namespaces...
define() will define constants exactly as specified. So, if you want to define a constant in a namespace, you will need to specify the namespace in your call to define(), even if you're calling define() from within a namespace. The following examples will make it clear.
The following code will define the constant "MESSAGE" in the global namespace (i.e. "\MESSAGE").
<?php
namespace test;
define('MESSAGE', 'Hello world!');
?>
The following code will define two constants in the "test" namespace.
<?php
namespace test;
define('test\HELLO', 'Hello world!');
define(__NAMESPACE__ . '\GOODBYE', 'Goodbye cruel world!');
?>
David Drakard
07-Sep-2008 02:56
07-Sep-2008 02:56
I agree with SR, the new namespaces feature has solved a number of problems for me which would have required horrible coding to solve otherwise.
An example use:
Say you are making a small script, and write a class to connect to a database, calling it 'connection'. If you find your script useful and gradually expand it into a large application, you may want to rename the class. Without namespaces, you have to change the name and every reference to it (say in inheriting objects), possibly creating a load of bugs. With namespaces you can drop the related classes into a namespace with one line of code, and less chance of errors.
This is by no means one of the biggest problems namespaces solve; I would suggest reading about their advantages before citicising them. They provide an elegant solutions to several problems involved in creating complex systems.
Baptiste
14-May-2008 09:47
14-May-2008 09:47
There is nothing wrong with PHP namespaces, except that those 2 instructions give a false impression of package management.
... while they just correspond to the "with()" instruction of Javascript.
By contrast, a package is a namespace for its members, but it offers more (like deployment facilities), and a compiler knows exactly what classes are in a package, and where to find them.
Anonymous
01-Apr-2008 09:11
01-Apr-2008 09:11
@ RS: Also, you can specify how your __autoload() function looks for the files. That way another users namespace classes cannot overwrite yours unless they replace your file specifically.