PHPackages                             axis/axis-service-container-plugin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. axis/axis-service-container-plugin

AbandonedArchivedSymfony1-plugin[Utility & Helpers](/categories/utility)

axis/axis-service-container-plugin
==================================

symfony 1.x plugin that improves factories.yml config handler using Pimple and advanced configuring features

1.1(11y ago)3665[2 issues](https://github.com/e1himself/axis-service-container-plugin/issues)MITPHPPHP >=5.3.0

Since Sep 6Pushed 11y ago1 watchersCompare

[ Source](https://github.com/e1himself/axis-service-container-plugin)[ Packagist](https://packagist.org/packages/axis/axis-service-container-plugin)[ Docs](https://github.com/e1himself/axis-service-container-plugin)[ RSS](/packages/axis-axis-service-container-plugin/feed)WikiDiscussions master Synced yesterday

READMEChangelog (2)Dependencies (2)Versions (3)Used By (0)

AxisServiceContainerPlugin
==========================

[](#axisservicecontainerplugin)

This plugin allows to add any amount of factories configuration to symfony factories.yml using [Pimple](http://pimple.sensiolabs.org/) as service container.

Also it adds a rich functionality for instantiating and configuring factories.

Installation
------------

[](#installation)

### Composer way

[](#composer-way)

1. Add `axis/axis-service-container-plugin` dependency to your `composer.json`:

```
  "require": {
    "axis/axis-service-container-plugin": "dev-master"
  }
```

2. Enable `AxisServiceContainerPlugin` plugin in your `ProjectConfiguration.class.php`.
3. Include `lib/vendor/autoload.php` file generated by Composer if it wasn't included yet. `ProjectConfiguration.class.php`:

```
include __DIR__.'/../lib/vendor/autoload.php';
```

Defining Services
-----------------

[](#defining-services)

### Basic definition

[](#basic-definition)

You can define any services like the standard symfony `factories.yml` does. Assume that you have your service implemented in `MyBasicServiceImplementation` class:

```
class MyBasicServiceImplementation implements MyService
{
  public function doSomething()
  {
    echo 'Yep. It works!';
  }
}
```

And you want you define it using symfony context factories. So you need just to add its instantiation configuration to your `factories.yml`:

```
  my_service:
    class: MyBasicServiceImplementation
```

Now you can retrieve an instance of that class in your code:

```
/** @var $myService MyService */
$myService = sfContext:getInstance()->get('my_service');
$myService->doSomething(); // echoes "Yep. It works!"
```

---

*Note*: all services are stored to [**Pimple**](http://pimple.sensiolabs.org/) service container using `share` method. This means that each service is a [shared objects](http://pimple.sensiolabs.org/#defining-shared-objects) instantiated only once it was requested first time.

### Definition with parameters

[](#definition-with-parameters)

Assume you want to instantiate a `MyParamServiceImplementation` class that have a parameterized constructor.

```
class MyParamServiceImplementation implements MyService
{
  protected $greating;

  public funciton __construct($greating = 'Yep. It works!')
  {
    $this->greating = $greating;
  }
  public function doSomething()
  {
    echo $this->greating;
  }
}
```

You can use `parameters` configuration option listing all constructor parameters in *any* order but preserving *exact names*:

```
  my_service:
    class: MyParamServiceImplementation
    parameters:
      greating: "Hooray!"
```

The usage is the same:

```
/** @var $myService MyService */
$myService = sfContext:getInstance()->get('my_service');
$myService->doSomething(); // echoes "Hooray!"
```

### Instant initialization

[](#instant-initialization)

If your service should be instantiated (and thereby initialized) on startup you can use `initialization` config parameter. The only value the plugin supports is `instant`. Any other value is treated as undefined and meaningless.

```
  my_service:
    class: MyBasicServiceImplementation
    initialization: instant
```

By defining `initialization: instant` you tell that `my_service` should be instantiated just after the symfony context is created.

### Including file

[](#including-file)

If your service class is not loaded automatically with symfony autoloader or any other configured autoloaders you can use `file` configuration option to tell symfony to include that file on context creation.

```
  my_service:
    class: MyServiceImplementation
    file:  %SF_ROOT_DIR%/lib/vendor/my_company/MyServiceImplementation.php
```

### Tagging

[](#tagging)

You can mark your services with tags. This allows your to retrieve all defined services from context that have a specific tag assigned. Use `tag` option.

```
  my_service1:
    class: MySimpleService
    tag: greater

  my_service2:
    class: MyAdvancedService
    tag: greater
```

After this you can retreive all services from context using a hash-prefixed tag name:

```
/** @var $services array */
$services = sfContext:getInstance()->get('#greater');
var_dump(array_map('get_class', $services));
// will output "array('MySimpleService', 'MyAdvancedService')"
```

Service Parameters
------------------

[](#service-parameters)

When defining services sometimes you need to define constructor parameters values. Sometimes it is not enough to use just constant values. AxisServiceContainerPlugin allows you to use advanced parameter processing.

### Config value

[](#config-value)

If you want instantiate a service with a config value passed as parameter you can use `config` parameter processor:

```
  my_service:
    class: MyParamServiceImplementation
    parameters:
      greating: config://app_my_service_greating
```

It will instantiate `my_service` passing `sfConfig::get('app_my_service_greating')` value as `$greating` parameter.

#### Config value with default

[](#config-value-with-default)

Also you can use default value for config getter:

```
  my_service:
    class: MyParamServiceImplementation
    parameters:
      greating: config://app_my_service_greating|Wow! It supports default value!
```

This code will instantiate `my_service` passing `sfConfig::get('app_my_service_greating', "Wow! It supports default value!")` value as `$greating` parameter.

### Defined service

[](#defined-service)

Sometimes its handy to pass any other defined service to your service constructor as parameter.

```
  my_service_transport:
    class: SoapClient
    parameters:
      wsdl:  http://services.mycompany.com/?WSDL

  my_service:
    class: MyRemoteService
    parameters:
      transport: context://my_service_transport
```

Now retrieving `my_service` from context service container will return a `my_service` service instance with `my_service_transport` service instance passed as `$transport` parameter to its constructor.

### Defined services with a specific tag

[](#defined-services-with-a-specific-tag)

Sometimes you may want to pass to service constructor a collection of services with a specific tag assigned. We can do that!

```
  my_service.extension.a:
    class: MyServiceExtensionA
    tag: my_service.extension

  my_service.extension.b:
    class: MyServiceExtensionA
    tag: my_service.extension

  my_service:
    class: MyService
    parameters:
      extensions: tag://my_service.extension
```

### Raw value

[](#raw-value)

And if you want to pass actual string value prefixed with special words and leave it unprocessed use `raw` prefix:

```
  my_service:
    class: MyService
    parameters:
      greating: raw://config://This doesn't mean anything. It's just a string value
```

### Parameters within arrays

[](#parameters-within-arrays)

You can use any smart parameters processing in arrays passed as parameter values. For example you can do this:

```
  my_service:
    class: MyService
    parameters:
      options:
        transport: context://my_service_transport
        name: config://app_my_service_name|MyService
```

Declared services
-----------------

[](#declared-services)

Service container has declared services at the very beginning. They include standard symfony factories and core context entities.

### Standard symfony services

[](#standard-symfony-services)

- `view_cache_manager`
- `logger`
- `i18n`
- `controller`
- `request`
- `response`
- `routing`
- `storage`
- `user`
- `view_cache`
- `mailer`

All of this services can be used as initialization parameter using context:// parameter processor.

### Additional plugin services

[](#additional-plugin-services)

Additionally plugin appends to the service container next services:

- `context` - symfony context instance
- `configuration` - current application configuration
- `dispatcher` - symfony event dispatcher
- `config_cache` - symfony config cache manager. Useful when your service relies on .yml files caching
- `service_container` - the service container instance itself (useful for using service container public API inaccessible via sfContext instance)

Known issues
------------

[](#known-issues)

- You cannot configure [standard symfony services](#standard-symfony-services) using all plugin features. Standard services are handled by default symfony `sfFactoryConfigHandler`.

What's new
----------

[](#whats-new)

1.1 - Output Service container generated config cache code *before* `sfFactoryConfigHandler` code. - Added `config_cache` to predefined services 1.0.0 - First stable release

###  Health Score

25

—

LowBetter than 35% of packages

Maintenance7

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~327 days

Total

2

Last Release

4355d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6d24c797f078b59b84f555eb4ac8b468424e3b29740180a4abb5ca5bc51e27f5?d=identicon)[7heaven](/maintainers/7heaven)

---

Top Contributors

[![e1himself](https://avatars.githubusercontent.com/u/370680?v=4)](https://github.com/e1himself "e1himself (26 commits)")

---

Tags

symfonydependency-injectionpimpleservice containerfactories

### Embed Badge

![Health badge](/badges/axis-axis-service-container-plugin/health.svg)

```
[![Health](https://phpackages.com/badges/axis-axis-service-container-plugin/health.svg)](https://phpackages.com/packages/axis-axis-service-container-plugin)
```

###  Alternatives

[helsingborg-stad/municipio

A bootstrap theme for creating municipality sites.

4028.5k10](/packages/helsingborg-stad-municipio)[oat-sa/tao-core

TAO core extension

66143.7k122](/packages/oat-sa-tao-core)[mediawiki/maps

Adds various mapping features to MediaWiki

84152.3k3](/packages/mediawiki-maps)[starcitizentools/citizen-skin

A beautiful, usable, responsive MediaWiki skin with in-depth extension support. Originally developed for the Star Citizen Wiki.

3376.6k](/packages/starcitizentools-citizen-skin)[civicrm/civicrm-drupal-8

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

19251.4k3](/packages/civicrm-civicrm-drupal-8)[altis/core

Core module for Altis

19228.0k3](/packages/altis-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)