class ServicesClientPlugin in Services Client 7.2

Base plugin class

Hierarchy

• class \ServicesClientPlugin implements ServicesClientConfigurableInterface

File

include/plugin.inc, line 56

Base plugin definitions. All other plugins should be extended from this set of plugins.

class ServicesClientPlugin implements ServicesClientConfigurableInterface {

  /**
   * Event definition
   */
  protected $event;

  /**
   * Plugin specific configuration
   *
   * @var array
   */
  protected $config;

  /**
   * Constructor.
   *
   * @param stdClass $event
   *   Event DB record.
   *
   * @param array $config
   *   Plugin configuration.
   */
  public function __construct($event, $config) {

    // Store configuration and connection definition
    $this->event = $event;
    $this->config = $config;
  }

  /**
   * Set configuration of plugin.
   *
   * @param array $config
   *   Configuration array.
   */
  public function setConfiguration($config) {
    $this->config = $config;
    return $this;
  }

  /**
   * Retrieve current plugin configuration.
   *
   * @return array
   */
  public function getConfiguration() {
    return $this->config;
  }

  /**
   * Configuration form options
   */
  public function configForm(&$form, &$form_state) {
    $form['markup'] = array(
      '#type' => 'item',
      '#markup' => t("This plugin doesn't provide any configuration options."),
    );
  }
  public function configFormValidate(&$form, &$form_state) {
  }
  public function configFormSubmit(&$form, &$form_state) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ServicesClientPlugin::$config	protected	property	Plugin specific configuration
ServicesClientPlugin::$event	protected	property	Event definition
ServicesClientPlugin::configForm	public	function	Configuration form options Overrides ServicesClientConfigurableInterface::configForm	6
ServicesClientPlugin::configFormSubmit	public	function	Submit configuration form and save config. Overrides ServicesClientConfigurableInterface::configFormSubmit	6
ServicesClientPlugin::configFormValidate	public	function	Validate configuration form. Overrides ServicesClientConfigurableInterface::configFormValidate	1
ServicesClientPlugin::getConfiguration	public	function	Retrieve current plugin configuration. Overrides ServicesClientConfigurableInterface::getConfiguration
ServicesClientPlugin::setConfiguration	public	function	Set configuration of plugin. Overrides ServicesClientConfigurableInterface::setConfiguration
ServicesClientPlugin::__construct	public	function	Constructor.	3