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

Public Member Functions

 __construct ($entityType, $fieldType, $key, $term_id, $entityId, $value=NULL)
 
 getEntityId ()
 
 getValue ()
 
 setValue ($value)
 
 getDefaultValue ()
 
 setDefaultValue ($default_value)
 
- Public Member Functions inherited from Drupal\tripal\TripalStorage\StoragePropertyBase
 __construct ($entityType, $fieldType, $key, $term_id, $idspace_plugin_id='')
 
 getEntityType ()
 
 getFieldType ()
 
 getKey ()
 
 getTermIdSpace ()
 
 getTermAccession ()
 
 getTerm ()
 

Additional Inherited Members

- Protected Attributes inherited from Drupal\tripal\TripalStorage\StoragePropertyBase
 $idSpaceService
 

Detailed Description

Defines the Tripal storage property value.

Constructor & Destructor Documentation

◆ __construct()

Drupal\tripal\TripalStorage\StoragePropertyValue::__construct (   $entityType,
  $fieldType,
  $key,
  $term_id,
  $entityId,
  $value = NULL 
)

Constructs a new tripal storage property value.

Parameters
string$entityTypeThe entity type associated with this storage property value.
string$fieldTypeThe field type associated with this storage property value.
string$keyThe key associated with this storage property value.
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$entityIdThe entity id associated with this storage property value.
?$value An optional initial value for this storage property value.

Member Function Documentation

◆ getDefaultValue()

Drupal\tripal\TripalStorage\StoragePropertyValue::getDefaultValue ( )

Returns the default value of this storage property value.

Returns
mixed The default value.

◆ getEntityId()

Drupal\tripal\TripalStorage\StoragePropertyValue::getEntityId ( )

Returns the entity id associated with this storage property value.

Returns
string The entity id.

◆ getValue()

Drupal\tripal\TripalStorage\StoragePropertyValue::getValue ( )

Returns the value of this storage property value.

Returns
mixed The value.

◆ setDefaultValue()

Drupal\tripal\TripalStorage\StoragePropertyValue::setDefaultValue (   $default_value)

Sets the default value of this storage property value to the given value.

Parameters
mixed$default_valueThe value to use as the default value.

◆ setValue()

Drupal\tripal\TripalStorage\StoragePropertyValue::setValue (   $value)

Sets the value of this storage property value to the given value.

Parameters
mixed$valueThe value.

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