abstract class MigrateList in Migrate 7.2
Same name and namespace in other branches
- 6.2 plugins/sources/list.inc \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).
Hierarchy
- class \MigrateList
Expanded class hierarchy of MigrateList
File
- plugins/
sources/ list.inc, line 17 - Support for migration from sources with distinct means of listing items to import and obtaining the items themselves.
View source
abstract class MigrateList {
public function __construct() {
}
/**
* Implementors are expected to return a string representing where the listing
* is obtained from (a URL, file directory, etc.)
*
* @return string
*/
public abstract function __toString();
/**
* 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 Mixed, iterator or array
*/
public abstract function getIdList();
/**
* Implementors are expected to return a count of IDs available to be
* migrated.
*
* @return int
*/
public abstract function computeCount();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
MigrateList:: |
abstract public | function | Implementors are expected to return a count of IDs available to be migrated. | 4 |
MigrateList:: |
abstract public | function | 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. | 4 |
MigrateList:: |
public | function | 4 | |
MigrateList:: |
abstract public | function | Implementors are expected to return a string representing where the listing is obtained from (a URL, file directory, etc.) | 4 |