You are here

Home » API reference » Organic groups 8 » AudienceField.php

class AudienceField in Organic groups 8

Determine to which groups this group content is assigned to.

Plugin annotation


@OgFields(
 id = "og_audience",
 type = "group",
 description = @Translation("Determine to which groups this group content is assigned to."),
)

Hierarchy

Expanded class hierarchy of AudienceField

File

src/Plugin/OgFields/AudienceField.php, line 21

Namespace

Drupal\og\Plugin\OgFields
View source 
class AudienceField extends OgFieldBase implements OgFieldsInterface {

  /**
   * {@inheritdoc}
   */
  public function getFieldStorageBaseDefinition(array $values = []) {
    if ($this
      ->getEntityType() === 'user') {
      throw new \LogicException('OG audience field cannot be added to the User entity type.');
    }
    $values += [
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
      'settings' => [
        'target_type' => $this
          ->getEntityType(),
      ],
      'type' => OgGroupAudienceHelperInterface::GROUP_REFERENCE,
    ];
    return parent::getFieldStorageBaseDefinition($values);
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldBaseDefinition(array $values = []) {
    $values += [
      'description' => $this
        ->t('OG group audience reference field.'),
      'display_label' => TRUE,
      'label' => $this
        ->t('Groups audience'),
      'settings' => [
        'handler' => 'og',
        'handler_settings' => [],
      ],
    ];
    return parent::getFieldBaseDefinition($values);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormDisplayDefinition(array $values = []) {
    $values += [
      'type' => 'og_complex',
      'settings' => [
        'match_operator' => 'CONTAINS',
        'size' => 60,
        'match_limit' => 10,
        'placeholder' => '',
      ],
    ];
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  public function getViewDisplayDefinition(array $values = []) {
    $values += [
      'label' => 'above',
      'type' => 'entity_reference_label',
      'settings' => [
        'link' => TRUE,
      ],
    ];
    return $values;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AudienceField::getFieldBaseDefinition public function Get the field config base definition. Overrides OgFieldBase::getFieldBaseDefinition
AudienceField::getFieldStorageBaseDefinition public function Get the field storage config base definition. Overrides OgFieldBase::getFieldStorageBaseDefinition
AudienceField::getFormDisplayDefinition public function Get the field's form display definition. Overrides OgFieldsInterface::getFormDisplayDefinition
AudienceField::getViewDisplayDefinition public function Get the field's view modes definition. Overrides OgFieldsInterface::getViewDisplayDefinition
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::getFieldName public function Get the field name. Overrides OgFieldsInterface::getFieldName
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
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.