MODX Services

What is a Service?¶

A service is any object stored in the dependency injection container ($modx->services). Many extras still load services with $modx->getService, a 2.x pattern that is deprecated in 3.x. Prefer has / add / get on $modx->services.

Once a service is in the container, you can also hang it on $modx yourself ($modx->error = $modx->services->get('error')). getService did that automatically.

$modx->services->add('twitter', function($c) use ($modx) {
    return new MyPackage\Twitter($modx, ['api_key' => 3212423]);
});
$modx->services->get('twitter')->tweet('Success!');

What are the Default Included Services?¶

A few services are registered in the container during MODX initialization:

• registry — modRegistry, instantiated eagerly at the end of modX::initialize();
• the seven PSR HTTP services listed on the HTTP Services page (ClientInterface, ServerRequestFactoryInterface, RequestFactoryInterface, StreamFactoryInterface, ResponseFactoryInterface, UploadedFileFactoryInterface, UriFactoryInterface);
• modManagerDateFormatter (registered under its class name), used by the manager;
• lexicon, error and parser are also placed in the container as initialization proceeds.

Other core services are part of the distribution but are loaded on demand via $modx->getService rather than pre-registered:

• modFileHandler
• modMail

See Also¶

• modX.getService
• Dependency Injection Container