Skip to content

Config

Everything under Quiote\Config.

ClassDescription
APCuConfigCacheAPCu-based configuration cache with warmup for Kubernetes/FrankenPHP deployments This class provides both warmup functionality and drop-in replacement methods for ConfigCache.
BaseConfigHandlerBaseConfigHandler allows a developer to create a custom formatted configuration file pertaining to any information they like.
CachingConfigHandlerCachingConfigHandler compiles the per-action configuration files placed in the “cache” subfolder of a module directory.
CompileConfigHandlerCompileConfigHandler gathers multiple files and puts them into a single file.
CompiledArtifactSerializes a config handler’s declaration into the PHP file the on-disk cache holds.
CompiledConfigReads the value of a compiled configuration through whichever cache implementation is active.
ConfigStatic facade over the application’s configuration.
ConfigCacheConfigCache allows you to customize the format of a configuration file to make it easy-to-use, yet still provide a PHP formatted result for direct inclusion into your modules.
ConfigHandlerConfigHandler allows a developer to create a custom formatted configuration file pertaining to any information they like and still have it auto-generate PHP code.
ConfigHandlersConfigHandlerConfigHandlersConfigHandler allows you to specify configuration handlers for the application or on a module level.
ConfigParserConfigParser parses XML files using XmlConfigParser, but returns old-style ConfigValueHolders.
ConfigRepositoryAn instance-backed store of configuration directives, with typed accessors that fail loudly when a directive does not hold the shape the caller asked for.
ConfigValueHolderConfigValueHolder is the storage class for the XmlConfigHandler
DatabaseConfigHandlerDatabaseConfigHandler allows you to setup database connections in a configuration file that will be created for you automatically upon first request.
EnvPlaceholderThe %env(NAME)% / %env(NAME, fallback)% placeholder: a configuration value that comes from the process environment.
FactoryConfigHandlerFactoryConfigHandler allows you to specify which factory implementation the system will use.
MiddlewareConfigHandlerMiddlewareConfigHandler reads a middleware.{xml,php,yaml,yml} file — a flat list of <use> entries that register app/plugin middleware and/or override the placement or enabled state of any middleware (framework or app) known to #[Quiote\Middleware\Attribute\Middleware] scanning.
ModuleConfigHandlerModuleConfigHandler reads module configuration files to determine the status of a module.
OutputTypeConfigHandlerOutputTypeConfigHandler handles output type configuration files.
PluginConfigHandlerPluginConfigHandler reads a plugins.{xml,php,yaml,yml} file — the correct, documented way to register plugins — a flat, ordered enable/disable list of plugin classes — and appends the enabled ones to the plugins config key that PluginManager::bootFromConfig() already reads.
RbacDefinitionConfigHandlerRbacDefinitionConfigHandler handles RBAC role and permission definition files.
ReturnArrayConfigHandlerReturnArrayConfigHandler allows you to retrieve the contents of a config file as an array.
SettingConfigHandlerSettingConfigHandler handles the settings.xml file.
TestSuitesConfigHandlerTestSuitesConfigHandler reads the testsuites configuration files to determine the available suites and their tests.
TranslationConfigHandlerTranslationConfigHandler allows you to define translator implementations for different domains.
ValidatorConfigHandlerCompiles a validators.xml document into a compiled Quiote configuration file: a declaration of the validators to build, which ValidatorDeclarationApplier registers onto a validation manager.
XmlConfigHandlerXmlConfigHandler is the base config handler that deals with DOMDocuments
XmlConfigParserXmlConfigParser handles both Quiote and foreign XML configuration files, deals with XIncludes, XSL transformations and validation as well as filtering and ordering of configuration blocks and parent file resolution and parsing.
InterfaceDescription
IArrayConfigHandlerA ConfigHandler on the array-based contract: its compilation logic (executeArray()) consumes a plain, canonical array instead of walking a DOM, so the same logic works whether that array came from XML, a PHP-array file, or YAML.
IDeclarationConfigHandlerA config handler whose compiled artifact is a declaration — data — plus the code that applies that data to runtime state.
ILegacyConfigHandlerILegacyConfigHandler is the interface that all old-style config handlers which deal with ConfigValueHolders and parse configs themselves implement.
IPositionAwareConfigHandlerOpt-in, like ISchemaAwareConfigHandler: a handler implements this once it knows how to correlate its own canonical-array key paths back to the elements it read them from.
ISchemaAwareConfigHandlerOpt-in: a handler implements this once its canonical array shape has a meaningful, hand-authored structural schema.
IXmlConfigHandlerIXmlConfigHandler is the interface that config handlers may implement to indicate that they wish to process a DOMDocument directly.
NamespaceContents
Factory3 types
Format13 types
Schema5 types
Util13 types