You are here

interface RestfulPluginInterface in RESTful 7

@file Contains RestfulPluginInterface

Hierarchy

Expanded class hierarchy of RestfulPluginInterface

All classes that implement RestfulPluginInterface

File

includes/RestfulPluginInterface.php, line 8
Contains RestfulPluginInterface

View source
interface RestfulPluginInterface {

  /**
   * Gets information about the restful plugin.
   *
   * @return array
   *   The plugin definition.
   */
  public function getPlugin();

  /**
   * Sets information about the restful plugin.
   *
   * @param array $plugin
   *   The plugin definition.
   */
  public function setPlugin($plugin);

  /**
   * Gets information about the restful plugin key.
   *
   * @param string $key
   *   The name of the key to return.
   *
   * @return mixed
   *   Depends on the requested value. NULL if the key is not found.
   */
  public function getPluginKey($key);

  /**
   * Gets information about the restful plugin key.
   *
   * @param string $key
   *   The name of the key to return.
   * @param mixed $value
   *   The value to set.
   */
  public function setPluginKey($key, $value);

}

Members

Namesort descending Modifiers Type Description Overrides
RestfulPluginInterface::getPlugin public function Gets information about the restful plugin. 1
RestfulPluginInterface::getPluginKey public function Gets information about the restful plugin key. 1
RestfulPluginInterface::setPlugin public function Sets information about the restful plugin. 1
RestfulPluginInterface::setPluginKey public function Gets information about the restful plugin key. 1