Actualización

vendor/sonata-project/admin-bundle/Admin/FieldDescriptionInterface.php

@@ -0,0 +1,290 @@
+<?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;
+
+/**
+ * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ */
+interface FieldDescriptionInterface
+{
+    /**
+     * set the field name.
+     *
+     * @param string $fieldName
+     */
+    public function setFieldName($fieldName);
+
+    /**
+     * return the field name.
+     *
+     * @return string the field name
+     */
+    public function getFieldName();
+
+    /**
+     * Set the name.
+     *
+     * @param string $name
+     */
+    public function setName($name);
+
+    /**
+     * Return the name, the name can be used as a form label or table header.
+     *
+     * @return string the name
+     */
+    public function getName();
+
+    /**
+     * Return the value represented by the provided name.
+     *
+     * @param string $name
+     * @param null   $default
+     *
+     * @return array|null the value represented by the provided name
+     */
+    public function getOption($name, $default = null);
+
+    /**
+     * Define an option, an option is has a name and a value.
+     *
+     * @param string $name
+     * @param mixed  $value
+     */
+    public function setOption($name, $value);
+
+    /**
+     * Define the options value, if the options array contains the reserved keywords
+     *   - type
+     *   - template.
+     *
+     * Then the value are copied across to the related property value
+     *
+     * @param array $options
+     */
+    public function setOptions(array $options);
+
+    /**
+     * return options.
+     *
+     * @return array options
+     */
+    public function getOptions();
+
+    /**
+     * return the template used to render the field.
+     *
+     * @param string $template
+     */
+    public function setTemplate($template);
+
+    /**
+     * return the template name.
+     *
+     * @return string the template name
+     */
+    public function getTemplate();
+
+    /**
+     * return the field type, the type is a mandatory field as it used to select the correct template
+     * or the logic associated to the current FieldDescription object.
+     *
+     * @param string $type
+     */
+    public function setType($type);
+
+    /**
+     * return the type.
+     *
+     * @return int|string
+     */
+    public function getType();
+
+    /**
+     * set the parent Admin (only used in nested admin).
+     *
+     * @param AdminInterface $parent
+     */
+    public function setParent(AdminInterface $parent);
+
+    /**
+     * return the parent Admin (only used in nested admin).
+     *
+     * @return AdminInterface
+     */
+    public function getParent();
+
+    /**
+     * Define the association mapping definition.
+     *
+     * @param array $associationMapping
+     */
+    public function setAssociationMapping($associationMapping);
+
+    /**
+     * return the association mapping definition.
+     *
+     * @return array
+     */
+    public function getAssociationMapping();
+
+    /**
+     * return the related Target Entity.
+     *
+     * @return string|null
+     */
+    public function getTargetEntity();
+
+    /**
+     * set the field mapping information.
+     *
+     * @param array $fieldMapping
+     */
+    public function setFieldMapping($fieldMapping);
+
+    /**
+     * return the field mapping definition.
+     *
+     * @return array the field mapping definition
+     */
+    public function getFieldMapping();
+
+    /**
+     * set the parent association mappings information.
+     *
+     * @param array $parentAssociationMappings
+     */
+    public function setParentAssociationMappings(array $parentAssociationMappings);
+
+    /**
+     * return the parent association mapping definitions.
+     *
+     * @return array the parent association mapping definitions
+     */
+    public function getParentAssociationMappings();
+
+    /**
+     * set the association admin instance (only used if the field is linked to an Admin).
+     *
+     * @param AdminInterface $associationAdmin the associated admin
+     */
+    public function setAssociationAdmin(AdminInterface $associationAdmin);
+
+    /**
+     * return the associated Admin instance (only used if the field is linked to an Admin).
+     *
+     * @return AdminInterface
+     */
+    public function getAssociationAdmin();
+
+    /**
+     * return true if the FieldDescription is linked to an identifier field.
+     *
+     * @return bool
+     */
+    public function isIdentifier();
+
+    /**
+     * return the value linked to the description.
+     *
+     * @param mixed $object
+     *
+     * @return bool|mixed
+     */
+    public function getValue($object);
+
+    /**
+     * set the admin class linked to this FieldDescription.
+     *
+     * @param AdminInterface $admin
+     */
+    public function setAdmin(AdminInterface $admin);
+
+    /**
+     * @return AdminInterface the admin class linked to this FieldDescription
+     */
+    public function getAdmin();
+
+    /**
+     * merge option values related to the provided option name.
+     *
+     * @throws \RuntimeException
+     *
+     * @param string $name
+     * @param array  $options
+     */
+    public function mergeOption($name, array $options = []);
+
+    /**
+     * merge options values.
+     *
+     * @param array $options
+     */
+    public function mergeOptions(array $options = []);
+
+    /**
+     * set the original mapping type (only used if the field is linked to an entity).
+     *
+     * @param string|int $mappingType
+     */
+    public function setMappingType($mappingType);
+
+    /**
+     * return the mapping type.
+     *
+     * @return int|string
+     */
+    public function getMappingType();
+
+    /**
+     * return the label to use for the current field.
+     *
+     * @return string
+     */
+    public function getLabel();
+
+    /**
+     * Return the translation domain to use for the current field.
+     *
+     * @return string
+     */
+    public function getTranslationDomain();
+
+    /**
+     * Return true if field is sortable.
+     *
+     * @return bool
+     */
+    public function isSortable();
+
+    /**
+     * return the field mapping definition used when sorting.
+     *
+     * @return array the field mapping definition
+     */
+    public function getSortFieldMapping();
+
+    /**
+     * return the parent association mapping definitions used when sorting.
+     *
+     * @return array the parent association mapping definitions
+     */
+    public function getSortParentAssociationMapping();
+
+    /**
+     * @param object $object
+     * @param string $fieldName
+     *
+     * @return mixed
+     */
+    public function getFieldValue($object, $fieldName);
+}