class ViewDuplicateForm
Form controller for the Views duplicate form.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait- class \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\EntityFormInterface extends \Drupal\Core\Form\FormBase- class \Drupal\views_ui\ViewFormBase extends \Drupal\Core\Entity\EntityForm- class \Drupal\views_ui\ViewDuplicateForm extends \Drupal\views_ui\ViewFormBase
 
 
- class \Drupal\views_ui\ViewFormBase extends \Drupal\Core\Entity\EntityForm
 
- class \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\EntityFormInterface extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of ViewDuplicateForm
File
- 
              core/modules/ views_ui/ src/ ViewDuplicateForm.php, line 15 
Namespace
Drupal\views_uiView source
class ViewDuplicateForm extends ViewFormBase {
  
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected LanguageManagerInterface $languageManager;
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container->get('module_handler'), $container->get('language_manager'));
  }
  
  /**
   * Constructs a ViewDuplicateForm.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   Drupal's module handler.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   */
  public function __construct(ModuleHandlerInterface $moduleHandler, LanguageManagerInterface $language_manager) {
    $this->setModuleHandler($moduleHandler);
    $this->languageManager = $language_manager;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function prepareEntity() {
    // Do not prepare the entity while it is being added.
  }
  
  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    parent::form($form, $form_state);
    $form['#title'] = $this->t('Duplicate of @label', [
      '@label' => $this->entity
        ->label(),
    ]);
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this->t('View name'),
      '#required' => TRUE,
      '#size' => 32,
      '#maxlength' => 255,
      '#default_value' => $this->t('Duplicate of @label', [
        '@label' => $this->entity
          ->label(),
      ]),
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#maxlength' => 128,
      '#machine_name' => [
        'exists' => '\\Drupal\\views\\Views::getView',
        'source' => [
          'label',
        ],
      ],
      '#default_value' => '',
      '#description' => $this->t('A unique machine-readable name for this View. It must only contain lowercase letters, numbers, and underscores.'),
    ];
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions['submit'] = [
      '#type' => 'submit',
      '#value' => $this->t('Duplicate'),
    ];
    return $actions;
  }
  
  /**
   * Form submission handler for the 'clone' action.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   A reference to a keyed array containing the current state of the form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    // The original ID gets set to NULL when duplicating, so we need to store it
    // here.
    $original_id = $this->entity
      ->id();
    $this->entity = $this->entity
      ->createDuplicate();
    $this->entity
      ->set('label', $form_state->getValue('label'));
    $this->entity
      ->set('id', $form_state->getValue('id'));
    $this->entity
      ->save();
    $this->copyTranslations($original_id);
    // Redirect the user to the view admin form.
    $form_state->setRedirectUrl($this->entity
      ->toUrl('edit-form'));
  }
  
  /**
   * Copies all translations that existed on the original View.
   *
   * @param string $original_id
   *   The original View ID.
   */
  private function copyTranslations(string $original_id) : void {
    if (!$this->moduleHandler
      ->moduleExists('config_translation')) {
      return;
    }
    $current_langcode = $this->languageManager
      ->getConfigOverrideLanguage()
      ->getId();
    $languages = $this->languageManager
      ->getLanguages();
    $original_name = 'views.view.' . $original_id;
    $duplicate_name = 'views.view.' . $this->entity
      ->id();
    foreach ($languages as $language) {
      $langcode = $language->getId();
      if ($langcode !== $current_langcode) {
        $original_translation = $this->languageManager
          ->getLanguageConfigOverride($langcode, $original_name)
          ->get();
        if ($original_translation) {
          $duplicate_translation = $this->languageManager
            ->getLanguageConfigOverride($langcode, $duplicate_name);
          $duplicate_translation->setData($original_translation);
          $duplicate_translation->save();
        }
      }
    }
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| EntityForm::$entity | protected | property | The entity being used by this form. | 11 | |
| EntityForm::$entityTypeManager | protected | property | The entity type manager. | 3 | |
| EntityForm::$moduleHandler | protected | property | The module handler service. | 2 | |
| EntityForm::$operation | protected | property | The name of the current operation. | ||
| 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. | 1 | |
| EntityForm::buildEntity | public | function | Builds an updated entity object based upon the submitted form values. | Overrides EntityFormInterface::buildEntity | 5 | 
| EntityForm::copyFormValuesToEntity | protected | function | Copies top-level form values to entity properties. | 11 | |
| EntityForm::getBaseFormId | public | function | Returns a string identifying the base form. | Overrides BaseFormIdInterface::getBaseFormId | 4 | 
| EntityForm::getEntity | public | function | Gets the form entity. | Overrides EntityFormInterface::getEntity | |
| EntityForm::getEntityFromRouteMatch | public | function | Determines which entity will be used by this form from a RouteMatch object. | Overrides EntityFormInterface::getEntityFromRouteMatch | 3 | 
| EntityForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | 13 | 
| EntityForm::getOperation | public | function | Gets the operation identifying the form. | Overrides EntityFormInterface::getOperation | |
| 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 | |
| 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. | 2 | |
| 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 | 57 | 
| 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. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 2 | |
| 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. | 3 | |
| 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. | ||
| ViewDuplicateForm::$languageManager | protected | property | The language manager. | ||
| ViewDuplicateForm::actions | protected | function | Returns an array of supported actions for the current entity form. | Overrides EntityForm::actions | |
| ViewDuplicateForm::copyTranslations | private | function | Copies all translations that existed on the original View. | ||
| ViewDuplicateForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | |
| ViewDuplicateForm::form | public | function | Gets the actual form array to be built. | Overrides EntityForm::form | |
| ViewDuplicateForm::prepareEntity | protected | function | Prepares the entity object before the form is built first. | Overrides ViewFormBase::prepareEntity | |
| ViewDuplicateForm::submitForm | public | function | Form submission handler for the 'clone' action. | Overrides EntityForm::submitForm | |
| ViewDuplicateForm::__construct | public | function | Constructs a ViewDuplicateForm. | ||
| ViewFormBase::$displayID | protected | property | The name of the display used by the form. | ||
| ViewFormBase::buildForm | public | function | Form constructor. | Overrides EntityForm::buildForm | |
| ViewFormBase::getDisplayLabel | public | function | Placeholder function for overriding $display['display_title']. | ||
| ViewFormBase::getDisplayTabs | public | function | Adds tabs for navigating across Displays when editing a View. | ||
| ViewFormBase::init | public | function | Initialize the form state and the entity before the first form build. | Overrides EntityForm::init | |
| ViewFormBase::isDefaultDisplayShown | public | function | Controls whether or not the default display should have its own tab on edit. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
