Open Data Catalog v2.0.0
Drupal\dkan_harvest\Transform\ResourceImporter Class Reference
Inheritance diagram for Drupal\dkan_harvest\Transform\ResourceImporter:

Public Member Functions

 run ($dataset)
 
 saveFile ($url, $dataset_id)
 

Protected Member Functions

 testEnvironment ()
 
 updateDistributions ($dataset)
 
 updateDownloadUrl ($dataset, $dist)
 

Detailed Description

Defines a transform that saves the resources from a dataset.

@codeCoverageIgnore

Definition at line 14 of file ResourceImporter.php.

Member Function Documentation

◆ run()

Drupal\dkan_harvest\Transform\ResourceImporter::run (   $dataset)

Inherited.

{}

Definition at line 23 of file ResourceImporter.php.

◆ saveFile()

Drupal\dkan_harvest\Transform\ResourceImporter::saveFile (   $url,
  $dataset_id 
)

Pulls down external file and saves it locally.

If this method is called when PHP is running on the CLI (e.g. via drush), ‘$settings['file_public_base_url’]must be configured insettings.php‘, otherwise 'default’ will be used as the hostname in the new URL.

Parameters
string$urlExternal file URL.
string$dataset_idDataset identifier used to group resources together.
Returns
string|bool The URL for the newly created file, or FALSE if failure occurs.

Definition at line 113 of file ResourceImporter.php.

◆ testEnvironment()

Drupal\dkan_harvest\Transform\ResourceImporter::testEnvironment ( )
protected

Test Environment.

@codeCoverageIgnore

Definition at line 33 of file ResourceImporter.php.

◆ updateDistributions()

Drupal\dkan_harvest\Transform\ResourceImporter::updateDistributions (   $dataset)
protected

Update the distributions attached to a dataset.

Parameters
object$datasetJSON decoded dataset.
Returns
object The original dataset with updated distributions.

Definition at line 50 of file ResourceImporter.php.

◆ updateDownloadUrl()

Drupal\dkan_harvest\Transform\ResourceImporter::updateDownloadUrl (   $dataset,
  $dist 
)
protected

Attempt to import distribution file and update downloadURL property.

Parameters
object$datasetJSON decoded dataset.
object$distJSON decoded distribution.
Returns
object The updated distribution.

Definition at line 80 of file ResourceImporter.php.