You are here

interface FeedsSourceInterface in Feeds 6

Same name and namespace in other branches
  1. 7.2 includes/FeedsSource.inc \FeedsSourceInterface
  2. 7 includes/FeedsSource.inc \FeedsSourceInterface

Declares an interface for a class that defines default values and form descriptions for a FeedSource.

Hierarchy

Expanded class hierarchy of FeedsSourceInterface

All classes that implement FeedsSourceInterface

File

includes/FeedsSource.inc, line 12
Definition of FeedsSourceInterface and FeedsSource class.

View source
interface FeedsSourceInterface {

  /**
   * Crutch: for ease of use, we implement FeedsSourceInterface for every
   * plugin, but then we need to have a handle which plugin actually implements
   * a source.
   *
   * @see FeedsPlugin class.
   *
   * @return
   *   TRUE if a plugin handles source specific configuration, FALSE otherwise.
   */
  public function hasSourceConfig();

  /**
   * Return an associative array of default values.
   */
  public function sourceDefaults();

  /**
   * Return a Form API form array that defines a form configuring values. Keys
   * correspond to the keys of the return value of sourceDefaults().
   */
  public function sourceForm($source_config);

  /**
   * Validate user entered values submitted by sourceForm().
   */
  public function sourceFormValidate(&$source_config);

  /**
   * A source is being saved.
   */
  public function sourceSave(FeedsSource $source);

  /**
   * A source is being deleted.
   */
  public function sourceDelete(FeedsSource $source);

}

Members

Namesort descending Modifiers Type Description Overrides
FeedsSourceInterface::hasSourceConfig public function Crutch: for ease of use, we implement FeedsSourceInterface for every plugin, but then we need to have a handle which plugin actually implements a source. 1
FeedsSourceInterface::sourceDefaults public function Return an associative array of default values. 1
FeedsSourceInterface::sourceDelete public function A source is being deleted. 1
FeedsSourceInterface::sourceForm public function Return a Form API form array that defines a form configuring values. Keys correspond to the keys of the return value of sourceDefaults(). 1
FeedsSourceInterface::sourceFormValidate public function Validate user entered values submitted by sourceForm(). 1
FeedsSourceInterface::sourceSave public function A source is being saved. 1