You are here

Home » API reference » Group 2.0.x » GroupRelationInterface.php

interface GroupRelationInterface in Group 2.0.x

Defines an interface for pluggable GroupRelation back-ends.

Hierarchy

Expanded class hierarchy of GroupRelationInterface

All classes that implement GroupRelationInterface

See also

\Drupal\group\Annotation\GroupRelation

\Drupal\group\Plugin\Group\Relation\GroupRelationManager

\Drupal\group\Plugin\Group\Relation\GroupRelationBase

Plugin API

3 files declare their use of GroupRelationInterface
AccessControlTest.php in tests/src/Unit/AccessControlTest.php
GroupContentAccessControlHandlerTest.php in tests/src/Unit/GroupContentAccessControlHandlerTest.php
GroupTypeController.php in src/Entity/Controller/GroupTypeController.php

File

src/Plugin/Group/Relation/GroupRelationInterface.php, line 21

Namespace

Drupal\group\Plugin\Group\Relation
View source 
interface GroupRelationInterface extends PluginInspectionInterface, DerivativeInspectionInterface, ConfigurableInterface, DependentPluginInterface, PluginFormInterface {

  /**
   * Returns the plugin provider.
   *
   * @return string
   *   The plugin provider.
   */
  public function getProvider();

  /**
   * Returns the administrative label for the plugin.
   *
   * @return string
   *   The plugin label.
   */
  public function getLabel();

  /**
   * Returns the administrative description for the plugin.
   *
   * @return string
   *   The plugin description.
   */
  public function getDescription();

  /**
   * Returns the entity type ID the plugin supports.
   *
   * @return string
   *   The entity type ID.
   */
  public function getEntityTypeId();

  /**
   * Returns the entity bundle the plugin supports.
   *
   * @return string|false
   *   The bundle name or FALSE in case it supports all bundles.
   */
  public function getEntityBundle();

  /**
   * Returns the pretty path key for use in path aliases.
   *
   * @return string
   *   The plugin-provided pretty path key, defaults to 'content'.
   */
  public function getPrettyPathKey();

  /**
   * Returns the amount of groups the same content can be added to.
   *
   * @return int
   *   The group content's group cardinality.
   */
  public function getGroupCardinality();

  /**
   * Returns the amount of times the same content can be added to a group.
   *
   * @return int
   *   The group content's entity cardinality.
   */
  public function getEntityCardinality();

  /**
   * Returns the group type the plugin was instantiated for.
   *
   * @return \Drupal\group\Entity\GroupTypeInterface|null
   *   The group type, if set in the plugin configuration.
   */
  public function getGroupType();

  /**
   * Returns the ID of the group type the plugin was instantiated for.
   *
   * @return string|null
   *   The group type ID, if set in the plugin configuration.
   */
  public function getGroupTypeId();

  /**
   * Returns whether this plugin defines entity access.
   *
   * @return bool
   *   Whether this plugin defines entity access.
   *
   * @see \Drupal\group\Annotation\GroupRelation::$entity_access
   */
  public function definesEntityAccess();

  /**
   * Returns whether this plugin is always on.
   *
   * @return bool
   *   The 'enforced' status.
   */
  public function isEnforced();

  /**
   * Returns whether this plugin can only be (un)installed through code.
   *
   * @return bool
   *   The 'code_only' status.
   */
  public function isCodeOnly();

  /**
   * Retrieves the label for a piece of group content.
   *
   * @param \Drupal\group\Entity\GroupContentInterface $group_content
   *   The group content entity to retrieve the label for.
   *
   * @return string
   *   The label as expected by \Drupal\Core\Entity\EntityInterface::label().
   */
  public function getContentLabel(GroupContentInterface $group_content);

  /**
   * Returns a safe, unique configuration ID for a group content type.
   *
   * By default we use GROUP_TYPE_ID-PLUGIN_ID-DERIVATIVE_ID, but feel free to
   * use any other means of identifying group content types.
   *
   * Please do not return any invalid characters in the ID as it will crash the
   * website. Refer to ConfigBase::validateName() for valid characters.
   *
   * @return string
   *   The safe ID to use as the configuration name.
   *
   * @see \Drupal\Core\Config\ConfigBase::validateName()
   */
  public function getContentTypeConfigId();

  /**
   * Returns the administrative label for a group content type.
   *
   * @return string
   *   The group content type label.
   */
  public function getContentTypeLabel();

  /**
   * Returns the administrative description for a group content type.
   *
   * @return string
   *   The group content type description.
   */
  public function getContentTypeDescription();

