abstract class RequiredPlugin in Required by role 7.2

@file Base required class.

Hierarchy

• class \RequiredPlugin implements RequiredInterface

1 string reference to 'RequiredPlugin'

RequiredByRoleBaseUnitTestCase::setUp in tests/required_by_role_test/RequiredByRoleBaseUnitTestCase.test

Sets up unit test environment.

File

./RequiredPlugin.php, line 7

Base required class.

abstract class RequiredPlugin implements RequiredInterface {
  protected $context;

  /**
   * Provides a form element to configure the plugin options.
   */
  protected function formElement() {
    return array();
  }

  /**
   * Provides a form element to configure the plugin options.
   */
  public function form($value) {
    $default_value = !empty($value) ? $value : NULL;
    $element = array(
      '#prefix' => '<div id="required-ajax-wrapper">',
      '#suffix' => '</div>',
      '#default_value' => $default_value,
    ) + $this
      ->formElement();
    return $element;
  }

  /**
   * Helper function to get the plugin settings.
   */
  protected function getAccount() {
    return $this->context['account'];
  }

  /**
   * Helper function to get the plugin settings.
   */
  protected function getSettings() {
    return $this->context['instance']['settings'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RequiredInterface::isRequired	public	function	Core function, determines wether or not a field is required.	2
RequiredPlugin::$context	protected	property
RequiredPlugin::form	public	function	Provides a form element to configure the plugin options.
RequiredPlugin::formElement	protected	function	Provides a form element to configure the plugin options.	2
RequiredPlugin::getAccount	protected	function	Helper function to get the plugin settings.
RequiredPlugin::getSettings	protected	function	Helper function to get the plugin settings.