Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase Class Reference

Inheritance diagram for Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase:

Collaboration diagram for Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase:

Public Member Functions
	__construct (array $configuration, $plugin_id, $plugin_definition, \Drupal\Core\Database\Connection $connection, \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager, \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager, \Drupal\Core\Field\FieldTypePluginManager $field_type_manager, \Drupal\tripal\Services\TripalLogger $logger, \Drupal\tripal\TripalStorage\PluginManager\TripalStorageManager $storage_manager, \Drupal\tripal\Services\TripalEntityLookup $entity_lookup_manager, \Drupal\tripal\Services\TripalTokenParser $token_parser)

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

Protected Attributes
	$connection
	$entity_type_manager = NULL
	$entity_field_manager = NULL
	$field_type_manager = NULL
	$logger = NULL
	$storage_manager = NULL
	$entity_lookup_manager = NULL
	$token_parser = NULL
	$batch_size = 1000
	$job = NULL
	$bundle = ''
	$datastore = ''
	$schema_name = ''
	$republish = FALSE
array	$allowed_title_tags = []

Detailed Description

Defines a base class for Storage Backend-specific publish plugin implementations.

Constructor & Destructor Documentation

__construct()

Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::__construct	(	array	$configuration,
			$plugin_id,
			$plugin_definition,
		\Drupal\Core\Database\Connection	$connection,
		\Drupal\Core\Entity\EntityTypeManagerInterface	$entity_type_manager,
		\Drupal\Core\Entity\EntityFieldManagerInterface	$entity_field_manager,
		\Drupal\Core\Field\FieldTypePluginManager	$field_type_manager,
		\Drupal\tripal\Services\TripalLogger	$logger,
		\Drupal\tripal\TripalStorage\PluginManager\TripalStorageManager	$storage_manager,
		\Drupal\tripal\Services\TripalEntityLookup	$entity_lookup_manager,
		\Drupal\tripal\Services\TripalTokenParser	$token_parser
	)

{}

Member Function Documentation

create()

static Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::create ( ContainerInterface  $container, array  $configuration,   $plugin_id,   $plugin_definition  )

static

Implements ContainerFactoryPluginInterface->create().

Since we have implemented the ContainerFactoryPluginInterface this static function will be called behind the scenes when a Plugin Manager uses createInstance(). Specifically this method is used to determine the parameters to pass to the constructor.

Parameters

\Symfony\Component\DependencyInjection\ContainerInterface	$container
array	$configuration
string	$plugin_id
mixed	$plugin_definition

Returns

static

Member Data Documentation

$allowed_title_tags

array Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$allowed_title_tags = []

protected

Valid HTML tags for titles. This is configurable through entity settings at /admin/tripal/config/entity_settings

$batch_size

integer Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$batch_size = 1000

protected

Specifies the maximum number of records to publish at one time. This limits memory consumption if there are many thousands of records, for example gene records in the feature table.

Todo:

We might want to add this as an option on the publish form.

$bundle

string Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$bundle = ''

protected

The id of the entity type (bundle)

$datastore

string Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$datastore = ''

protected

The id of the TripalStorage plugin.

$entity_field_manager

Drupal Core Entity EntityFieldManagerInterface Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$entity_field_manager = NULL

protected

The Drupal entity field manager service.

$entity_lookup_manager

Drupal tripal Services TripalEntityLookup Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$entity_lookup_manager = NULL

protected

The Entity Lookup service.

$entity_type_manager

Drupal Core Entity EntityTypeManagerInterface Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$entity_type_manager = NULL

protected

The Drupal entity type manager service.

$field_type_manager

Drupal Core Field FieldTypePluginManager Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$field_type_manager = NULL

protected

The Drupal field type manager service.

$job

Drupal tripal Services TripalJob Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$job = NULL

protected

The TripalJob object.

$logger

Drupal tripal Services TripalLogger Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$logger = NULL

protected

The TripalLogger object.

$republish

boolean Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$republish = FALSE

protected

The republish flag specifies whether to publish all entities if TRUE, or just publish new entities if FALSE. Republish is needed when new fields have been added, or when the entity title format has been changed.

$schema_name

string Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$schema_name = ''

protected

The database schema to publish, e.g. 'chado'.

$storage_manager

Drupal tripal TripalStorage PluginManager TripalStorageManager Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$storage_manager = NULL

protected

The Tripal Storage service.

$token_parser

Drupal tripal Services TripalTokenParser Drupal\tripal\TripalBackendPublish\TripalBackendPublishBase::$token_parser = NULL

protected

The Tripal Token Parser service.

---

The documentation for this class was generated from the following file:

• tripal/src/TripalBackendPublish/TripalBackendPublishBase.php