Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-13 13:54:23 +00:00
Code Issues Actions Projects Releases Wiki Activity

Adding doc to Service/CustomFieldProvider.php

Browse Source
This commit is contained in:
Marc Ducobu 2015-03-18 13:52:10 +01:00
parent 52aa147ed7
commit 3534e64d28
1 changed files with 35 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Service/CustomFieldProvider.php
View File

@ -26,28 +26,46 @@ use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
/** /**
* Receive all service tagged with 'chill.custom_field' * Receive all the services tagged with 'chill.custom_field'.
* *
* The services tagged with 'chill.custom_field' are services used to declare
* a new custom field type. The tag must contain a 'type' variable (that must
* be unique), this type is used to identify this custom field in the form
* declration
*
* For example (in services.yml) :
* services:
* chill.icp2.type:
* tags:
* - { name: 'chill.custom_field', type: 'ICPC2' }
*
* @author Julien Fastré <julien.fastre@champs-libres.coop> * @author Julien Fastré <julien.fastre@champs-libres.coop>
*/ */
class CustomFieldProvider implements ContainerAwareInterface class CustomFieldProvider implements ContainerAwareInterface
{ {
/** @var array $servicesByType The services indexes by the type */
private $servicesByType = array(); private $servicesByType = array();
/** /** @var Container $container The container */
*
* @var \Symfony\Component\DependencyInjection\ContainerInterface
*/
private $container; private $container;
/**
* Add a new custom field to the provider
*
* @param type $serviceName The name of the service (declared in service.yml)
* @param type $type The type of the service (that is used in the form to
* add this type)
*/
public function addCustomField($serviceName, $type) public function addCustomField($serviceName, $type)
{ {
$this->servicesByType[$type] = $serviceName; $this->servicesByType[$type] = $serviceName;
} }
/** /**
* Get a custom field stored in the provider. The custom field is identified
* by its type.
* *
* @param string $type * @param string $type The type of the wanted service
* @return CustomFieldInterface * @return CustomFieldInterface
*/ */
public function getCustomFieldByType($type) public function getCustomFieldByType($type)
@ -56,10 +74,14 @@ class CustomFieldProvider implements ContainerAwareInterface
return $this->servicesByType[$type]; return $this->servicesByType[$type];
} else { } else {
throw new \LogicException('the custom field with type '.$type.' ' throw new \LogicException('the custom field with type '.$type.' '
. 'is not found'); . 'is not found');
} }
} }
/*
* (non-PHPdoc)
* @see \Symfony\Component\DependencyInjection\ContainerAwareInterface::setContainer()
*/
public function setContainer(ContainerInterface $container = null) public function setContainer(ContainerInterface $container = null)
{ {
if ($container === null) { if ($container === null) {
@ -69,9 +91,13 @@ class CustomFieldProvider implements ContainerAwareInterface
$this->container = $container; $this->container = $container;
} }
/**
* Get all the custom fields known by the provider
*
* @return array Array of the known custom fields indexed by the type.
*/
public function getAllFields() public function getAllFields()
{ {
return $this->servicesByType; return $this->servicesByType;
} }
} }