Neuron-PHP

RegistryKeys
in package

Centralized registry key constants for the Neuron framework.

This class provides standardized string constants for all registry keys used throughout the framework. Keys follow a dot notation convention with PascalCase segments for clear namespace separation and consistency.

Tags
since
1.0.0
example
use Neuron\Core\Registry\RegistryKeys;
use Neuron\Patterns\Registry;

// Store application instance
Registry::getInstance()->set(RegistryKeys::APP, $app);

// Retrieve settings
$settings = Registry::getInstance()->get(RegistryKeys::SETTINGS);

// Check if user is authenticated
$user = Registry::getInstance()->get(RegistryKeys::AUTH_USER);

Table of Contents

Constants

APP  = 'App'
The main application instance.
APP_NAME  = 'App.Name'
Application name.
APP_RSS_URL  = 'App.RssUrl'
RSS feed URL for the application.
APP_VERSION  = 'App.Version'
Application version string.
AUTH_CSRF_TOKEN  = 'Auth.CsrfToken'
CSRF token for form submissions.
AUTH_SERVICE  = 'Auth.Service'
Authentication service instance.
AUTH_USER  = 'Auth.User'
Current authenticated user object.
AUTH_USER_ID  = 'Auth.UserId'
Current authenticated user ID.
AUTH_USER_ROLE  = 'Auth.UserRole'
Current authenticated user role.
AUTHENTICATION_LEGACY  = 'Authentication'
BASE_PATH  = 'Base.Path'
Base directory path of the application.
BASE_PATH_LEGACY  = 'BasePath'
BASE_URL  = 'Base.Url'
Base URL for routing and URL generation.
CLI_APPLICATION  = 'Cli.Application'
CLI application instance.
CLI_APPLICATION_LEGACY  = 'cli.application'
CLI_EXIT_CODE  = 'Cli.ExitCode'
CLI exit code.
CLI_EXIT_CODE_LEGACY  = 'cli.exit_code'
CLI_OUTPUT  = 'Cli.Output'
CLI output handler.
CLI_OUTPUT_LEGACY  = 'cli.output'
CONTAINER  = 'Container'
Dependency injection container instance.
CSRF_TOKEN  = 'Csrf.Token'
CSRF token service instance.
CSRF_TOKEN_LEGACY  = 'CsrfToken'
DTO_FACTORY_SERVICE  = 'Dto.FactoryService'
DTO factory service.
DTO_FACTORY_SERVICE_LEGACY  = 'DtoFactoryService'
EMAIL_VERIFIER  = 'Email.Verifier'
Email verification service.
EMAIL_VERIFIER_LEGACY  = 'EmailVerifier'
EVENT_EMITTER  = 'Event.Emitter'
Event emitter instance.
EVENT_EMITTER_LEGACY  = 'EventEmitter'
EXCEPTIONS_PASSTHROUGH  = 'Exceptions.Passthrough'
List of exception classes that should pass through error handlers.
MAINTENANCE_CONFIG  = 'Maintenance.Config'
Maintenance mode configuration.
MAINTENANCE_CONFIG_LEGACY  = 'maintenance.config'
MAINTENANCE_MANAGER  = 'Maintenance.Manager'
Maintenance mode manager instance.
MAINTENANCE_MANAGER_LEGACY  = 'maintenance.manager'
NAME_LEGACY  = 'name'
PASSTHROUGH_EXCEPTIONS_LEGACY  = 'PassthroughExceptions'
PASSWORD_RESETTER  = 'Password.Resetter'
Password reset service.
PASSWORD_RESETTER_LEGACY  = 'PasswordResetter'
REGISTRATION_SERVICE  = 'Registration.Service'
User registration service.
REGISTRATION_SERVICE_LEGACY  = 'RegistrationService'
REQUESTS_PATH  = 'Requests.Path'
Path to request definitions.
ROUTING_CONTROLLER_PATHS  = 'Routing.ControllerPaths'
Controller paths configuration for route scanning.
RSS_URL_LEGACY  = 'rss_url'
SETTINGS  = 'Settings'
Application settings manager instance.
USER_ID  = 'User.Id'
User ID for rate limiting purposes.
VERSION_LEGACY  = 'version'
VIEW_CACHE  = 'View.Cache'
View cache instance.
VIEW_CACHE_LEGACY  = 'ViewCache'
VIEW_DATA_PROVIDER  = 'View.DataProvider'
View data provider instance.
VIEW_DATA_PROVIDER_LEGACY  = 'ViewDataProvider'
VIEWS_PATH  = 'Views.Path'
Path to view templates.

Constants

APP

The main application instance.

public string APP = 'App'

APP_NAME

Application name.

public string APP_NAME = 'App.Name'

APP_RSS_URL

RSS feed URL for the application.

public string APP_RSS_URL = 'App.RssUrl'

APP_VERSION

Application version string.

public string APP_VERSION = 'App.Version'

AUTH_CSRF_TOKEN

CSRF token for form submissions.

public string AUTH_CSRF_TOKEN = 'Auth.CsrfToken'

AUTH_SERVICE

Authentication service instance.

public string AUTH_SERVICE = 'Auth.Service'

AUTH_USER

Current authenticated user object.

public string AUTH_USER = 'Auth.User'

AUTH_USER_ID

Current authenticated user ID.

public string AUTH_USER_ID = 'Auth.UserId'

AUTH_USER_ROLE

Current authenticated user role.

public string AUTH_USER_ROLE = 'Auth.UserRole'

AUTHENTICATION_LEGACY

Use AUTH_SERVICE instead

