Public Member Functions | |
| createRecord () | |
| destroy () | |
| isValid () | |
| recordExists () | |
Detailed Description
Defines an interface for tripal collection plugins.
Member Function Documentation
◆ createRecord()
| Drupal\tripal\TripalVocabTerms\Interfaces\TripalCollectionPluginInterface::createRecord | ( | ) |
Creates the records needed for this collection.
This must only be called once on this new collection instance that has just been created by its collection plugin manager.
Implemented in Drupal\tripal_chado\Plugin\TripalVocabulary\ChadoVocabulary, Drupal\tripal_chado\Plugin\TripalIdSpace\ChadoIdSpace, Drupal\tripal\Plugin\TripalVocabulary\TripalDefaultVocabulary, and Drupal\tripal\Plugin\TripalIdSpace\TripalDefaultIdSpace.
◆ destroy()
| Drupal\tripal\TripalVocabTerms\Interfaces\TripalCollectionPluginInterface::destroy | ( | ) |
Destroys this collection.
This must only be called once when on this existing collection that is being removed from its collection plugin manager.
Implemented in Drupal\tripal_chado\Plugin\TripalVocabulary\ChadoVocabulary, Drupal\tripal_chado\Plugin\TripalIdSpace\ChadoIdSpace, Drupal\tripal\Plugin\TripalVocabulary\TripalDefaultVocabulary, and Drupal\tripal\Plugin\TripalIdSpace\TripalDefaultIdSpace.
◆ isValid()
| Drupal\tripal\TripalVocabTerms\Interfaces\TripalCollectionPluginInterface::isValid | ( | ) |
Tests if this collection is valid or not.
- Returns
- bool True if this collection is valid or false otherwise.
Implemented in Drupal\tripal_chado\Plugin\TripalVocabulary\ChadoVocabulary, Drupal\tripal_chado\Plugin\TripalIdSpace\ChadoIdSpace, Drupal\tripal\Plugin\TripalVocabulary\TripalDefaultVocabulary, and Drupal\tripal\Plugin\TripalIdSpace\TripalDefaultIdSpace.
◆ recordExists()
| Drupal\tripal\TripalVocabTerms\Interfaces\TripalCollectionPluginInterface::recordExists | ( | ) |
Indicates if the underlying data store has a record for this collection.
This function will be called by the collection plugin manager to ensure that the record for this collection exists and if not allow it to create it by calling the create() method or prevent addition of duplicate entries.
- Returns
- bool True if a record exists in the data store, False if not.
Implemented in Drupal\tripal_chado\Plugin\TripalVocabulary\ChadoVocabulary, Drupal\tripal_chado\Plugin\TripalIdSpace\ChadoIdSpace, Drupal\tripal\Plugin\TripalVocabulary\TripalDefaultVocabulary, and Drupal\tripal\Plugin\TripalIdSpace\TripalDefaultIdSpace.
The documentation for this interface was generated from the following file:
- tripal/src/TripalVocabTerms/Interfaces/TripalCollectionPluginInterface.php
