ConditionalFieldsHandlersPluginInterface.php in Conditional Fields 8

Namespace

Drupal\conditional_fields

File

src/ConditionalFieldsHandlersPluginInterface.php

<?php

namespace Drupal\conditional_fields;


/**
 * Defines the required interface for all conditional field's handler plugins.
 */
interface ConditionalFieldsHandlersPluginInterface {

  /**
   * Executes states handler according to conditional fields settings.
   */
  public function statesHandler($field, $field_info, $options);

  /**
   * Get values from widget settings for plugin.
   *
   * @param array $value_form
   *   Dependency options.
   *
   * @return mixed
   *   Values for triggering events.
   */
  public function getWidgetValue(array $value_form);

  /**
   * Get values form the condition options
   *
   * @param array $options
   *   The condition options or the array of values
   *
   * @return mixed
   *   Values for triggering events.
   */
  public function getConditionValues(array $options);

}

Interfaces

Name	Description
ConditionalFieldsHandlersPluginInterface	Defines the required interface for all conditional field's handler plugins.