class FormHelper in Filebrowser 3.x

Class FormHelper Service that provides utilities to forms

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\filebrowser\Services\FormHelper

1 file declares its use of FormHelper

GridActionForm.php in src/Form/GridActionForm.php

1 string reference to 'FormHelper'

filebrowser.services.yml in ./filebrowser.services.yml

filebrowser.services.yml

1 service uses FormHelper

form.helper in ./filebrowser.services.yml

Drupal\filebrowser\Services\FormHelper

File

src/Services/FormHelper.php, line 14

Namespace

Drupal\filebrowser\Services

class FormHelper extends ControllerBase {

  /**
   * @var NodeInterface
   * Node holding this directory listing
   */
  protected $node;
  public function initForm(&$form, NodeInterface $node) {
    $this->node = $node;
    $form['nid'] = [
      '#type' => 'value',
      '#value' => $this->node
        ->id(),
    ];
    $form['fids'] = [
      '#type' => 'value',
      '#value' => null,
    ];
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
    $form['#attached']['library'][] = 'filebrowser/filebrowser-styles';
    $form['#attached']['library'][] = 'core/jquery.form';
  }
  public function createActionBar(&$form, array $actions, $relative_fid) {
    $form['action'] = [
      '#type' => 'container',
      '#attributes' => [
        'id' => [
          'form-action-actions-wrapper',
        ],
      ],
    ];
    foreach ($actions as $action) {
      switch ($action['type']) {
        case 'link':

          // Create a link that opens (JS) a form on the page
          $form['action'][$action['operation']] = $this
            ->createLink($action, $this->node, $relative_fid);
          break;
        case 'button':

          // Create a submit button that opens (JS) a form on the page
          $form['action'][$action['operation']] = $this
            ->createAjaxButton($action);
          break;
        default:

          // Create a normal submit button
          $form['action'][$action['operation']] = $this
            ->createNormalButton($action);
      }
    }
  }
  public function createLink(array $action, NodeInterface $node, $relative_fid) {
    $route = 'filebrowser.action';

    // fixme: Bit of an ugly solution to have proper spacing af the action links
    $is_add_folder_link = $action['operation'] == 'folder' ? 'add-folder-link' : '';
    $link_options = [
      'attributes' => [
        'class' => [
          'use-ajax',
          'button',
          'btn',
          'btn-default',
          $is_add_folder_link,
        ],
      ],
    ];
    $route_options = [
      'op' => $action['operation'],
      'method' => 'nojs',
      'nid' => $node
        ->id(),
      'query_fid' => $relative_fid,
    ];
    return [
      '#markup' => Link::createFromRoute($action['title'], $route, $route_options, $link_options)
        ->toString(),
    ];
  }
  public function createAjaxButton($action) {
    return [
      '#type' => 'submit',
      '#return_value' => $action['operation'],
      '#value' => $action['title'],
      '#name' => $action['operation'],
      '#title' => $action['title'],
      '#attributes' => [
        'class' => [
          'use-ajax-submit',
        ],
      ],
      '#validate' => [
        '::ajaxValidate',
      ],
    ];
  }
  public function createNormalButton($action) {
    return [
      '#type' => 'submit',
      '#return_value' => $action['operation'],
      '#value' => $action['title'],
      '#name' => $action['operation'],
      '#title' => $action['title'],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	46
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
FormHelper::$node	protected	property	Node holding this directory listing
FormHelper::createActionBar	public	function
FormHelper::createAjaxButton	public	function
FormHelper::createLink	public	function
FormHelper::createNormalButton	public	function
FormHelper::initForm	public	function
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.