Drupal\dkan_common\Plugin\DataModifierInterface Interface Reference

Inheritance diagram for Drupal\dkan_common\Plugin\DataModifierInterface:

Public Member Functions
	requiresModification (string $schema, $data)
	modify (string $schema, $data)
	message ()
	httpCode ()

Detailed Description

Defines an interface for Data modifier plugins.

Plugins of this type may have different conditions and outcomes, but all act on the following publicly accessible API endpoints:

• The metastore's GET collection and GET item
• The dataset-specific Api Docs
• The datastore's SQL query.

Definition at line 16 of file DataModifierInterface.php.

Member Function Documentation

httpCode()

Drupal\dkan_common\Plugin\DataModifierInterface::httpCode

(

)

Return the http code annotation.

Returns

int The http code.

Implemented in Drupal\dkan_common\Plugin\DataModifierBase.

message()

Drupal\dkan_common\Plugin\DataModifierInterface::message

(

)

Translate and render the result annotation.

Returns

string A message explaining the outcome.

Implemented in Drupal\dkan_common\Plugin\DataModifierBase.

modify()

Drupal\dkan_common\Plugin\DataModifierInterface::modify	(	string	$schema,
			$data
	)

Modify data.

Parameters

string	$schema	The schema id.
mixed	$data	The object, json string or identifier whose data needs modifying.

Returns

mixed The modified data object, or FALSE.

Implemented in Drupal\dkan_non_public\Plugin\DataModifier\NonPublicResourceProtector.

requiresModification()

Drupal\dkan_common\Plugin\DataModifierInterface::requiresModification	(	string	$schema,
			$data
	)

Checks if the schema or data needs modifying.

Parameters

string	$schema	The schema id.
mixed	$data	The data object, json string or identifier.

Returns

bool TRUE if the data requires modification, FALSE otherwise.

Implemented in Drupal\dkan_non_public\Plugin\DataModifier\NonPublicResourceProtector.