You are here

Home » API reference » Facebook Instant Articles 3.x » EntityViewDisplayEditForm.php

class EntityViewDisplayEditForm in Facebook Instant Articles 3.x

Same name and namespace in other branches
  1. 8.2 src/Form/EntityViewDisplayEditForm.php \Drupal\fb_instant_articles\Form\EntityViewDisplayEditForm

Extends the core EntityViewDisplayEditForm to support multiple regions.

Hierarchy

Expanded class hierarchy of EntityViewDisplayEditForm

3 files declare their use of EntityViewDisplayEditForm
fb_instant_articles_api.module in modules/fb_instant_articles_api/fb_instant_articles_api.module
Hook implementations.
InstantArticleContentEntityNormalizer.php in src/Normalizer/InstantArticleContentEntityNormalizer.php
ValidFacebookInstantArticles.php in modules/fb_instant_articles_views/src/Plugin/views/filter/ValidFacebookInstantArticles.php

File

src/Form/EntityViewDisplayEditForm.php, line 12

Namespace

Drupal\fb_instant_articles\Form
View source 
class EntityViewDisplayEditForm extends CoreEntityViewDisplayEditForm {

  /**
   * Name of the FBIA view mode.
   */
  const FBIA_VIEW_MODE = 'fb_instant_articles';

  /**
   * {@inheritdoc}
   */
  public function getRegions() {
    $regions = parent::getRegions();
    if ($this
      ->getEntity()
      ->getOriginalMode() === 'fb_instant_articles') {
      $new_regions[Regions::REGION_HEADER] = [
        'title' => $this
          ->t('Header'),
        'message' => $this
          ->t('No fields are displayed in this region.'),
      ];
      $new_regions[Regions::REGION_CONTENT] = [
        'title' => $this
          ->t('Body'),
        'message' => $this
          ->t('No fields are displayed in this region.'),
      ];
      $new_regions[Regions::REGION_FOOTER] = [
        'title' => $this
          ->t('Footer'),
        'message' => $this
          ->t('No fields are displayed in this region.'),
      ];
      $new_regions['hidden'] = $regions['hidden'];
      $regions = $new_regions;
    }
    return $regions;
  }

  /**
   * {@inheritdoc}
   */
  protected function getApplicablePluginOptions(FieldDefinitionInterface $field_definition) {
    $options = parent::getApplicablePluginOptions($field_definition);

    // Filter out FBIA formatters for view modes other than the Facebook instant
    // articles view mode.
    if ($this
      ->getEntity()
      ->getOriginalMode() !== 'fb_instant_articles') {
      foreach ($options as $key => $label) {
        if (preg_match('/^fbia_/', $key)) {
          unset($options[$key]);
        }
      }
    }
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityDisplayFormBase::$entity protected property The entity being used by this form. Overrides EntityForm::$entity 1
EntityDisplayFormBase::$entityDisplayRepository protected property The entity display repository.
EntityDisplayFormBase::$entityFieldManager protected property The entity field manager.
EntityDisplayFormBase::$fieldTypes protected property A list of field types.
EntityDisplayFormBase::$pluginManager protected property The widget or formatter plugin manager.
EntityDisplayFormBase::copyFormValuesToEntity protected function Copies top-level form values to entity properties. Overrides EntityForm::copyFormValuesToEntity 1
EntityDisplayFormBase::form public function Gets the actual form array to be built. Overrides EntityForm::form 1
EntityDisplayFormBase::getDisplays protected function Returns entity (form) displays for the current entity display type.
EntityDisplayFormBase::getDisplayStatuses protected function Returns form or view modes statuses for the bundle used by this form.
EntityDisplayFormBase::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityForm::getEntityFromRouteMatch
EntityDisplayFormBase::getExtraFields protected function Returns the extra fields of the entity type and bundle used by this form.
EntityDisplayFormBase::getFieldDefinitions protected function Collects the definitions of fields whose display is configurable.
EntityDisplayFormBase::getRegionOptions public function Returns an associative array of all regions.
EntityDisplayFormBase::getRowRegion public function Returns the region to which a row in the display overview belongs.
EntityDisplayFormBase::multistepAjax public function Ajax handler for multistep buttons.
EntityDisplayFormBase::multistepSubmit public function Form submission handler for multistep buttons.
EntityDisplayFormBase::saveDisplayStatuses protected function Saves the updated display mode statuses.
EntityDisplayFormBase::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
EntityDisplayFormBase::__construct public function Constructs a new EntityDisplayFormBase. 2
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 35
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 3
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 13
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 6
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 12
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::save public function Form submission handler for the 'save' action. Overrides EntityFormInterface::save 47
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityViewDisplayEditForm::$displayContext protected property The display context. Either 'view' or 'form'. Overrides EntityDisplayFormBase::$displayContext
EntityViewDisplayEditForm::alterSettingsSummary protected function Alters the widget or formatter settings summary. Overrides EntityDisplayFormBase::alterSettingsSummary
EntityViewDisplayEditForm::buildExtraFieldRow protected function Builds the table row structure for a single extra field. Overrides EntityDisplayFormBase::buildExtraFieldRow 1
EntityViewDisplayEditForm::buildFieldRow protected function Builds the table row structure for a single field. Overrides EntityDisplayFormBase::buildFieldRow 1
EntityViewDisplayEditForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create 1
EntityViewDisplayEditForm::FBIA_VIEW_MODE constant Name of the FBIA view mode.
EntityViewDisplayEditForm::getApplicablePluginOptions protected function Returns an array of applicable widget or formatter options for a field. Overrides EntityDisplayFormBase::getApplicablePluginOptions
EntityViewDisplayEditForm::getDefaultPlugin protected function Returns the ID of the default widget or formatter plugin for a field type. Overrides EntityDisplayFormBase::getDefaultPlugin
EntityViewDisplayEditForm::getDisplayModeOptions protected function Returns an array of form or view mode options. Overrides EntityDisplayFormBase::getDisplayModeOptions
EntityViewDisplayEditForm::getDisplayModes protected function Returns the form or view modes used by this form. Overrides EntityDisplayFormBase::getDisplayModes
EntityViewDisplayEditForm::getDisplayModesLink protected function Returns a link to the form or view mode admin page. Overrides EntityDisplayFormBase::getDisplayModesLink
EntityViewDisplayEditForm::getEntityDisplay protected function Returns an entity display object to be used by this form. Overrides EntityDisplayFormBase::getEntityDisplay
EntityViewDisplayEditForm::getFieldLabelOptions protected function Returns an array of visibility options for field labels.
EntityViewDisplayEditForm::getOverviewUrl protected function Returns the Url object for a specific entity (form) display edit form. Overrides EntityDisplayFormBase::getOverviewUrl
EntityViewDisplayEditForm::getRegions public function Get the regions needed to create the overview form. Overrides EntityDisplayFormBase::getRegions
EntityViewDisplayEditForm::getTableHeader protected function Returns an array containing the table headers. Overrides EntityDisplayFormBase::getTableHeader
EntityViewDisplayEditForm::thirdPartySettingsForm protected function Adds the widget or formatter third party settings forms. Overrides EntityDisplayFormBase::thirdPartySettingsForm
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.