PHP Interface ScriptFUSION\Porter\Provider\Resource\ProviderResource

Show file Open project: ScriptFUSION/Porter Interface Usage Examples

Public Methods

Method	Description
fetch ( ScriptFUSION\Porter\Connector\Connector $connector, EncapsulatedOptions $options = null ) : Iterator	Fetches data from the provider using the the specified connector and presents its data as an enumerable series.
getProviderClassName ( ) : string	Gets the class name of the provider this resource belongs to.
getProviderTag ( ) : string \| null	Gets the provider identifier tag.

Method Details

fetch() public method

Fetches data from the provider using the the specified connector and presents its data as an enumerable series.

public fetch ( ScriptFUSION\Porter\Connector\Connector $connector, EncapsulatedOptions $options = null ) : Iterator
$connector	ScriptFUSION\Porter\Connector\Connector	Connector.
$options	ScriptFUSION\Porter\Options\EncapsulatedOptions	Optional. Options.
return	Iterator	Enumerable data series.

getProviderClassName() public method

Gets the class name of the provider this resource belongs to.

public getProviderClassName ( ) : string
return	string	Provider class name.

getProviderTag() public method

Gets the provider identifier tag.

public getProviderTag ( ) : string \| null
return	string \| null	Provider tag.