123 lines
3.0 KiB
PHP
123 lines
3.0 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Sonata Project package.
|
|
*
|
|
* (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Sonata\AdminBundle\Admin;
|
|
|
|
/**
|
|
* Implementations should provide arrays of FieldDescriptionInterface instances.
|
|
*
|
|
* @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
|
|
*/
|
|
interface FieldDescriptionRegistryInterface
|
|
{
|
|
/**
|
|
* Return FormFieldDescription.
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return FieldDescriptionInterface
|
|
*/
|
|
public function getFormFieldDescription($name);
|
|
|
|
/**
|
|
* Build and return the collection of form FieldDescription.
|
|
*
|
|
* @return FieldDescriptionInterface[] collection of form FieldDescription
|
|
*/
|
|
public function getFormFieldDescriptions();
|
|
|
|
/**
|
|
* Returns true if the admin has a FieldDescription with the given $name.
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasShowFieldDescription($name);
|
|
|
|
/**
|
|
* Adds a FieldDescription.
|
|
*
|
|
* @param string $name
|
|
* @param FieldDescriptionInterface $fieldDescription
|
|
*/
|
|
public function addShowFieldDescription($name, FieldDescriptionInterface $fieldDescription);
|
|
|
|
/**
|
|
* Removes a ShowFieldDescription.
|
|
*
|
|
* @param string $name
|
|
*/
|
|
public function removeShowFieldDescription($name);
|
|
|
|
/**
|
|
* Adds a list FieldDescription.
|
|
*
|
|
* @param string $name
|
|
* @param FieldDescriptionInterface $fieldDescription
|
|
*/
|
|
public function addListFieldDescription($name, FieldDescriptionInterface $fieldDescription);
|
|
|
|
/**
|
|
* Removes a list FieldDescription.
|
|
*
|
|
* @param string $name
|
|
*/
|
|
public function removeListFieldDescription($name);
|
|
|
|
/**
|
|
* Returns a list depend on the given $object.
|
|
*
|
|
* @return FieldDescriptionCollection
|
|
*/
|
|
public function getList();
|
|
|
|
/**
|
|
* Returns true if the filter FieldDescription exists.
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasFilterFieldDescription($name);
|
|
|
|
/**
|
|
* Adds a filter FieldDescription.
|
|
*
|
|
* @param string $name
|
|
* @param FieldDescriptionInterface $fieldDescription
|
|
*/
|
|
public function addFilterFieldDescription($name, FieldDescriptionInterface $fieldDescription);
|
|
|
|
/**
|
|
* Removes a filter FieldDescription.
|
|
*
|
|
* @param string $name
|
|
*/
|
|
public function removeFilterFieldDescription($name);
|
|
|
|
/**
|
|
* Returns the filter FieldDescription collection.
|
|
*
|
|
* @return FieldDescriptionInterface[]
|
|
*/
|
|
public function getFilterFieldDescriptions();
|
|
|
|
/**
|
|
* Returns a filter FieldDescription.
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return FieldDescriptionInterface|null
|
|
*/
|
|
public function getFilterFieldDescription($name);
|
|
}
|