Top-Level Namespace Requirement
Each namespace MUST include a top-level namespace. This requirement ensures that every part of the codebase references the top-level namespace, thus promoting a cohesive and easily navigable structure.
Purpose
The primary purpose of enforcing a top-level namespace is to maintain uniformity across all modules of a project, reflecting the overarching project or application identity and ensuring clear hierarchy to prevent namespace conflicts.
Examples
Assuming "App" is the designated top-level namespace for a PHP project, all namespaces should begin with "App". Here’s how namespaces should be structured to comply with this standard:
Example (Correct):
namespace App\UI
{
class Window {}
class Button {}
}
namespace App\Database
{
class Connection {}
class QueryBuilder {}
}
namespace App\Network
{
class Http {}
class Ftp {}
}Example (Incorrect):
namespace Database { class Connection {} }Benefits
By adhering to a top-level namespace, projects gain several advantages:
- Consistency: Ensures consistent naming conventions across the codebase.
- Reduced Conflicts: Significantly reduces the risk of naming conflicts both within the project and with external libraries or dependencies.
- Enhanced Readability: Improves organizational clarity and readability of the code, facilitating easier orientation for new developers and contributors. This standard is vital in larger projects or in environments where multiple projects are integrated, as it ensures that every component is clearly part of the overarching application framework.