Inheritance diagram for Drupal\tripal\TripalVocabTerms\TripalIdSpaceBase:
Collaboration diagram for Drupal\tripal\TripalVocabTerms\TripalIdSpaceBase:
Public Member Functions | |
| __construct (array $configuration, $plugin_id, $plugin_definition) | |
| setDefaultVocabulary ($name) | |
 Public Member Functions inherited from Drupal\tripal\TripalVocabTerms\TripalCollectionPluginBase | |
| getName () | |
| Public Member Functions inherited from Drupal\tripal\TripalVocabTerms\Interfaces\TripalIdSpaceInterface | |
| getParent ($child) | |
| getChildren ($parent=NULL) | |
| getTerm ($accession, $options=[]) | |
| getTerms ($name, $options=[]) | |
| getDefaultVocabulary () | |
| saveTerm (TripalTerm $term, array $options=[]) | |
| removeTerm ($accession) | |
| getURLPrefix () | |
| setURLPrefix ($prefix) | |
| getDescription () | |
| setDescription ($description) | |
| Public Member Functions inherited from Drupal\tripal\TripalVocabTerms\Interfaces\TripalCollectionPluginInterface | |
| createRecord () | |
| destroy () | |
| isValid () | |
| recordExists () | |
Additional Inherited Members | |
| Protected Attributes inherited from Drupal\tripal\TripalVocabTerms\TripalCollectionPluginBase | |
| $messageLogger = NULL | |
Detailed Description
Base class for tripal id space plugins.
Constructor & Destructor Documentation
◆ __construct()
| Drupal\tripal\TripalVocabTerms\TripalIdSpaceBase::__construct | ( | array | $configuration, |
| $plugin_id, | |||
| $plugin_definition | |||
| ) |
{{}}
Reimplemented from Drupal\tripal\TripalVocabTerms\TripalCollectionPluginBase.
Reimplemented in Drupal\tripal\Plugin\TripalIdSpace\TripalDefaultIdSpace.
Member Function Documentation
◆ setDefaultVocabulary()
| Drupal\tripal\TripalVocabTerms\TripalIdSpaceBase::setDefaultVocabulary | ( | $name | ) |
{Sets the default vocabulary of this id space to the given vocabulary name.Removes this id space from its previous default vocabulary if one is set and then adds this id space to its new default vocabulary if the given name is not NULL. It is still the responsibility of an implementation to actually save changes to its default vocabulary.
- Parameters
-
string name The vocabulary name.
- Returns
- bool True on success or false otherwise.
Implements Drupal\tripal\TripalVocabTerms\Interfaces\TripalIdSpaceInterface.
Reimplemented in Drupal\tripal\Plugin\TripalIdSpace\TripalDefaultIdSpace, and Drupal\tripal_chado\Plugin\TripalIdSpace\ChadoIdSpace.
The documentation for this class was generated from the following file:
- tripal/src/TripalVocabTerms/TripalIdSpaceBase.php
