Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-09-03 21:34:59 +00:00
Code Issues Actions Projects Releases Wiki Activity

fix folder name

Browse Source
This commit is contained in:
Julien Fastré
2021-03-18 13:37:13 +01:00
parent a2f6773f5a
commit eaa0ad925f
1578 changed files with 0 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
src/Bundle/ChillCustomFieldsBundle/Service/CustomFieldProvider.php Normal file
View File

@@ -0,0 +1,103 @@
<?php
/*
* Chill is a software for social workers
*
* Copyright (C) 2014-2015, Champs Libres Cooperative SCRLFS,
* <http://www.champs-libres.coop>, <info@champs-libres.coop>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Chill\CustomFieldsBundle\Service;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* 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>
*/
class CustomFieldProvider implements ContainerAwareInterface
{
/** @var array $servicesByType The services indexes by the type */
private $servicesByType = array();
/** @var Container $container The 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)
{
$this->servicesByType[$type] = $serviceName;
}
/**
* Get a custom field stored in the provider. The custom field is identified
* by its type.
*
* @param string $type The type of the wanted service
* @return CustomFieldInterface
*/
public function getCustomFieldByType($type)
{
if (isset($this->servicesByType[$type])) {
return $this->servicesByType[$type];
} else {
throw new \LogicException('the custom field with type '.$type.' '
. 'is not found');
}
}
/*
* (non-PHPdoc)
* @see \Symfony\Component\DependencyInjection\ContainerAwareInterface::setContainer()
*/
public function setContainer(ContainerInterface $container = null)
{
if ($container === null) {
throw new \LogicException('container should not be null');
}
$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()
{
return $this->servicesByType;
}
}

90
src/Bundle/ChillCustomFieldsBundle/Service/CustomFieldsHelper.php Normal file
View File

@@ -0,0 +1,90 @@
<?php
/*
* Chill is a software for social workers
*
* Copyright (C) 2014-2015, Champs Libres Cooperative SCRLFS,
* <http://www.champs-libres.coop>, <info@champs-libres.coop>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Chill\CustomFieldsBundle\Service;
use Doctrine\ORM\EntityManagerInterface;
use Chill\CustomFieldsBundle\Service\CustomFieldProvider;
use Chill\CustomFieldsBundle\Entity\CustomFieldsGroup;
use Chill\CustomFieldsBundle\Entity\CustomField;
/**
* Helpers for manipulating custom fields.
*
* Herlpers for getting a certain custom field, for getting the raw value
* of a custom field and for rendering the value of a custom field.
*
* @author Julien Fastré <julien.fastre@champs-libres.coop>
*
*/
class CustomFieldsHelper
{
/** @var EntityManagerInterface $em The entity manager */
private $em;
/** @var CustomFieldProvider $provider Provider of all the declared custom
* fields */
private $provider;
/**
* Constructor
*
* @param EntityManagerInterface $em The entity manager
* @param CustomFieldProvider $provider The customfield provider that
* contains all the declared custom fields
*/
public function __construct(EntityManagerInterface $em,
CustomFieldProvider $provider)
{
$this->em = $em;
$this->provider = $provider;
}
public function isEmptyValue(array $fields, CustomField $customField)
{
$slug = $customField->getSlug();
$rawValue = (isset($fields[$slug])) ? $fields[$slug] : null;
$customFieldType = $this->provider->getCustomFieldByType($customField->getType());
$deserializedValue = $customFieldType->deserialize($rawValue, $customField);
return $customFieldType->isEmptyValue($deserializedValue, $customField);
}
/**
* Render the value of a custom field
*
* @param array $fields the **raw** array, as stored in the db
* @param CustomField $customField the customField entity
* @param string $documentType The type of document in which the rendered value is displayed ('html' or 'csv').
* @throws CustomFieldsHelperException if slug is missing
* @return The representation of the value the customField.
*/
public function renderCustomField(array $fields, CustomField $customField, $documentType='html')
{
$slug = $customField->getSlug();
$rawValue = (isset($fields[$slug])) ? $fields[$slug] : null;
$customFieldType = $this->provider->getCustomFieldByType($customField->getType());
return $customFieldType->render($rawValue, $customField, $documentType);
}
}

36
src/Bundle/ChillCustomFieldsBundle/Service/CustomFieldsHelperException.php Normal file
View File

@@ -0,0 +1,36 @@
<?php
/*
* Chill is a software for social workers
*
* Copyright (C) 2014-2015, Champs Libres Cooperative SCRLFS,
* <http://www.champs-libres.coop>, <info@champs-libres.coop>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Chill\CustomFieldsBundle\Service;
class CustomFieldsHelperException extends \Exception
{
public static function customFieldsGroupNotFound($entity)
{
return new CustomFieldsHelperException("The customFieldsGroups associated with $entity are not found");
}
public static function slugIsMissing()
{
return new CustomFieldsHelperException("The slug is missing");
}
}