Drupal\dkan_non_public\Plugin\DataModifier\NonPublicResourceProtector Class Reference

Inheritance diagram for Drupal\dkan_non_public\Plugin\DataModifier\NonPublicResourceProtector:

Public Member Functions
	__construct (array $configuration, $plugin_id, $plugin_definition, Connection $database, RouteMatchInterface $routeMatch)
	requiresModification (string $schema, $data)
	modify (string $schema, $data)
Public Member Functions inherited from Drupal\dkan_common\Plugin\DataModifierBase
	message ()
	httpCode ()

Static Public Member Functions
static	create (ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition)

Detailed Description

Implements a data modifier plugin to protect non-public datasets' resources.

@DataModifier( id = "non_public_resource_protector", label = @Translation("Protects resources of non-public datasets"), result = @Translation("Resource hidden since dataset access level is non-public."), code = "401", )

Definition at line 21 of file NonPublicResourceProtector.php.

Constructor & Destructor Documentation

__construct()

Drupal\dkan_non_public\Plugin\DataModifier\NonPublicResourceProtector::__construct	(	array	$configuration,
			$plugin_id,
			$plugin_definition,
		Connection	$database,
		RouteMatchInterface	$routeMatch
	)

NonPublicResourceProtector constructor.

Parameters

array	$configuration	A configuration array containing information about the plugin instance.
string	$plugin_id	The plugin_id for the plugin instance.
mixed	$plugin_definition	The plugin implementation definition.
\Drupal\Core\Database\Connection	$database	The database service.
\Drupal\Core\Routing\RouteMatchInterface	$routeMatch	The current route match service.

Definition at line 61 of file NonPublicResourceProtector.php.

Member Function Documentation

create()

static Drupal\dkan_non_public\Plugin\DataModifier\NonPublicResourceProtector::create ( ContainerInterface  $container, array  $configuration,   $plugin_id,   $plugin_definition  )

static

{}

Definition at line 73 of file NonPublicResourceProtector.php.

modify()

Drupal\dkan_non_public\Plugin\DataModifier\NonPublicResourceProtector::modify	(	string	$schema,
			$data
	)

Protect potentially sensitive data in a dataset or distribution.

Parameters

string	$schema	The schema id.
object | string	$data	Object, json or identifier string representing a dataset or distribution.

Returns

mixed Modified data, or FALSE.

Implements Drupal\dkan_common\Plugin\DataModifierInterface.

Definition at line 213 of file NonPublicResourceProtector.php.

requiresModification()

Drupal\dkan_non_public\Plugin\DataModifier\NonPublicResourceProtector::requiresModification	(	string	$schema,
			$data
	)

Check if a resource needs to be protected.

Parameters

string	$schema	The schema id.
object | string	$data	Object, json or identifier string representing a dataset or distribution.

Returns

bool TRUE if the data requires modification, FALSE otherwise.

Implements Drupal\dkan_common\Plugin\DataModifierInterface.

Definition at line 94 of file NonPublicResourceProtector.php.