class FeedsClientsFetcher in Web Service Clients 6

Fetches data via HTTP.

Hierarchy

• class \FeedsConfigurable
  • class \FeedsPlugin implements FeedsSourceInterface
    • class \FeedsFetcher
      • class \FeedsClientsFetcher

2 string references to 'FeedsClientsFetcher'

clients_feeds_feeds_plugins in clients/clients_feeds/clients_feeds.module

Implementation of hook_feeds_plugins().

_clients_feeds_feeds_importer_default in clients/clients_feeds/clients_feeds.defaults.inc

Helper to implementation of hook_feeds_importer_default().

File

clients/clients_feeds/FeedsClientsFetcher.inc, line 10

Home of the FeedsFileFetcher.

class FeedsClientsFetcher extends FeedsFetcher {

  /**
   * Fetch a local resource.
   */
  public function fetch(FeedsSource $source) {
    $source_config = $source
      ->getConfig();
    $resource = clients_resource_load((int) $source_config['FeedsClientsParser']['source']);
    $result = clients_call($resource);
    $items = isset($result[0]->data) ? $result[0]->data : array();

    // (feeds > alpha9)
    $batch = new FeedsImportBatch();
    $batch
      ->setItems($items);
    return $batch;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsClientsFetcher::fetch	public	function	Fetch a local resource. Overrides FeedsFetcher::fetch
FeedsConfigurable::$config	protected	property
FeedsConfigurable::$disabled	protected	property	CTools export enabled status of this object.
FeedsConfigurable::$export_type	protected	property
FeedsConfigurable::$id	protected	property
FeedsConfigurable::addConfig	public	function	Similar to setConfig but adds to existing configuration.	1
FeedsConfigurable::configDefaults	public	function	Return default configuration.	6
FeedsConfigurable::configForm	public	function	Return configuration form for this object. The keys of the configuration form must match the keys of the array returned by configDefaults().	10
FeedsConfigurable::configFormSubmit	public	function	Submission handler for configForm().	3
FeedsConfigurable::configFormValidate	public	function	Validation handler for configForm().	3
FeedsConfigurable::copy	public	function	Copy a configuration.	1
FeedsConfigurable::existing	public	function	Determine whether this object is persistent and enabled. I. e. it is defined either in code or in the database and it is enabled.	1
FeedsConfigurable::getConfig	public	function	Implementation of getConfig().	1
FeedsConfigurable::instance	public static	function	Instantiate a FeedsConfigurable object.	1
FeedsConfigurable::setConfig	public	function	Set configuration.	1
FeedsConfigurable::__get	public	function	Override magic method __get(). Make sure that $this->config goes through getConfig()
FeedsConfigurable::__isset	public	function	Override magic method __isset(). This is needed due to overriding __get().
FeedsFetcher::clear	public	function	Clear all caches for results for given source.	1
FeedsFetcher::importPeriod	public	function	Override import period settings. This can be used to force a certain import interval.	1
FeedsFetcher::menuItem	public	function	Menu item definition for fetchers of this class. Note how the path component in the item definition matches the return value of FeedsFetcher::path();
FeedsFetcher::path	public	function	Construct a path for a concrete fetcher/source combination. The result of this method matches up with the general path definition in FeedsFetcher::menuItem(). For example usage look at FeedsHTTPFetcher.
FeedsFetcher::request	public	function	Request handler invoked if callback URL is requested. Locked down by default. For a example usage see FeedsHTTPFetcher.	1
FeedsFetcher::subscribe	public	function	Subscribe to a source. Only implement if fetcher requires subscription.	1
FeedsFetcher::unsubscribe	public	function	Unsubscribe from a source. Only implement if fetcher requires subscription.	1
FeedsPlugin::hasSourceConfig	public	function	Returns TRUE if $this->sourceForm() returns a form. Overrides FeedsSourceInterface::hasSourceConfig
FeedsPlugin::loadMappers	protected static	function	Loads on-behalf implementations from mappers/ directory.
FeedsPlugin::save	public	function	Save changes to the configuration of this object. Delegate saving to parent (= Feed) which will collect information from this object by way of getConfig() and store it. Overrides FeedsConfigurable::save
FeedsPlugin::sourceDefaults	public	function	Implementation of FeedsSourceInterface::sourceDefaults(). Overrides FeedsSourceInterface::sourceDefaults	1
FeedsPlugin::sourceDelete	public	function	A source is being deleted. Overrides FeedsSourceInterface::sourceDelete	1
FeedsPlugin::sourceForm	public	function	Callback methods, exposes source form. Overrides FeedsSourceInterface::sourceForm	3
FeedsPlugin::sourceFormValidate	public	function	Validation handler for sourceForm. Overrides FeedsSourceInterface::sourceFormValidate	2
FeedsPlugin::sourceSave	public	function	A source is being saved. Overrides FeedsSourceInterface::sourceSave	1
FeedsPlugin::__construct	protected	function	Constructor. Overrides FeedsConfigurable::__construct