interface PublicFieldInfoInterface in RESTful 7.2

Hierarchy

• interface \Drupal\restful\Plugin\resource\Field\PublicFieldInfo\PublicFieldInfoInterface

4 files declare their use of PublicFieldInfoInterface

ResourceFieldBase.php in src/Plugin/resource/Field/ResourceFieldBase.php

Contains \Drupal\restful\Plugin\resource\Field\ResourceFieldBase.

ResourceFieldEntity.php in src/Plugin/resource/Field/ResourceFieldEntity.php

Contains \Drupal\restful\Plugin\resource\Field\ResourceFieldEntity

ResourceFieldInterface.php in src/Plugin/resource/Field/ResourceFieldInterface.php

Contains \Drupal\restful\Plugin\resource\Field\ResourceFieldInterface.

ResourceFieldResource.php in src/Plugin/resource/Field/ResourceFieldResource.php

Contains \Drupal\restful\Plugin\resource\Field\ResourceFieldResource.

File

src/Plugin/resource/Field/PublicFieldInfo/PublicFieldInfoInterface.php, line 10

Contains \Drupal\restful\Plugin\resource\Field\PublicFieldInfo\PublicFieldInfoInterface.

Namespace

Drupal\restful\Plugin\resource\Field\PublicFieldInfo

interface PublicFieldInfoInterface {

  /**
   * Generates an structured array ready to be encoded.
   *
   * @return array
   *   The structured array of information.
   */
  public function prepare();

  /**
   * Add categories to the field info.
   *
   * @param string $category_name
   *   The name of the categories. By default RESTful suports 'info',
   *   'form_element' and 'data'.
   * @param array $section_info
   *   The structured array with the section information.
   */
  public function addCategory($category_name, array $section_info);

  /**
   * Gets the section.
   *
   * @param string $section_name
   *   The name of the section. By default RESTful suports 'info',
   *   'form_element' and 'data'.
   *
   * @return array
   *   The structured array with the section information.
   */
  public function getSection($section_name);

  /**
   * Merges default data in a section if it's not populated.
   *
   * @param string $section_name
   *   The name of the categories. By default RESTful suports 'info',
   *   'form_element' and 'data'.
   * @param array $section_info
   *   The structured array with the section information.
   */
  public function addSectionDefaults($section_name, array $section_info);

}

Members

Name	Modifiers	Type	Description	Overrides
PublicFieldInfoInterface::addCategory	public	function	Add categories to the field info.	2
PublicFieldInfoInterface::addSectionDefaults	public	function	Merges default data in a section if it's not populated.	2
PublicFieldInfoInterface::getSection	public	function	Gets the section.	2
PublicFieldInfoInterface::prepare	public	function	Generates an structured array ready to be encoded.	2