Tripal
Public Member Functions | List of all members
Drupal\tripal\Entity\TripalEntityInterface Interface Reference
Inheritance diagram for Drupal\tripal\Entity\TripalEntityInterface:
Inheritance graph
[legend]
Collaboration diagram for Drupal\tripal\Entity\TripalEntityInterface:
Collaboration graph
[legend]

Public Member Functions

 getType ()
 
 getCreatedTime ()
 
 setCreatedTime ($timestamp)
 
 isPublished ()
 
 setPublished ($published)
 

Detailed Description

Provides an interface for defining Tripal Content entities.

Member Function Documentation

◆ getCreatedTime()

Drupal\tripal\Entity\TripalEntityInterface::getCreatedTime ( )

Gets the Tripal Content creation timestamp.

Returns
int Creation timestamp of the Tripal Content.

Implemented in Drupal\tripal\Entity\TripalEntity.

◆ getType()

Drupal\tripal\Entity\TripalEntityInterface::getType ( )

Gets the Tripal Content type.

Returns
string The Tripal Content type.

Implemented in Drupal\tripal\Entity\TripalEntity.

◆ isPublished()

Drupal\tripal\Entity\TripalEntityInterface::isPublished ( )

Returns the Tripal Content published status indicator.

Unpublished Tripal Content are only visible to restricted users.

Returns
bool TRUE if the Tripal Content is published.

Implemented in Drupal\tripal\Entity\TripalEntity.

◆ setCreatedTime()

Drupal\tripal\Entity\TripalEntityInterface::setCreatedTime (   $timestamp)

Sets the Tripal Content creation timestamp.

Parameters
int$timestampThe Tripal Content creation timestamp.
Returns
\Drupal\tripal\Entity\TripalEntityInterface The called Tripal Content entity.

Implemented in Drupal\tripal\Entity\TripalEntity.

◆ setPublished()

Drupal\tripal\Entity\TripalEntityInterface::setPublished (   $published)

Sets the published status of a Tripal Content.

Parameters
bool$publishedTRUE to set this Tripal Content to published, FALSE to set it to unpublished.
Returns
\Drupal\tripal\Entity\TripalEntityInterface The called Tripal Content entity.

Implemented in Drupal\tripal\Entity\TripalEntity.


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