interface FeedsSourceInterface in Feeds 7.2

Defines an interface for a feed source.

Hierarchy

• interface \FeedsSourceInterface

File

includes/FeedsSource.inc, line 26

Definition of FeedsSourceInterface, FeedsState and FeedsSource class.

interface FeedsSourceInterface {

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

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

  /**
   * Returns 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

Name	Modifiers	Type	Description	Overrides
FeedsSourceInterface::hasSourceConfig	public	function	Returns if a plugin handles source specific configuration.	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	Returns a Form API form array that defines a form configuring values.	1
FeedsSourceInterface::sourceFormValidate	public	function	Validate user entered values submitted by sourceForm().	1
FeedsSourceInterface::sourceSave	public	function	A source is being saved.	1