class CmisQueryForm in CMIS API 3.0.x

Same name and namespace in other branches

8.2 src/Form/CmisQueryForm.php \Drupal\cmis\Form\CmisQueryForm
8 src/Form/CmisQueryForm.php \Drupal\cmis\Form\CmisQueryForm

Class CmisQueryForm.

@package Drupal\cmis\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\cmis\Form\CmisQueryForm

Expanded class hierarchy of CmisQueryForm

1 string reference to 'CmisQueryForm'

cmis.routing.yml in ./cmis.routing.yml: cmis.routing.yml

File

src/Form/CmisQueryForm.php, line 17

Namespace

Drupal\cmis\Form

View source

class CmisQueryForm extends FormBase {

  /**
   * Configuration ID.
   *
   * @var string
   */
  protected $config;

  /**
   * Connection object.
   *
   * @var object
   */
  protected $connection;

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'cmis_query_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $parameters = $this
      ->getRequest()->query
      ->all();
    unset($parameters['type']);
    $configuration_options = cmis_get_configurations();
    unset($configuration_options['_none']);
    $current_user = $this
      ->currentUser();
    foreach ($configuration_options as $config_id => $config_name) {
      $permission = 'access cmis browser ' . $config_id;
      if (!$current_user
        ->hasPermission($permission) && !$current_user
        ->hasPermission('access all cmis browsers')) {
        unset($configuration_options[$config_id]);
      }
    }
    $first_config = reset($configuration_options);
    $input = $form_state
      ->getUserInput();
    $user_inputs = array_merge($parameters, $input);
    if (!empty($user_inputs)) {
      $form_state
        ->setUserInput($user_inputs);
    }
    $input = $user_inputs;
    $form['config'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Configuration'),
      '#description' => $this
        ->t('Select the configuration for repository.'),
      '#options' => $configuration_options,
      '#default_value' => !empty($input['config']) ? $input['config'] : $first_config,
    ];
    $form['query_string'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Query string'),
      '#description' => $this
        ->t('Enter a valid CMIS query.'),
      '#default_value' => !empty($input['query_string']) ? $input['query_string'] : '',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Run'),
      '#ajax' => [
        'callback' => '::ajaxGetResult',
        'wrapper' => 'query-result-wrapper',
      ],
    ];
    $result = '';
    if (!empty($input['query_string']) && !empty($input['config'])) {
      $this->config = $input['config'];
      if (empty($this->connection)) {
        $this->connection = new CmisConnectionApi($this->config);
      }
      if (!empty($this->connection
        ->getHttpInvoker())) {
        $result = $this
          ->queryExec($this->config, $input['query_string']);
      }
    }
    $form['result'] = [
      '#markup' => $result,
      '#prefix' => '<div id="query-result-wrapper">',
      '#suffix' => '</div>',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // No submit handling here.
  }

  /**
   * Execute query string.
   *
   * @param string $config
   *   Entity label.
   * @param string $query
   *   CMIS Query.
   *
   * @return string
   *   Return Content.
   */
  public function queryExec($config = '', $query = '') {
    $content = '';
    if (empty($config)) {
      if (!empty($this->config)) {
        $config = $this->config;
      }
      else {
        return $content;
      }
    }
    if (!empty($query)) {
      $this->connection
        ->setDefaultParameters();
      $session = $this->connection
        ->getSession();
      $results = $session
        ->query($query);
      $content = $this
        ->prepareResult($results, $query);
    }
    return $content;
  }

  /**
   * Prepare results to rendered table.
   *
   * @param array $results
   *   Get result.
   * @param string $query
   *   CMIS query.
   *
   * @return string
   *   Return content.
   */
  private function prepareResult(array $results, $query) {
    $content = '';
    $rows = [];
    $table_header = [
      $this
        ->t('Name'),
      $this
        ->t('Details'),
      $this
        ->t('Author'),
      $this
        ->t('Created'),
      $this
        ->t('Description'),
      $this
        ->t('Operation'),
    ];
    $root = $this->connection
      ->getRootFolder();
    $element = new CmisElement($this->config, FALSE, NULL, $query, $root
      ->getId());
    if ($session = $this->connection
      ->getSession()) {
      foreach ($results as $result) {
        $id = $result
          ->getPropertyValueById('cmis:objectId');
        $cid = $session
          ->createObjectId($id);
        if ($object = $session
          ->getObject($cid)) {
          $element
            ->setElement('query', $object);
          $rows[] = $element
            ->getData();
        }
      }
      if (!empty($rows)) {
        $table = [
          '#theme' => 'cmis_browser',
          '#header' => $table_header,
          '#elements' => $rows,
        ];
        $content = render($table);
      }
    }
    return $content;
  }

  /**
   * Submit button ajax callback.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return array
   *   Subform.
   */
  public function ajaxGetResult(array &$form, FormStateInterface $form_state) {
    return $form['result'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CmisQueryForm::$config	protected	property	Configuration ID.
CmisQueryForm::$connection	protected	property	Connection object.
CmisQueryForm::ajaxGetResult	public	function	Submit button ajax callback.
CmisQueryForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
CmisQueryForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CmisQueryForm::prepareResult	private	function	Prepare results to rendered table.
CmisQueryForm::queryExec	public	function	Execute query string.
CmisQueryForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	105
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.

You are here

class CmisQueryForm in CMIS API 3.0.x

Hierarchy

File

Namespace

Members

API Navigation