You are here

Home » API reference » Field collection 8.3 » FieldCollectionLinksFormatter.php

abstract class FieldCollectionLinksFormatter in Field collection 8.3

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/FieldCollectionLinksFormatter.php \Drupal\field_collection\Plugin\Field\FieldFormatter\FieldCollectionLinksFormatter

Hierarchy

Expanded class hierarchy of FieldCollectionLinksFormatter

File

src/Plugin/Field/FieldFormatter/FieldCollectionLinksFormatter.php, line 11

Namespace

Drupal\field_collection\Plugin\Field\FieldFormatter
View source 
abstract class FieldCollectionLinksFormatter extends FormatterBase {

  /**
   * Helper function to get Edit and Delete links for an item.
   */
  protected function getEditLinks(FieldItemInterface $item) {
    $links = '';
    if ($item
      ->getEntity()
      ->access('update', \Drupal::currentUser())) {
      $links = '(' . Link::fromTextAndUrl(t('Edit'), Url::FromRoute('entity.field_collection_item.edit_form', [
        'field_collection_item' => $item->target_id,
      ]))
        ->toString();
      $links .= '|' . Link::fromTextAndUrl(t('Delete'), Url::FromRoute('entity.field_collection_item.delete_form', [
        'field_collection_item' => $item->target_id,
      ]))
        ->toString();
      $links .= ')';
    }
    return $links;
  }

  /***
   * Return a link to add a field collection item entity to this field.
   *
   * Returns a blank string if the field is at maximum capacity or the user
   * does not have access to edit it.
   */
  protected function getAddLink(ContentEntityInterface $host) {
    $link = '';
    if ($host
      ->access('update', \Drupal::currentUser())) {
      $link = '<ul class="action-links action-links-field-collection-add"><li>';
      $link .= Link::fromTextAndUrl(t('Add'), Url::FromRoute('field_collection_item.add_page', [
        'field_collection' => $this->fieldDefinition
          ->getName(),
        'host_type' => $host
          ->getEntityTypeId(),
        'host_id' => $host
          ->id(),
      ]))
        ->toString();
      $link .= '</li></ul>';
    }
    return $link;
  }

}

Members

Namesort descending 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
FieldCollectionLinksFormatter::getAddLink protected function
FieldCollectionLinksFormatter::getEditLinks protected function Helper function to get Edit and Delete links for an item.
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm 24
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
FormatterInterface::viewElements public function Builds a renderable array for a field value. 47
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.