2010-01-04 14:26:20 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Symfony\Components\DependencyInjection;
|
|
|
|
|
|
|
|
/*
|
2010-04-07 01:51:29 +01:00
|
|
|
* This file is part of the Symfony framework.
|
2010-01-04 14:26:20 +00:00
|
|
|
*
|
|
|
|
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*
|
|
|
|
* This source file is subject to the MIT license that is bundled
|
|
|
|
* with this source code in the file LICENSE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Definition represents a service definition.
|
|
|
|
*
|
2010-04-07 01:51:29 +01:00
|
|
|
* @package Symfony
|
|
|
|
* @subpackage Components_DependencyInjection
|
2010-01-04 14:26:20 +00:00
|
|
|
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*/
|
|
|
|
class Definition
|
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
protected $class;
|
|
|
|
protected $file;
|
2010-07-05 08:47:14 +01:00
|
|
|
protected $factoryMethod;
|
2010-07-03 23:35:39 +01:00
|
|
|
protected $factoryService;
|
|
|
|
protected $factoryClass;
|
2010-05-06 12:25:53 +01:00
|
|
|
protected $shared;
|
|
|
|
protected $arguments;
|
|
|
|
protected $calls;
|
|
|
|
protected $configurator;
|
|
|
|
protected $annotations;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
|
|
|
* @param string $class The service class
|
|
|
|
* @param array $arguments An array of arguments to pass to the service constructor
|
|
|
|
*/
|
|
|
|
public function __construct($class, array $arguments = array())
|
2010-01-04 14:26:20 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->class = $class;
|
|
|
|
$this->arguments = $arguments;
|
|
|
|
$this->calls = array();
|
|
|
|
$this->shared = true;
|
|
|
|
$this->annotations = array();
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
2010-07-05 08:47:14 +01:00
|
|
|
* Sets the factory method able to create an instance of this class.
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @param string $method The method name
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
2010-07-05 08:47:14 +01:00
|
|
|
public function setFactoryMethod($method)
|
2010-02-09 08:45:23 +00:00
|
|
|
{
|
2010-07-05 08:47:14 +01:00
|
|
|
$this->factoryMethod = $method;
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2010-07-05 08:47:14 +01:00
|
|
|
* Gets the factory method.
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
2010-07-03 23:35:39 +01:00
|
|
|
* @return string The factory method name
|
2010-05-06 12:25:53 +01:00
|
|
|
*/
|
2010-07-05 08:47:14 +01:00
|
|
|
public function getFactoryMethod()
|
2010-05-06 12:25:53 +01:00
|
|
|
{
|
2010-07-05 08:47:14 +01:00
|
|
|
return $this->factoryMethod;
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
|
|
|
|
2010-07-03 23:35:39 +01:00
|
|
|
/**
|
|
|
|
* Set the name of the service that acts as a factory using the specified `constructor` method.
|
|
|
|
*
|
|
|
|
* @param string
|
|
|
|
*/
|
|
|
|
public function setFactoryService($factoryService)
|
|
|
|
{
|
|
|
|
$this->factoryService = $factoryService;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getFactoryService()
|
|
|
|
{
|
|
|
|
return $this->factoryService;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* If service has a constructor method but no factory service, this class is the static callback.
|
|
|
|
*
|
|
|
|
* @param string $factoryClass
|
|
|
|
* @return Definition
|
|
|
|
*/
|
|
|
|
public function setFactoryClass($factoryClass)
|
|
|
|
{
|
|
|
|
$this->factoryClass = $factoryClass;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the current static create class for this service.
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getFactoryClass()
|
|
|
|
{
|
|
|
|
return $this->factoryClass;
|
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Sets the service class.
|
|
|
|
*
|
|
|
|
* @param string $class The service class
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function setClass($class)
|
|
|
|
{
|
|
|
|
$this->class = $class;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2010-07-05 08:47:14 +01:00
|
|
|
* Sets the service class.
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @return string The service class
|
|
|
|
*/
|
|
|
|
public function getClass()
|
|
|
|
{
|
|
|
|
return $this->class;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2010-07-05 08:47:14 +01:00
|
|
|
* Sets the arguments to pass to the service constructor/factory method.
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @param array $arguments An array of arguments
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function setArguments(array $arguments)
|
|
|
|
{
|
|
|
|
$this->arguments = $arguments;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2010-07-05 08:47:14 +01:00
|
|
|
* Adds an argument to pass to the service constructor/factory method.
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @param mixed $argument An argument
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function addArgument($argument)
|
|
|
|
{
|
|
|
|
$this->arguments[] = $argument;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2010-07-05 08:47:14 +01:00
|
|
|
* Gets the arguments to pass to the service constructor/factory method.
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @return array The array of arguments
|
|
|
|
*/
|
|
|
|
public function getArguments()
|
|
|
|
{
|
|
|
|
return $this->arguments;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the methods to call after service initialization.
|
|
|
|
*
|
|
|
|
* @param array $calls An array of method calls
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function setMethodCalls(array $calls = array())
|
|
|
|
{
|
|
|
|
$this->calls = array();
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($calls as $call) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->addMethodCall($call[0], $call[1]);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds a method to call after service initialization.
|
|
|
|
*
|
|
|
|
* @param string $method The method name to call
|
|
|
|
* @param array $arguments An array of arguments to pass to the method call
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function addMethodCall($method, array $arguments = array())
|
|
|
|
{
|
|
|
|
$this->calls[] = array($method, $arguments);
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the methods to call after service initialization.
|
|
|
|
*
|
|
|
|
* @return array An array of method calls
|
|
|
|
*/
|
|
|
|
public function getMethodCalls()
|
|
|
|
{
|
|
|
|
return $this->calls;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns all annotations.
|
|
|
|
*
|
|
|
|
* @return array An array of annotations
|
|
|
|
*/
|
|
|
|
public function getAnnotations()
|
|
|
|
{
|
|
|
|
return $this->annotations;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets an annotation by name.
|
|
|
|
*
|
|
|
|
* @param string $name The annotation name
|
|
|
|
*
|
|
|
|
* @return array An array of attributes
|
|
|
|
*/
|
|
|
|
public function getAnnotation($name)
|
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!isset($this->annotations[$name])) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->annotations[$name] = array();
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->annotations[$name];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds an annotation for this definition.
|
|
|
|
*
|
|
|
|
* @param string $name The annotation name
|
|
|
|
* @param array $attributes An array of attributes
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function addAnnotation($name, array $attributes = array())
|
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!isset($this->annotations[$name])) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->annotations[$name] = array();
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->annotations[$name][] = $attributes;
|
|
|
|
|
|
|
|
return $this;
|
2010-02-09 08:45:23 +00:00
|
|
|
}
|
|
|
|
|
2010-06-15 22:22:54 +01:00
|
|
|
/**
|
|
|
|
* Clears the annotation for this definition.
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function clearAnnotations()
|
|
|
|
{
|
|
|
|
$this->annotations = array();
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Sets a file to require before creating the service.
|
|
|
|
*
|
|
|
|
* @param string $file A full pathname to include
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function setFile($file)
|
2010-02-09 08:45:23 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->file = $file;
|
|
|
|
|
|
|
|
return $this;
|
2010-02-09 08:45:23 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the file to require before creating the service.
|
|
|
|
*
|
|
|
|
* @return string The full pathname to include
|
|
|
|
*/
|
|
|
|
public function getFile()
|
|
|
|
{
|
|
|
|
return $this->file;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets if the service must be shared or not.
|
|
|
|
*
|
|
|
|
* @param Boolean $shared Whether the service must be shared or not
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function setShared($shared)
|
|
|
|
{
|
|
|
|
$this->shared = (Boolean) $shared;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns true if the service must be shared.
|
|
|
|
*
|
|
|
|
* @return Boolean true if the service is shared, false otherwise
|
|
|
|
*/
|
|
|
|
public function isShared()
|
|
|
|
{
|
|
|
|
return $this->shared;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets a configurator to call after the service is fully initialized.
|
|
|
|
*
|
|
|
|
* @param mixed $callable A PHP callable
|
|
|
|
*
|
|
|
|
* @return Definition The current instance
|
|
|
|
*/
|
|
|
|
public function setConfigurator($callable)
|
|
|
|
{
|
|
|
|
$this->configurator = $callable;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the configurator to call after the service is fully initialized.
|
|
|
|
*
|
|
|
|
* @return mixed The PHP callable to call
|
|
|
|
*/
|
|
|
|
public function getConfigurator()
|
|
|
|
{
|
|
|
|
return $this->configurator;
|
|
|
|
}
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|