Tripal
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Drupal\tripal\TripalStorage\StoragePropertyBase Class Reference
Inheritance diagram for Drupal\tripal\TripalStorage\StoragePropertyBase:
Inheritance graph
[legend]

Public Member Functions

 __construct ($entityType, $fieldType, $key, $term_id, $idspace_plugin_id='')
 
 getEntityType ()
 
 getFieldType ()
 
 getKey ()
 
 getTermIdSpace ()
 
 getTermAccession ()
 
 getTerm ()
 

Protected Attributes

 $idSpaceService
 

Detailed Description

Base class for a Tripal storage property type or value.

Constructor & Destructor Documentation

◆ __construct()

Drupal\tripal\TripalStorage\StoragePropertyBase::__construct (   $entityType,
  $fieldType,
  $key,
  $term_id,
  $idspace_plugin_id = '' 
)

Constructs a new Tripal storage property base object.

Parameters
string$entityTypeThe entity type associated with this storage property base object.
string$fieldTypeThe field type associated with this storage property base object.
string$keyThe key associated with this storage property base object.
string$term_idThe controlled vocabulary term asssociated with this property. It must be in the form of "IdSpace:Accession" (e.g. "rdfs:label" or "OBI:0100026")
string$idspace_plugin_idThe 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.

Reimplemented in Drupal\tripal_chado\TripalStorage\ChadoBoolStoragePropertyType, Drupal\tripal_chado\TripalStorage\ChadoDateTimeStoragePropertyType, Drupal\tripal_chado\TripalStorage\ChadoIntStoragePropertyType, Drupal\tripal_chado\TripalStorage\ChadoRealStoragePropertyType, and Drupal\tripal_chado\TripalStorage\ChadoTextStoragePropertyType.

Member Function Documentation

◆ getEntityType()

Drupal\tripal\TripalStorage\StoragePropertyBase::getEntityType ( )

Returns the entity type associated with this storage property object.

Returns
string The entity type.

◆ getFieldType()

Drupal\tripal\TripalStorage\StoragePropertyBase::getFieldType ( )

Returns the field type associated with this storage property object.

Returns
string The field type.

◆ getKey()

Drupal\tripal\TripalStorage\StoragePropertyBase::getKey ( )

Returns the key associated with this storage property object.

Returns
string The key.

◆ getTerm()

Drupal\tripal\TripalStorage\StoragePropertyBase::getTerm ( )

Gets the CV Term Object associated with this storage property.

Returns
\Drupal\tripal\TripalVocabTerms\TripalTerm The Tripal Controlled Vocabulary Term Object.

◆ getTermAccession()

Drupal\tripal\TripalStorage\StoragePropertyBase::getTermAccession ( )

Returns the accession of the term for this storage property.

Returns
string The key.

◆ getTermIdSpace()

Drupal\tripal\TripalStorage\StoragePropertyBase::getTermIdSpace ( )

Returns the name of the ID space of the term for this storage property.

Returns
string The key.

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