abstract public function MigrateList::getIdList in Migrate 7.2

Same name and namespace in other branches

1. 6.2 plugins/sources/list.inc \MigrateList::getIdList()

Implementors are expected to return an array of unique IDs, suitable for passing to the MigrateItem class to retrieve the data for a single item.

Return value

Mixed, iterator or array

4 methods override MigrateList::getIdList()

MigrateListCSV::getIdList in plugins/sources/csv.inc

Return an array of IDs from the CSV file.

MigrateListFiles::getIdList in plugins/sources/files.inc

Retrieve a list of files based on parameters passed for the migration.

MigrateListJSON::getIdList in plugins/sources/json.inc

Load the JSON at the given URL, and return an array of the IDs found within it.

MigrateListXML::getIdList in plugins/sources/xml.inc

Load the XML at the given URL, and return an array of the IDs found within it.

File

plugins/sources/list.inc, line 36

Support for migration from sources with distinct means of listing items to import and obtaining the items themselves.

Class

MigrateList

Extend the MigrateList class to provide a means to obtain a list of IDs to be migrated from a given source (e.g., MigrateListXML extends MigrateList to obtain a list of IDs from an XML document).

Code

public abstract function getIdList();