Drupal\tripal\Entity\TripalEntityTypeInterface Interface Reference

Inheritance diagram for Drupal\tripal\Entity\TripalEntityTypeInterface:

Collaboration diagram for Drupal\tripal\Entity\TripalEntityTypeInterface:

Public Member Functions
	getLabel ()
	setLabel ($label)
	getTermIdSpace ()
	setTermIdSpace ($termIdSpace)
	getTermAccession ()
	setTermAccession ($termAccession)
	getTerm ()
	getHelpText ()
	setHelpText ($help_text)
	getCategory ()
	setCategory ($category)
	getTitleFormat ()
	setTitleFormat ($title_format)
	getURLFormat ()
	setURLFormat ($url_format)
	hideEmptyFields ()
	showEmptyFields ()
	getEmptyFieldDisplay ()
	enableAJAXLoading ()
	disableAJAXLoading ()
	getAJAXLoadingStatus ()

Detailed Description

Provides an interface for defining Tripal Content type entities.

Member Function Documentation

disableAJAXLoading()

Drupal\tripal\Entity\TripalEntityTypeInterface::disableAJAXLoading

(

)

Configures the entity such that fields will be loaded on page load.

Implemented in Drupal\tripal\Entity\TripalEntityType.

enableAJAXLoading()

Drupal\tripal\Entity\TripalEntityTypeInterface::enableAJAXLoading

(

)

Configures the entity such that fields will be loaded via AJAX after page load.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getAJAXLoadingStatus()

Drupal\tripal\Entity\TripalEntityTypeInterface::getAJAXLoadingStatus

(

)

Retrieves the indicator for whether to load fields using AJAX or not.

Returns

true if AJAX should be used to load fields and false otherwise.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getCategory()

Drupal\tripal\Entity\TripalEntityTypeInterface::getCategory

(

)

Gets the category for this Tripal Entity Type.

Returns

string Category for the Tripal Entity Type.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getEmptyFieldDisplay()

Drupal\tripal\Entity\TripalEntityTypeInterface::getEmptyFieldDisplay

(

)

Retrieves the indicator for whether to hide empty fields or not.

Returns

true if empty fields should be hidden and false otherwise.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getHelpText()

Drupal\tripal\Entity\TripalEntityTypeInterface::getHelpText

(

)

Gets help text for admin for this Tripal Entity Type.

Returns

string Help text for the Tripal Entity Type.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getLabel()

Drupal\tripal\Entity\TripalEntityTypeInterface::getLabel

(

)

Gets the Tripal Entity Type label (e.g. gene).

Returns

string Label of the Tripal Entity Type.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getTerm()

Drupal\tripal\Entity\TripalEntityTypeInterface::getTerm

(

)

Gets the Tripal Entity Type CV Term Object based off its CV Term ID Space and Accession.

Returns

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

Implemented in Drupal\tripal\Entity\TripalEntityType.

getTermAccession()

Drupal\tripal\Entity\TripalEntityTypeInterface::getTermAccession

(

)

Gets the Tripal Entity Type CV Term Accession.

Returns

string The Tripal Controlled Vocabulary Term Accession.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getTermIdSpace()

Drupal\tripal\Entity\TripalEntityTypeInterface::getTermIdSpace

(

)

Gets the Tripal Entity Type CV Term ID Space.

Returns

string The Tripal Controlled Vocabulary Term ID Space.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getTitleFormat()

Drupal\tripal\Entity\TripalEntityTypeInterface::getTitleFormat

(

)

Gets the title format for this Tripal Entity Type.

Returns

string Title format for the Tripal Entity Type.

Implemented in Drupal\tripal\Entity\TripalEntityType.

getURLFormat()

Drupal\tripal\Entity\TripalEntityTypeInterface::getURLFormat

(

)

Gets the URL format for this Tripal Entity Type.

Returns

string URL format for the Tripal Entity Type.

Implemented in Drupal\tripal\Entity\TripalEntityType.

hideEmptyFields()

Drupal\tripal\Entity\TripalEntityTypeInterface::hideEmptyFields

(

)

Configures the entity such that empty fields will be hidden.

Implemented in Drupal\tripal\Entity\TripalEntityType.

setCategory()

Drupal\tripal\Entity\TripalEntityTypeInterface::setCategory

(

$category

)

Sets the Tripal Entity Type category.

Parameters

string

$category

The Tripal Entity Type category.

Returns

\Drupal\tripal\Entity\TripalEntityTypeInterface The called Tripal Entity Type entity.

Implemented in Drupal\tripal\Entity\TripalEntityType.

setHelpText()

Drupal\tripal\Entity\TripalEntityTypeInterface::setHelpText

(

$help_text

)

Sets the Tripal Entity Type help text.

Parameters

string

$help_text

The Tripal Entity Type help text.

Returns

\Drupal\tripal\Entity\TripalEntityTypeInterface The called Tripal Entity Type entity.

Implemented in Drupal\tripal\Entity\TripalEntityType.

setLabel()

Drupal\tripal\Entity\TripalEntityTypeInterface::setLabel

(

$label

)

Sets the Tripal Entity Type label (e.g. gene).

Parameters

string

$label

The Tripal Entity Type label.

Returns

\Drupal\tripal\Entity\TripalEntityTypeInterface The called Tripal Entity Type entity.

Implemented in Drupal\tripal\Entity\TripalEntityType.

setTermAccession()

Drupal\tripal\Entity\TripalEntityTypeInterface::setTermAccession

(

$termAccession

)

Sets the Tripal Entity Type CV Term Accession.

Parameters

string

$termIdSpace

The new Tripal Controlled Vocabulary Term Accession

Returns

\Drupal\tripal\Entity\TripalEntityTypeInterface The called Tripal Entity Type entity.

Implemented in Drupal\tripal\Entity\TripalEntityType.

setTermIdSpace()

Drupal\tripal\Entity\TripalEntityTypeInterface::setTermIdSpace

(

$termIdSpace

)

Sets the Tripal Entity Type CV Term ID Space.

Parameters

string

$termIdSpace

The new Tripal Controlled Vocabulary Term ID Space

Returns

\Drupal\tripal\Entity\TripalEntityTypeInterface The called Tripal Entity Type entity.

Implemented in Drupal\tripal\Entity\TripalEntityType.

setTitleFormat()

Drupal\tripal\Entity\TripalEntityTypeInterface::setTitleFormat

(

$title_format

)

Sets the Tripal Entity Type title format.

Parameters

string

$title_format

The Tripal Entity Type title format.

Returns

\Drupal\tripal\Entity\TripalEntityTypeInterface The called Tripal Entity Type entity.

Implemented in Drupal\tripal\Entity\TripalEntityType.

setURLFormat()

Drupal\tripal\Entity\TripalEntityTypeInterface::setURLFormat

(

$url_format

)

Sets the Tripal Entity Type URL format.

Parameters

string

$url_format

The Tripal Entity Type URL format.

Returns

\Drupal\tripal\Entity\TripalEntityTypeInterface The called Tripal Entity Type entity.

Implemented in Drupal\tripal\Entity\TripalEntityType.

showEmptyFields()

Drupal\tripal\Entity\TripalEntityTypeInterface::showEmptyFields

(

)

Configures the entity such that empty fields will be shown.

Implemented in Drupal\tripal\Entity\TripalEntityType.

---

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

• tripal/src/Entity/TripalEntityTypeInterface.php