ResourcePopulator
class ResourcePopulator implements ResourcePopulatorInterface (View source)
This service will take a CKAN Resource and populate its Fields has_many
relationship and other data
from the CKAN API
Traits
A class that can be instantiated or replaced via DI
Properties
protected | APIClientInterface | $apiClient |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Populates the Resource with metadata from the API response, such as the name of the data set
Take a CKAN Resource and populate its Fields has_many
relationship and other data
from the CKAN API response.
Validates that the given Resource has the necessary data to make the request
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
populateMetadata(Resource $resource)
Populates the Resource with metadata from the API response, such as the name of the data set
populateFields(Resource $resource)
Take a CKAN Resource and populate its Fields has_many
relationship and other data
from the CKAN API response.
protected bool
validateResource(Resource $resource)
Validates that the given Resource has the necessary data to make the request
protected string
parseName(string $id)
Parse given column ID for a more readable version
APIClientInterface
getAPIClient()
No description
$this
setAPIClient(APIClientInterface $apiClient)
No description