public string AUTHENTICATION_LEGACY = 'Authentication'

BASE_PATH

Base directory path of the application.

public string BASE_PATH = 'Base.Path'

BASE_PATH_LEGACY

Use BASE_PATH instead

public string BASE_PATH_LEGACY = 'BasePath'

BASE_URL

Base URL for routing and URL generation.

public string BASE_URL = 'Base.Url'

CLI_APPLICATION

CLI application instance.

public string CLI_APPLICATION = 'Cli.Application'

CLI_APPLICATION_LEGACY

Use CLI_APPLICATION instead

public string CLI_APPLICATION_LEGACY = 'cli.application'

CLI_EXIT_CODE

CLI exit code.

public string CLI_EXIT_CODE = 'Cli.ExitCode'

CLI_EXIT_CODE_LEGACY

Use CLI_EXIT_CODE instead

public string CLI_EXIT_CODE_LEGACY = 'cli.exit_code'

CLI_OUTPUT

CLI output handler.

public string CLI_OUTPUT = 'Cli.Output'

CLI_OUTPUT_LEGACY

Use CLI_OUTPUT instead

public string CLI_OUTPUT_LEGACY = 'cli.output'

CONTAINER

Dependency injection container instance.

public string CONTAINER = 'Container'

CSRF_TOKEN

CSRF token service instance.

public string CSRF_TOKEN = 'Csrf.Token'

CSRF_TOKEN_LEGACY

Use CSRF_TOKEN instead

public string CSRF_TOKEN_LEGACY = 'CsrfToken'

DTO_FACTORY_SERVICE

DTO factory service.

public string DTO_FACTORY_SERVICE = 'Dto.FactoryService'

DTO_FACTORY_SERVICE_LEGACY

Use DTO_FACTORY_SERVICE instead

public string DTO_FACTORY_SERVICE_LEGACY = 'DtoFactoryService'

EMAIL_VERIFIER

Email verification service.

public string EMAIL_VERIFIER = 'Email.Verifier'

EMAIL_VERIFIER_LEGACY

Use EMAIL_VERIFIER instead

public string EMAIL_VERIFIER_LEGACY = 'EmailVerifier'

EVENT_EMITTER

Event emitter instance.

public string EVENT_EMITTER = 'Event.Emitter'

EVENT_EMITTER_LEGACY

Use EVENT_EMITTER instead

public string EVENT_EMITTER_LEGACY = 'EventEmitter'

EXCEPTIONS_PASSTHROUGH

List of exception classes that should pass through error handlers.

public string EXCEPTIONS_PASSTHROUGH = 'Exceptions.Passthrough'

MAINTENANCE_CONFIG

Maintenance mode configuration.

public string MAINTENANCE_CONFIG = 'Maintenance.Config'

MAINTENANCE_CONFIG_LEGACY

Use MAINTENANCE_CONFIG instead

public string MAINTENANCE_CONFIG_LEGACY = 'maintenance.config'

MAINTENANCE_MANAGER

Maintenance mode manager instance.

public string MAINTENANCE_MANAGER = 'Maintenance.Manager'

MAINTENANCE_MANAGER_LEGACY

Use MAINTENANCE_MANAGER instead

public string MAINTENANCE_MANAGER_LEGACY = 'maintenance.manager'

NAME_LEGACY

Use APP_NAME instead

public string NAME_LEGACY = 'name'

PASSTHROUGH_EXCEPTIONS_LEGACY

Use EXCEPTIONS_PASSTHROUGH instead

public string PASSTHROUGH_EXCEPTIONS_LEGACY = 'PassthroughExceptions'

PASSWORD_RESETTER

Password reset service.

public string PASSWORD_RESETTER = 'Password.Resetter'

PASSWORD_RESETTER_LEGACY

Use PASSWORD_RESETTER instead

public string PASSWORD_RESETTER_LEGACY = 'PasswordResetter'

REGISTRATION_SERVICE

User registration service.

public string REGISTRATION_SERVICE = 'Registration.Service'

REGISTRATION_SERVICE_LEGACY

Use REGISTRATION_SERVICE instead

public string REGISTRATION_SERVICE_LEGACY = 'RegistrationService'

REQUESTS_PATH

Path to request definitions.

public string REQUESTS_PATH = 'Requests.Path'

ROUTING_CONTROLLER_PATHS

Controller paths configuration for route scanning.

public string ROUTING_CONTROLLER_PATHS = 'Routing.ControllerPaths'

RSS_URL_LEGACY

Use APP_RSS_URL instead

public string RSS_URL_LEGACY = 'rss_url'

SETTINGS

Application settings manager instance.

public string SETTINGS = 'Settings'

USER_ID

User ID for rate limiting purposes.

public string USER_ID = 'User.Id'

VERSION_LEGACY

Use APP_VERSION instead

public string VERSION_LEGACY = 'version'

VIEW_CACHE

View cache instance.

public string VIEW_CACHE = 'View.Cache'

VIEW_CACHE_LEGACY

Use VIEW_CACHE instead

public string VIEW_CACHE_LEGACY = 'ViewCache'

VIEW_DATA_PROVIDER

View data provider instance.

public string VIEW_DATA_PROVIDER = 'View.DataProvider'

VIEW_DATA_PROVIDER_LEGACY

Use VIEW_DATA_PROVIDER instead

public string VIEW_DATA_PROVIDER_LEGACY = 'ViewDataProvider'

VIEWS_PATH

Path to view templates.

public string VIEWS_PATH = 'Views.Path'

        
On this page

Search results