class OperatorsHelper in Entity Share 8

Defines the Operators helper class.

Hierarchy

• class \Drupal\entity_share_server\OperatorsHelper

3 files declare their use of OperatorsHelper

Channel.php in modules/entity_share_server/src/Entity/Channel.php

FilterAddForm.php in modules/entity_share_server/src/Form/FilterAddForm.php

FilterEditForm.php in modules/entity_share_server/src/Form/FilterEditForm.php

File

modules/entity_share_server/src/OperatorsHelper.php, line 8

Namespace

Drupal\entity_share_server

class OperatorsHelper {

  /**
   * Helper function to get the operator options.
   *
   * @return array
   *   An array of options.
   */
  public static function getOperatorOptions() {
    return [
      '=' => '=',
      '<' => '<',
      '>' => '>',
      '<>' => '<>',
      'IN' => 'IN',
      'NOT IN' => 'NOT IN',
      'IS NULL' => 'IS NULL',
      'IS NOT NULL' => 'IS NOT NULL',
      'CONTAINS' => 'CONTAINS',
      'BETWEEN' => 'BETWEEN',
    ];
  }

  /**
   * Helper function to get the stand alone operators.
   *
   * Operators that do not require a value to be entered.
   *
   * @return array
   *   An array of options.
   */
  public static function getStandAloneOperators() {
    return [
      'IS NULL' => 'IS NULL',
      'IS NOT NULL' => 'IS NOT NULL',
    ];
  }

  /**
   * Helper function to get the multiple values operators.
   *
   * Operators that allow to have multiple values entered.
   *
   * @return array
   *   An array of options.
   */
  public static function getMultipleValuesOperators() {
    return [
      'IN' => 'IN',
      'NOT IN' => 'NOT IN',
      'BETWEEN' => 'BETWEEN',
    ];

    // TODO: The following operators are marked as multiple values in JSONAPI
    // documentation https://www.drupal.org/docs/8/modules/json-api/collections-filtering-sorting-and-paginating
    // But it does not work. See why.
    // '=' => '=',
    // '<' => '<',
    // '>' => '>',
    // '<>' => '<>',.
  }

}

Members

Name	Modifiers	Type	Description	Overrides
OperatorsHelper::getMultipleValuesOperators	public static	function	Helper function to get the multiple values operators.
OperatorsHelper::getOperatorOptions	public static	function	Helper function to get the operator options.
OperatorsHelper::getStandAloneOperators	public static	function	Helper function to get the stand alone operators.