Inheritance diagram for Drupal\tripal\TripalStorage\StoragePropertyTypeBase:

[legend]

Collaboration diagram for Drupal\tripal\TripalStorage\StoragePropertyTypeBase:

Public Member Functions
	__construct ($entityType, $fieldType, $key, $term_id, $id, $storage_settings=[], $idspace_plugin_id='')

	getId ()

	setCardinality (int $cardinality)

	getCardinality ()

	setSearchability ($searchability)

	getSearchability ()

	setOperations ($operations)

	getOperations ()

	setSortable ($sortable)

	getSortable ()

	setReadOnly ($readOnly)

	getReadOnly ()

	setRequired ($required)

	getRequired ()

	setCacheStatus (bool $status)

	getCacheStatus ()

	getStorageSettings ()

	setStorageSettings ($storage_settings)

Public Member Functions inherited from Drupal\tripal\TripalStorage\StoragePropertyBase
	__construct ($entityType, $fieldType, $key, $term_id, $idspace_plugin_id='')

	getEntityType ()

	getFieldType ()

	getKey ()

	getTermIdSpace ()

	getTermAccession ()

	getTerm ()

Public Attributes
bool	$cache_status

Additional Inherited Members
Protected Attributes inherited from Drupal\tripal\TripalStorage\StoragePropertyBase
	$idSpaceService

Detailed Description

Base class for a Tripal storage property type.

Constructor & Destructor Documentation

◆ __construct()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::__construct	(	$entityType,
		$fieldType,
		$key,
		$term_id,
		$id,
		$storage_settings = `[]`,
		$idspace_plugin_id = `''`
	)

Constructs a new tripal storage property type base.

Parameters

string	$entityType	The entity type associated with this storage property type base.
string	$fieldType	The field type associated with this storage property type base.
string	$key	The key associated with this storage property type base.
string	$term_id	The controlled vocabulary term asssociated with this property. It must be in the form of "IdSpace:Accession" (e.g. "rdfs:label" or "OBI:0100026")
string	$id	The id of this storage property type base.
array	$storage_settings	An array of settings required for this property by the storage backend.
string	$idspace_plugin_id	The plugin_id associated with the term. This is optional but if provided allows a missing ID Space to be looked up in the backend storage.

Member Function Documentation

◆ getCacheStatus()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getCacheStatus ( )

Whether or not this property should be cached in the Drupal tables or not.

Returns: bool TRUE if it should be saved in Drupal and false if not.

◆ getCardinality()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getCardinality ( )

Gets the cardinality.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Returns: bool The cardinality.

◆ getId()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getId ( )

Returns the id of this storage property type base.

Returns: string The id.

◆ getOperations()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getOperations ( )

Gets the supported operations.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Returns: bool The operations.

◆ getReadOnly()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getReadOnly ( )

Gets the read only property.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Returns: bool The read only property.

◆ getRequired()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getRequired ( )

Gets the required property.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Returns: bool The required property.

◆ getSearchability()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getSearchability ( )

Gets the searchability.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Returns: bool The searchability.

◆ getSortable()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getSortable ( )

Gets the sortable property.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Returns: bool The sortable property.

◆ getStorageSettings()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::getStorageSettings ( )

Gets the storage settings for this property type.

Returns: array An associative array of the storage settings for this property type.

◆ setCacheStatus()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::setCacheStatus ( bool $status )

Sets whether this property should be cached in the drupal tables or not.

Parameters

bool $status TRUE if it should be saved in Drupal and false if not.

◆ setCardinality()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::setCardinality ( int $cardinality )

Sets the cardinality.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Parameters

int $cardinality The cardinality. A value of 0 indicates unlimited values.

◆ setOperations()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::setOperations ( $operations )

Sets the supported operations.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Valid operations are (eq,ne,contains,starts).

Parameters

bool $operations The operations.

◆ setReadOnly()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::setReadOnly ( $readOnly )

Sets the read only property.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Parameters

bool $readOnly The read only property.

◆ setRequired()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::setRequired ( $required )

Sets the required property.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Parameters

bool $required The required property.

◆ setSearchability()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::setSearchability ( $searchability )

Sets the searchability.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Parameters

bool $searchability The searchability.

◆ setSortable()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::setSortable ( $sortable )

Sets the sortable property.

NOTE: Currently this is not being used but was part of the original design. We are leaving this here for now + intend to go back and discuss with Josh.

Parameters

bool $sortable The sortable property.

◆ setStorageSettings()

Drupal\tripal\TripalStorage\StoragePropertyTypeBase::setStorageSettings ( $storage_settings )

Gets the storage settings for this property type.

Parameters

array $storage_settings An associative array of the storage settings for this property type.

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

tripal/src/TripalStorage/StoragePropertyTypeBase.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCacheStatus()

◆ getCardinality()

◆ getId()

◆ getOperations()

◆ getReadOnly()

◆ getRequired()

◆ getSearchability()

◆ getSortable()

◆ getStorageSettings()

◆ setCacheStatus()

◆ setCardinality()

◆ setOperations()

◆ setReadOnly()

◆ setRequired()

◆ setSearchability()

◆ setSortable()

◆ setStorageSettings()