interface OgFieldsInterface in Organic groups 8

The OG fields related interface.

Hierarchy

• interface \Drupal\og\OgFieldsInterface

3 files declare their use of OgFieldsInterface

AccessField.php in src/Plugin/OgFields/AccessField.php

AudienceField.php in src/Plugin/OgFields/AudienceField.php

EntityRestrictedField.php in tests/modules/og_test/src/Plugin/OgFields/EntityRestrictedField.php

File

src/OgFieldsInterface.php, line 10

Namespace

Drupal\og

interface OgFieldsInterface {

  /**
   * Set the bundle.
   *
   * @param string $bundle
   *   The entity bundle.
   *
   * @return $this
   */
  public function setBundle($bundle);

  /**
   * Get the bundle name.
   *
   * @return string
   *   The entity bundle.
   */
  public function getBundle();

  /**
   * Get the entity type name.
   *
   * @return string
   *   The entity type name.
   */
  public function getEntityType();

  /**
   * Set the entity type.
   *
   * @param string $entity_type
   *   The entity type.
   *
   * @return $this
   *
   * @throws \Exception
   *   Throw error if the field storage config definition explicitly defines to
   *   which entities the field can be attached to.
   */
  public function setEntityType($entity_type);

  /**
   * Get the field name.
   *
   * @return string
   *   The field name.
   */
  public function getFieldName();

  /**
   * Set the field name.
   *
   * The field name is often the same as the plugin ID, however it is
   * overridable. For example, the group audience field is identified as
   * \Drupal\og\OgGroupAudienceHelper::DEFAULT_FIELD, however the actual field
   * name attached to the bundle can be arbitrary.
   *
   * @param string $field_name
   *   The field name.
   *
   * @return $this
   */
  public function setFieldName($field_name);

  /**
   * Get the field storage config base definition.
   *
   * @param array $values
   *   Values to override the base definitions.
   *
   * @return array
   *   Array that will be used as the base values for
   *   FieldStorageConfig::create().
   */
  public function getFieldStorageBaseDefinition(array $values = []);

  /**
   * Get the field config base definition.
   *
   * @param array $values
   *   Values to override the base definitions.
   *
   * @return array
   *   Array that will be used as the base values for
   *   FieldConfig::create().
   */
  public function getFieldBaseDefinition(array $values = []);

  /**
   * Get the field's form display definition.
   *
   * @param array $values
   *   Values to override the base definitions.
   *
   * @return array
   *   Array that will be used as the base values for
   *   FieldConfig::create().
   */
  public function getFormDisplayDefinition(array $values = []);

  /**
   * Get the field's view modes definition.
   *
   * @param array $values
   *   Values to override the base definitions.
   *
   * @return array
   *   Array that will be used as the base values for
   *   FieldConfig::create().
   */
  public function getViewDisplayDefinition(array $values = []);

}

Members

Name	Modifiers	Type	Description	Overrides
OgFieldsInterface::getBundle	public	function	Get the bundle name.	1
OgFieldsInterface::getEntityType	public	function	Get the entity type name.	1
OgFieldsInterface::getFieldBaseDefinition	public	function	Get the field config base definition.	1
OgFieldsInterface::getFieldName	public	function	Get the field name.	1
OgFieldsInterface::getFieldStorageBaseDefinition	public	function	Get the field storage config base definition.	1
OgFieldsInterface::getFormDisplayDefinition	public	function	Get the field's form display definition.	3
OgFieldsInterface::getViewDisplayDefinition	public	function	Get the field's view modes definition.	3
OgFieldsInterface::setBundle	public	function	Set the bundle.	1
OgFieldsInterface::setEntityType	public	function	Set the entity type.	1
OgFieldsInterface::setFieldName	public	function	Set the field name.	1