abstract class OgFieldBase in Organic groups 8

OG related fields base plugin.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\og\OgFieldBase implements OgFieldsInterface

3 files declare their use of OgFieldBase

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/OgFieldBase.php, line 12

Namespace

Drupal\og

abstract class OgFieldBase extends PluginBase implements OgFieldsInterface {

  /**
   * The entity bundle.
   *
   * @var string
   */
  protected $bundle;

  /**
   * The entity type.
   *
   * @var string
   */
  protected $entityType;

  /**
   * The field name.
   *
   * @var string
   */
  protected $fieldName;

  /**
   * {@inheritdoc}
   */
  public function setBundle($bundle) {
    $this->bundle = $bundle;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBundle() {
    return $this->bundle;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityType() {
    return $this->entityType;
  }

  /**
   * {@inheritdoc}
   */
  public function setEntityType($entity_type) {
    $field_storage = $this
      ->getFieldStorageBaseDefinition();
    if (!empty($field_storage['entity']) && !in_array($entity_type, $field_storage['entity'])) {
      $plugin_id = $this
        ->getPluginId();
      $entities = implode(', ', $field_storage['entity']);
      if ($field_name = $this
        ->getFieldName()) {
        throw new \Exception("The Organic Groups field with plugin ID {$plugin_id} with the name {$field_name} cannot be attached to the entity type. It can only be attached to the following entities: {$entities}.");
      }
      throw new \Exception("The Organic Groups field with plugin ID {$plugin_id} cannot be attached to the entity type. It can only be attached to the following entities: {$entities}.");
    }
    $this->entityType = $entity_type;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldName() {
    return $this->fieldName;
  }

  /**
   * {@inheritdoc}
   */
  public function setFieldName($field_name) {
    $this->fieldName = $field_name;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldStorageBaseDefinition(array $values = []) {
    $values += [
      'entity_type' => $this
        ->getEntityType(),
      'field_name' => $this
        ->getFieldName(),
    ];
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldBaseDefinition(array $values = []) {
    $values += [
      'bundle' => $this
        ->getBundle(),
      'entity_type' => $this
        ->getEntityType(),
      'field_name' => $this
        ->getFieldName(),
    ];
    return $values;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OgFieldBase::$bundle	protected	property	The entity bundle.
OgFieldBase::$entityType	protected	property	The entity type.
OgFieldBase::$fieldName	protected	property	The field name.
OgFieldBase::getBundle	public	function	Get the bundle name. Overrides OgFieldsInterface::getBundle
OgFieldBase::getEntityType	public	function	Get the entity type name. Overrides OgFieldsInterface::getEntityType
OgFieldBase::getFieldBaseDefinition	public	function	Get the field config base definition. Overrides OgFieldsInterface::getFieldBaseDefinition	2
OgFieldBase::getFieldName	public	function	Get the field name. Overrides OgFieldsInterface::getFieldName
OgFieldBase::getFieldStorageBaseDefinition	public	function	Get the field storage config base definition. Overrides OgFieldsInterface::getFieldStorageBaseDefinition	3
OgFieldBase::setBundle	public	function	Set the bundle. Overrides OgFieldsInterface::setBundle
OgFieldBase::setEntityType	public	function	Set the entity type. Overrides OgFieldsInterface::setEntityType
OgFieldBase::setFieldName	public	function	Set the field name. Overrides OgFieldsInterface::setFieldName
OgFieldsInterface::getFormDisplayDefinition	public	function	Get the field's form display definition.	3
OgFieldsInterface::getViewDisplayDefinition	public	function	Get the field's view modes definition.	3
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.