You are here

Home » API reference » Flickity Carousel 8 » FlickityGroupForm.php

class FlickityGroupForm in Flickity Carousel 8

Same name and namespace in other branches
  1. 8.2 src/Form/FlickityGroupForm.php \Drupal\flickity\Form\FlickityGroupForm
  2. 3.0.x src/Form/FlickityGroupForm.php \Drupal\flickity\Form\FlickityGroupForm

Form controller for the group entity add/edit forms.

Hierarchy

Expanded class hierarchy of FlickityGroupForm

File

src/Form/FlickityGroupForm.php, line 17
Contains \Drupal\flickity\Form\FlickityGroupForm.

Namespace

Drupal\flickity\Form
View source 
class FlickityGroupForm extends EntityForm {

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $entity = $this->entity;
    $group = FlickityGroup::load('default_group');
    $settings = $group
      ->getSettings();
    if ($entity
      ->getSettings()) {
      $settings = $entity
        ->getSettings();
    }
    $form['label'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Group name'),
      '#default_value' => $entity
        ->label(),
      '#size' => 30,
      '#required' => TRUE,
      '#maxlength' => 64,
      '#description' => $this
        ->t('The settings group identifier.'),
    );
    $form['id'] = array(
      '#type' => 'machine_name',
      '#default_value' => $entity
        ->id(),
      '#required' => TRUE,
      '#disabled' => !$entity
        ->isNew(),
      '#size' => 30,
      '#maxlength' => 64,
      '#machine_name' => array(
        'exists' => [
          '\\Drupal\\flickity\\Entity\\FlickityGroup',
          'load',
        ],
      ),
    );

    // Setup
    $form['images_loaded'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('imagesLoaded'),
      '#default_value' => $settings['images_loaded'],
      '#description' => $this
        ->t('Unloaded images have no size, which can throw off cell positions. To fix this, the imagesLoaded option re-positions cells once their images have loaded.'),
    );
    $form['cell_selector'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cell selector'),
      '#default_value' => $settings['cell_selector'],
      '#size' => 30,
      '#description' => $this
        ->t('Specify selector for cell elements. This is useful if you have other elements in your gallery elements that are not cells.'),
    );
    $form['initial_index'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Initial index'),
      '#default_value' => $settings['initial_index'],
      '#size' => 30,
      '#description' => $this
        ->t('Zero-based index of the initial selected cell.'),
    );
    $form['accessibility'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Accessibility'),
      '#default_value' => $settings['accessibility'],
      '#description' => $this
        ->t('Enable keyboard navigation. Users can tab to a Flickity gallery, and pressing left & right keys to change cells.'),
    );
    $form['set_gallery_size'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Set gallery size'),
      '#default_value' => $settings['set_gallery_size'],
      '#description' => $this
        ->t('Sets the height of the gallery to the height of the tallest cell.'),
    );
    $form['resize'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Resize'),
      '#default_value' => $settings['resize'],
      '#description' => $this
        ->t('Adjusts sizes and positions when window is resized.'),
    );

    // Cell position
    $form['cell_align'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cell align'),
      '#default_value' => $settings['cell_align'],
      '#size' => 30,
      '#description' => $this
        ->t('Align cells within the gallery element.'),
    );
    $form['contain'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Contain'),
      '#default_value' => $settings['contain'],
      '#description' => $this
        ->t('Contains cells to gallery element to prevent excess scroll at beginning or end.'),
    );
    $form['percent_position'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Percent position'),
      '#default_value' => $settings['percent_position'],
      '#description' => $this
        ->t('Sets positioning in percent values, rather than pixel values.'),
    );
    $form['right_to_left'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Right to left'),
      '#default_value' => $settings['right_to_left'],
      '#description' => $this
        ->t('Enables right-to-left layout.'),
    );

    // Behavior
    $form['draggable'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Draggable'),
      '#default_value' => $settings['draggable'],
      '#description' => $this
        ->t('Enables dragging and flicking.'),
    );
    $form['free_scroll'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Free scroll'),
      '#default_value' => $settings['free_scroll'],
      '#description' => $this
        ->t('Enables content to be freely scrolled and flicked without aligning cells to an end position.'),
    );
    $form['wrap_around'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Wrap around'),
      '#default_value' => $settings['wrap_around'],
      '#description' => $this
        ->t('At the end of cells, wrap-around to the other end for infinite scrolling.'),
    );

    // @todo, provide additional field if #state is true.
    $form['lazy_load'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Lazy load'),
      '#default_value' => $settings['lazy_load'],
      '#description' => $this
        ->t('Loads cell images when a cell is selected.'),
    );

    // @todo, provide additional field if #state is true.
    $form['auto_play'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Auto play'),
      '#default_value' => $settings['auto_play'],
      '#description' => $this
        ->t('Auto-playing will pause when mouse is hovered over, and resume when mouse is hovered off. Auto-playing will stop when the gallery is clicked or a cell is selected.'),
    );

