You are here

Home » API reference » Bricks​ 8 » BricksTreeInlineWidget.php

class BricksTreeInlineWidget in Bricks​ 8

Same name and namespace in other branches
  1. 2.x modules/bricks_inline/src/Plugin/Field/FieldWidget/BricksTreeInlineWidget.php \Drupal\bricks_inline\Plugin\Field\FieldWidget\BricksTreeInlineWidget

Plugin annotation


@FieldWidget(
  id = "bricks_tree_inline",
  label = @Translation("Bricks tree (Inline entity form)"),
  description = @Translation("A tree of inline entity forms."),
  field_types = {
    "bricks",
    "bricks_revisioned"
  },
  multiple_values = true
)

Hierarchy

Expanded class hierarchy of BricksTreeInlineWidget

File

modules/bricks_inline/src/Plugin/Field/FieldWidget/BricksTreeInlineWidget.php, line 23

Namespace

Drupal\bricks_inline\Plugin\Field\FieldWidget
View source 
class BricksTreeInlineWidget extends InlineEntityFormComplex {

  /**
   * {@inheritdoc}
   */
  public function form(FieldItemListInterface $items, array &$form, FormStateInterface $form_state, $get_delta = NULL) {
    $elements = parent::form($items, $form, $form_state, $get_delta);

    // Signal to content_translation that this field should be treated as
    // multilingual and not be hidden, see
    // \Drupal\content_translation\ContentTranslationHandler::entityFormSharedElements().
    $elements['#multilingual'] = TRUE;
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $element['entities']['#widget'] = 'bricks_tree_inline';
    $entities = $form_state
      ->get([
      'inline_entity_form',
      $this
        ->getIefId(),
      'entities',
    ]);
    foreach ($entities as $delta => $value) {
      _bricks_form_element_alter($element['entities'][$delta], $items[$delta], $value['entity']);
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    $field_name = $this->fieldDefinition
      ->getName();
    $field_value = $form_state
      ->getValue($field_name);
    foreach ($values as $delta => $value) {
      if (isset($field_value['entities'][$delta])) {
        $values[$delta]['depth'] = $field_value['entities'][$delta]['depth'];
        $values[$delta]['options'] = $field_value['entities'][$delta]['options'];
      }
    }
    return $values;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
BricksTreeInlineWidget::form public function Creates a form element for a field. Overrides InlineEntityFormBase::form
BricksTreeInlineWidget::formElement public function Returns the form for a single field widget. Overrides InlineEntityFormComplex::formElement
BricksTreeInlineWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
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.
InlineEntityFormBase::$entityDisplayRepository protected property The entity display repository.
InlineEntityFormBase::$entityTypeBundleInfo protected property The entity type bundle info.
InlineEntityFormBase::$entityTypeManager protected property The entity type manager.
InlineEntityFormBase::$iefId protected property The inline entity form id.
InlineEntityFormBase::$inlineFormHandler protected property The inline entity from handler.
InlineEntityFormBase::addIefSubmitCallbacks public static function Adds submit callbacks to the inline entity form.
InlineEntityFormBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
InlineEntityFormBase::canAddNew protected function Determines if the current user can add any new entities.
InlineEntityFormBase::canBuildForm protected function Checks whether we can build entity form at all.
InlineEntityFormBase::createInlineFormHandler protected function Creates an instance of the inline form handler for the current entity type.
InlineEntityFormBase::getAccessHandler protected function Gets the access handler for the target entity type.
InlineEntityFormBase::getCreateBundles protected function Gets the bundles for which the current user has create access.
InlineEntityFormBase::getEntityFormMode protected function Gets the entity form mode instance for this widget.
InlineEntityFormBase::getEntityTypeLabels protected function Gets the entity type managed by this handler.
InlineEntityFormBase::getIefId protected function Gets inline entity form ID.
InlineEntityFormBase::getInlineEntityForm protected function Gets inline entity form element.
InlineEntityFormBase::getTargetBundles protected function Gets the target bundles for the current field.
InlineEntityFormBase::isTranslating protected function Determines whether there's a translation in progress.
InlineEntityFormBase::makeIefId protected function Makes an IEF ID from array parents.
InlineEntityFormBase::prepareFormState protected function Prepares the form state for the current widget.
InlineEntityFormBase::removeTranslatabilityClue public static function After-build callback for removing the translatability clue from the widget.
InlineEntityFormBase::setIefId protected function Sets inline entity form ID.
InlineEntityFormBase::submitSaveEntity public static function Marks created/edited entity with "needs save" flag.
InlineEntityFormBase::__sleep public function Overrides DependencySerializationTrait::__sleep
InlineEntityFormBase::__wakeup public function Overrides DependencySerializationTrait::__wakeup
InlineEntityFormComplex::$moduleHandler protected property Module handler service.
InlineEntityFormComplex::$selectionManager protected property Selection Plugin Manager service.
InlineEntityFormComplex::addSubmitCallbacks public static function Add common submit callback functions and mark element as a IEF trigger.
InlineEntityFormComplex::buildEntityFormActions public static function Adds actions to the inline entity form.
InlineEntityFormComplex::buildRemoveForm protected function Builds remove form.
InlineEntityFormComplex::closeChildForms public static function Button #submit callback: Closes all open child forms in the IEF widget.
InlineEntityFormComplex::closeForm public static function Button #submit callback: Closes a form in the IEF widget.
InlineEntityFormComplex::create public static function Creates an instance of the plugin. Overrides InlineEntityFormBase::create
InlineEntityFormComplex::defaultSettings public static function Defines the default settings for this plugin. Overrides InlineEntityFormBase::defaultSettings
InlineEntityFormComplex::determineBundle protected function Determines bundle to be used when creating entity.
InlineEntityFormComplex::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
InlineEntityFormComplex::getMatchOperatorOptions protected function Returns the options for the match operator.
InlineEntityFormComplex::hideCancel public static function Hides cancel button.
InlineEntityFormComplex::requiredField public static function IEF widget #element_validate callback: Required field validation.
InlineEntityFormComplex::settingsForm public function Returns a form to configure settings for the widget. Overrides InlineEntityFormBase::settingsForm
InlineEntityFormComplex::settingsSummary public function Returns a short summary for the current widget settings. Overrides InlineEntityFormBase::settingsSummary
InlineEntityFormComplex::submitCloseRow public static function Button #submit callback: Closes a row form in the IEF widget.
InlineEntityFormComplex::submitConfirmRemove public static function Remove form submit callback.
InlineEntityFormComplex::updateRowWeights public static function Updates entity weights based on their weights in the widget.
InlineEntityFormComplex::__construct public function Constructs a InlineEntityFormComplex object. Overrides InlineEntityFormBase::__construct
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::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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState