Drupal\tripal\TripalPubLibrary\TripalPubLibraryBase Class Reference

Inheritance diagram for Drupal\tripal\TripalPubLibrary\TripalPubLibraryBase:

Collaboration diagram for Drupal\tripal\TripalPubLibrary\TripalPubLibraryBase:

Public Member Functions
	__construct (array $configuration, $plugin_id, $plugin_definition, Connection $public, \Drupal\tripal\Services\TripalLogger $logger, \Drupal\tripal\Services\TripalCitationManager $citation_manager, TripalFileRetriever $fileretriever)
Public Member Functions inherited from Drupal\tripal\TripalPubLibrary\Interfaces\TripalPubLibraryInterface
	form (array $form, \Drupal\Core\Form\FormStateInterface &$form_state)
	formSubmit (array $form, \Drupal\Core\Form\FormStateInterface &$form_state)
	formValidate (array $form, \Drupal\Core\Form\FormStateInterface &$form_state)
	run (array $query)
	retrieve (array $query, int $limit=10, int $page=0)
	parse_xml (string $raw)

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

Protected Member Functions
	xmlIsValid (string $xml)

Protected Attributes
	$public
	$logger
	$fileretriever = NULL
	$citation_manager = NULL
	$plugin_id
	$plugin_definition

Detailed Description

Defines the base class for the tripal pub parser plugins.

Constructor & Destructor Documentation

__construct()

Drupal\tripal\TripalPubLibrary\TripalPubLibraryBase::__construct	(	array	$configuration,
			$plugin_id,
			$plugin_definition,
		Connection	$public,
		\Drupal\tripal\Services\TripalLogger	$logger,
		\Drupal\tripal\Services\TripalCitationManager	$citation_manager,
		TripalFileRetriever	$fileretriever
	)

{}

Member Function Documentation

create()

static Drupal\tripal\TripalPubLibrary\TripalPubLibraryBase::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

xmlIsValid()

Drupal\tripal\TripalPubLibrary\TripalPubLibraryBase::xmlIsValid ( string  $xml )

protected

Validates whether XML is valid or not.

Parameters

string

$xml

The XML to be checked.

Returns

bool Return TRUE if valid, FALSE if not valid.

See also

Drupal\tripal\TripalImporter\TripalImporterBase::xmlIsValid().

Member Data Documentation

$citation_manager

Drupal tripal Services TripalCitationManager Drupal\tripal\TripalPubLibrary\TripalPubLibraryBase::$citation_manager = NULL

protected

The Tripal Citation generation service.

$public

Drupal\tripal\TripalPubLibrary\TripalPubLibraryBase::$public

protected

The public database connection

---

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

• tripal/src/TripalPubLibrary/TripalPubLibraryBase.php