    // Extra
    $form['watch_css'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Watch CSS'),
      '#default_value' => $settings['watch_css'],
      '#description' => $this
        ->t('You can enable and disable Flickity with CSS. watchCSS option watches the content of :after of the gallery element. Flickity is enabled if :after content is flickity.'),
    );
    $form['as_nav_for'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('As nav for'),
      '#default_value' => $settings['as_nav_for'],
      '#size' => 30,
      '#description' => $this
        ->t('Use one Flickity gallery as navigation for another. This can be set a selector string'),
    );

    // Display
    $form['selected_attraction'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Selected attraction'),
      '#default_value' => $settings['selected_attraction'],
      '#size' => 30,
      '#description' => $this
        ->t('Attracts the position of the slider to the selected cell. Higher attraction makes the slider move faster.'),
    );
    $form['friction'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Friction'),
      '#default_value' => $settings['friction'],
      '#size' => 30,
      '#description' => $this
        ->t('Slows the movement of slider. Higher friction makes the slider feel stickier and less bouncy. Lower friction makes the slider feel looser and more wobbly.'),
    );
    $form['free_scroll_friction'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Free scroll friction'),
      '#default_value' => $settings['free_scroll_friction'],
      '#size' => 30,
      '#description' => $this
        ->t('Slows movement of slider when freeScroll: true. Higher friction makes the slider feel stickier. Lower friction makes the slider feel looser.'),
    );

    // UI
    $form['prev_next_buttons'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Previous next buttons'),
      '#default_value' => $settings['prev_next_buttons'],
      '#description' => $this
        ->t('Creates and enables previous & next buttons.'),
    );
    $form['page_dots'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Page dots'),
      '#default_value' => $settings['page_dots'],
      '#description' => $this
        ->t('Creates and enables page dots.'),
    );
    return parent::form($form, $form_state, $entity);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $entity = $this->entity;
    $entity
      ->set('label', trim($entity
      ->label()));
    $entity
      ->set('settings', array(
      'images_loaded' => $form_state
        ->getValue('images_loaded'),
      'cell_selector' => $form_state
        ->getValue('cell_selector'),
      'initial_index' => $form_state
        ->getValue('initial_index'),
      'accessibility' => $form_state
        ->getValue('accessibility'),
      'set_gallery_size' => $form_state
        ->getValue('set_gallery_size'),
      'resize' => $form_state
        ->getValue('resize'),
      'cell_align' => $form_state
        ->getValue('cell_align'),
      'contain' => $form_state
        ->getValue('contain'),
      'percent_position' => $form_state
        ->getValue('percent_position'),
      'right_to_left' => $form_state
        ->getValue('right_to_left'),
      'draggable' => $form_state
        ->getValue('draggable'),
      'free_scroll' => $form_state
        ->getValue('free_scroll'),
      'wrap_around' => $form_state
        ->getValue('wrap_around'),
      'lazy_load' => $form_state
        ->getValue('lazy_load'),
      'auto_play' => $form_state
        ->getValue('auto_play'),
      'watch_css' => $form_state
        ->getValue('watch_css'),
      'as_nav_for' => $form_state
        ->getValue('as_nav_for'),
      'selected_attraction' => $form_state
        ->getValue('selected_attraction'),
      'friction' => $form_state
        ->getValue('friction'),
      'free_scroll_friction' => $form_state
        ->getValue('free_scroll_friction'),
      'prev_next_buttons' => $form_state
        ->getValue('prev_next_buttons'),
      'page_dots' => $form_state
        ->getValue('page_dots'),
    ));
    $status = $entity
      ->save();
    $edit_link = $this->entity
      ->link($this
      ->t('Edit'));
    $action = $status == SAVED_UPDATED ? 'updated' : 'added';

    // Group has been updated.
    drupal_set_message($this
      ->t('Group %label has been %action.', [
      '%label' => $entity
        ->label(),
      '%action' => $action,
    ]));
    $this
      ->logger('flickity')
      ->notice('Group %label has been %action.', array(
      '%label' => $entity
        ->label(),
      'link' => $edit_link,
    ));

    // Redirect back to display view.
    $form_state
      ->setRedirect('flickity.group_list');
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);
    $actions['submit']['#value'] = $this->entity
      ->isNew() ? $this
      ->t('Add group') : $this
      ->t('Update group');
    return $actions;
  }

}

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
EntityForm::$entity protected property The entity being used by this form. 7
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::$privateEntityManager private property The entity manager.
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 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
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 1
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
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::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
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
EntityForm::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 FormInterface::submitForm 17
EntityForm::__get public function
EntityForm::__set public function
FlickityGroupForm::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
FlickityGroupForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
FlickityGroupForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
FormBase::$configFactory protected property The config factory. 1
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. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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. Overrides UrlGeneratorTrait::redirect
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 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.