You are here

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

class AccessField in Organic groups 8

Determine if group should use default roles and permissions.

Plugin annotation


@OgFields(
 id = "og_access",
 type = "group",
 description = @Translation("Determine if group should use default roles and permissions.")
)

Hierarchy

Expanded class hierarchy of AccessField

1 file declares its use of AccessField
FieldCreateTest.php in tests/src/Kernel/Entity/FieldCreateTest.php

File

src/Plugin/OgFields/AccessField.php, line 20

Namespace

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

  /**
   * The default OG access field name.
   */
  const DEFAULT_FIELD = 'og_access';

  /**
   * {@inheritdoc}
   */
  public function getFieldStorageBaseDefinition(array $values = []) {
    $values += [
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
      'settings' => [
        'allowed_values' => [
          0 => 'Use default roles and permissions',
          1 => 'Override default roles and permissions',
        ],
        'allowed_values_function' => '',
      ],
      'type' => 'list_integer',
    ];
    return parent::getFieldStorageBaseDefinition($values);
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldBaseDefinition(array $values = []) {
    $values += [
      'default_value' => [
        0 => [
          'value' => 0,
        ],
      ],
      'description' => $this
        ->t('Determine if group should use default roles and permissions.'),
      'display_label' => TRUE,
      'label' => $this
        ->t('Group roles and permissions'),
      'required' => TRUE,
    ];
    return parent::getFieldBaseDefinition($values);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormDisplayDefinition(array $values = []) {
    $values += [
      'type' => 'options_select',
      'settings' => [],
    ];
    return $values;
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
AccessField::DEFAULT_FIELD constant The default OG access field name.
AccessField::getFieldBaseDefinition public function Get the field config base definition. Overrides OgFieldBase::getFieldBaseDefinition
AccessField::getFieldStorageBaseDefinition public function Get the field storage config base definition. Overrides OgFieldBase::getFieldStorageBaseDefinition
AccessField::getFormDisplayDefinition public function Get the field's form display definition. Overrides OgFieldsInterface::getFormDisplayDefinition
AccessField::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.