  /**
   * Provides a list of operations for a group.
   *
   * These operations can be implemented in numerous ways by extending modules.
   * Out of the box, Group provides a block that shows the available operations
   * to a user visiting a route with a group in its URL.
   *
   * Do not forget to specify cacheable metadata if you need to. This can be
   * done in ::getGroupOperationsCacheableMetadata().
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to generate the operations for.
   *
   * @return array
   *   An associative array of operation links to show when in a group context,
   *   keyed by operation name, containing the following key-value pairs:
   *   - title: The localized title of the operation.
   *   - url: An instance of \Drupal\Core\Url for the operation URL.
   *   - weight: The weight of the operation.
   *
   * @see ::getGroupOperationsCacheableMetadata()
   */
  public function getGroupOperations(GroupInterface $group);

  /**
   * Provides the cacheable metadata for this plugin's group operations.
   *
   * The operations set in ::getGroupOperations() may have some cacheable
   * metadata that needs to be set but can't be because the links set in an
   * Operations render element are simple associative arrays. This method allows
   * you to specify the cacheable metadata regardless.
   *
   * @return \Drupal\Core\Cache\CacheableMetadata
   *   The cacheable metadata for the group operations.
   *
   * @see ::getGroupOperations()
   */
  public function getGroupOperationsCacheableMetadata();

  /**
   * Provides a list of operations for the group relation plugin.
   *
   * These operations will be merged with the ones already available on the
   * group type content configuration page: (un)install, manage fields, etc.
   *
   * @return array
   *   An associative array of operation links to show on the group type content
   *   administration UI, keyed by operation name, containing the following
   *   key-value pairs:
   *   - title: The localized title of the operation.
   *   - url: An instance of \Drupal\Core\Url for the operation URL.
   *   - weight: The weight of this operation.
   */
  public function getOperations();

  /**
   * Returns the label for the entity reference field.
   *
   * This allows you to specify the label for the entity reference field
   * pointing to the entity that is to become group content.
   *
   * @return string|null
   *   The label for the entity reference field or NULL if none was set.
   */
  public function getEntityReferenceLabel();

  /**
   * Returns the description for the entity reference field.
   *
   * This allows you to specify the description for the entity reference field
   * pointing to the entity that is to become group content.
   *
   * @return string|null
   *   The description for the entity reference field or NULL if none was set.
   */
  public function getEntityReferenceDescription();

  /**
   * Returns a list of entity reference field settings.
   *
   * This allows you to provide some handler settings for the entity reference
   * field pointing to the entity that is to become group content. You could
   * even change the handler being used, all without having to alter the bundle
   * field settings yourself through an alter hook.
   *
   * @return array
   *   An associative array where the keys are valid entity reference field
   *   setting names and the values are the corresponding setting for each key.
   *   Often used keys are 'target_type', 'handler' and 'handler_settings'.
   */
  public function getEntityReferenceSettings();

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 14
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 15
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 15
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 20
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
GroupRelationInterface::definesEntityAccess public function Returns whether this plugin defines entity access. 1
GroupRelationInterface::getContentLabel public function Retrieves the label for a piece of group content. 1
GroupRelationInterface::getContentTypeConfigId public function Returns a safe, unique configuration ID for a group content type. 1
GroupRelationInterface::getContentTypeDescription public function Returns the administrative description for a group content type. 1
GroupRelationInterface::getContentTypeLabel public function Returns the administrative label for a group content type. 1
GroupRelationInterface::getDescription public function Returns the administrative description for the plugin. 1
GroupRelationInterface::getEntityBundle public function Returns the entity bundle the plugin supports. 1
GroupRelationInterface::getEntityCardinality public function Returns the amount of times the same content can be added to a group. 1
GroupRelationInterface::getEntityReferenceDescription public function Returns the description for the entity reference field. 1
GroupRelationInterface::getEntityReferenceLabel public function Returns the label for the entity reference field. 1
GroupRelationInterface::getEntityReferenceSettings public function Returns a list of entity reference field settings. 1
GroupRelationInterface::getEntityTypeId public function Returns the entity type ID the plugin supports. 1
GroupRelationInterface::getGroupCardinality public function Returns the amount of groups the same content can be added to. 1
GroupRelationInterface::getGroupOperations public function Provides a list of operations for a group. 1
GroupRelationInterface::getGroupOperationsCacheableMetadata public function Provides the cacheable metadata for this plugin's group operations. 1
GroupRelationInterface::getGroupType public function Returns the group type the plugin was instantiated for. 1
GroupRelationInterface::getGroupTypeId public function Returns the ID of the group type the plugin was instantiated for. 1
GroupRelationInterface::getLabel public function Returns the administrative label for the plugin. 1
GroupRelationInterface::getOperations public function Provides a list of operations for the group relation plugin. 1
GroupRelationInterface::getPrettyPathKey public function Returns the pretty path key for use in path aliases. 1
GroupRelationInterface::getProvider public function Returns the plugin provider. 1
GroupRelationInterface::isCodeOnly public function Returns whether this plugin can only be (un)installed through code. 1
GroupRelationInterface::isEnforced public function Returns whether this plugin is always on. 1
PluginFormInterface::buildConfigurationForm public function Form constructor. 37
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2