Tripal
Public Member Functions | List of all members
Drupal\tripal\TripalVocabTerms\TripalVocabularyBase Class Reference
Inheritance diagram for Drupal\tripal\TripalVocabTerms\TripalVocabularyBase:
Inheritance graph
[legend]
Collaboration diagram for Drupal\tripal\TripalVocabTerms\TripalVocabularyBase:
Collaboration graph
[legend]

Public Member Functions

 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 getTerms ($name, $exact=True)
 
- Public Member Functions inherited from Drupal\tripal\TripalVocabTerms\TripalCollectionPluginBase
 getName ()
 
- Public Member Functions inherited from Drupal\tripal\TripalVocabTerms\Interfaces\TripalVocabularyInterface
 getIdSpaceNames ()
 
 addIdSpace ($idSpace)
 
 removeIdSpace ($idspace)
 
 getURL ()
 
 setURL ($url)
 
 getNameSpace ()
 
 setLabel ($label)
 
 getLabel ()
 
- 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 vocabulary plugins.

Constructor & Destructor Documentation

◆ __construct()

Drupal\tripal\TripalVocabTerms\TripalVocabularyBase::__construct ( array  $configuration,
  $plugin_id,
  $plugin_definition 
)

Member Function Documentation

◆ getTerms()

Drupal\tripal\TripalVocabTerms\TripalVocabularyBase::getTerms (   $name,
  $exact = True 
)

{Returns the terms in this vocabulary whose names match the given name. Matches can only be exact or a substring depending on the given flag. The default is to only return exact matches.

Parameters
string$nameThe name.
bool$exactTrue to only include exact matches else include all substring matches.
Returns
array Array of matching Drupal\tripal\TripalVocabTerms\TripalTerm instances.
}

Implements Drupal\tripal\TripalVocabTerms\Interfaces\TripalVocabularyInterface.

Reimplemented in Drupal\tripal_chado\Plugin\TripalVocabulary\ChadoVocabulary, and Drupal\tripal\Plugin\TripalVocabulary\TripalDefaultVocabulary.


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