class Entity implements CategoryObjectInterface, ObjectInterface, ExportableInterface (View source)

Traits

Constants

DEFAULT_ITEMS_PER_PAGE

Properties

protected $package from  PackageTrait
protected $id
protected $name
protected $handle
protected $plural_handle
protected $label_mask
protected $supports_custom_display_order
protected $description
protected $result_column_set
protected $include_in_public_list
protected $is_published
protected $include_in_rest_api
protected $entity_results_node_id
protected $use_separate_site_result_buckets

If true, this entity splits its results by multisite. If false, it is shared across all sites. Default should probably be true, but for backwards compatibility it is false.

protected $items_per_page
protected $attributes
protected $associations
protected $forms
protected $default_view_form
protected $default_edit_form
protected $entries
protected $created_date

Methods

mixed
getPackage()

No description

setPackage(mixed $package)

No description

getPackageID()

No description

getPackageHandle()

No description

__construct()

No description

mixed
getEntries()

No description

setEntries(mixed $entries)

No description

mixed
getHandle()

No description

setHandle(mixed $handle)

No description

mixed
getPluralHandle()

No description

setPluralHandle(mixed $plural_handle)

No description

mixed
supportsCustomDisplayOrder()

No description

setSupportsCustomDisplayOrder(mixed $supports_custom_display_order)

No description

bool
supportsEntrySpecificPermissions()

If an entity supports entry-specific permissions, we will check its permissions during any listing events, and use simple Pager next/back cursor pagination (unless the logged-in user is the super user).

mixed
getOwnedBy()

No description

mixed
getIncludeInPublicList()

No description

setIncludeInPublicList(mixed $include_in_public_list)

No description

bool
isPublished()

No description

void
setIsPublished(bool $is_published)

No description

string
getLabelMask()

No description

setLabelMask(string $label_mask)

No description

mixed
getDescription()

No description

setDescription(mixed $description)

No description

string
getEntityDisplayDescription(string $format = 'html')

No description

mixed
getCreatedDate()

No description

setCreatedDate(mixed $created_date)

No description

getResultColumnSet()

No description

setResultColumnSet(mixed $result_column_set)

No description

Form|null
getDefaultViewForm()

No description

setDefaultViewForm(Form|null $default_view_form)

No description

Form|null
getDefaultEditForm()

No description

setDefaultEditForm(Form|null $default_edit_form)

No description

mixed
getId()

No description

setId(mixed $id)

No description

mixed
getName()

No description

setName(mixed $name)

No description

int
getItemsPerPage()

No description

setItemsPerPage(mixed $items_per_page)

No description

string
getEntityDisplayName(string $format = 'html')

No description

ExpressKey>|ExpressKey[]
getAttributes()

No description

setAttributes($attributes)

No description

Association>|Association[]
getAssociations()

No description

setAssociations(mixed $associations)

No description

Form>|Form[]
getForms()

No description

setForms(mixed $forms)

No description

getForm($name)

No description

mixed
getEntityResultsNodeId()

No description

getEntityResultsNodeObject(Site $site = null)

No description

setEntityResultsNodeId(mixed $entity_results_node_id)

No description

getAttributeKeyCategory()

Get the attribute key category.

getAssociation($handle)

No description

mixed
setUseSeparateSiteResultBuckets(mixed $use_separate_site_result_buckets)

No description

getExporter()

No description

UrlInterface
getEntryListingUrl()

No description

__clone()

No description

bool
getIncludeInRestApi()

No description

void
setIncludeInRestApi(bool $include_in_rest_api)

No description

Details

mixed getPackage()

No description

Return Value

mixed

setPackage(mixed $package)

No description

Parameters

mixed $package

getPackageID()

No description

getPackageHandle()

No description

__construct()

No description

mixed getEntries()

No description

Return Value

mixed

setEntries(mixed $entries)

No description

Parameters

mixed $entries

mixed getHandle()

No description

Return Value

mixed

setHandle(mixed $handle)

No description

Parameters

mixed $handle

mixed getPluralHandle()

No description

Return Value

mixed

setPluralHandle(mixed $plural_handle)

No description

Parameters

mixed $plural_handle

mixed supportsCustomDisplayOrder()

No description

Return Value

mixed

setSupportsCustomDisplayOrder(mixed $supports_custom_display_order)

No description

Parameters

mixed $supports_custom_display_order

bool supportsEntrySpecificPermissions()

If an entity supports entry-specific permissions, we will check its permissions during any listing events, and use simple Pager next/back cursor pagination (unless the logged-in user is the super user).

This method determines whether this entity supports entry specific permissions. Currently, this is only true if the entity has separate site-specific buckets, but in the future we might make this an option that admins can set on the entity themselves.

Return Value

bool

mixed getOwnedBy()

No description

Return Value

mixed

mixed getIncludeInPublicList()

No description

Return Value

mixed

setIncludeInPublicList(mixed $include_in_public_list)

No description

Parameters

mixed $include_in_public_list

bool isPublished()

No description

Return Value

bool

void setIsPublished(bool $is_published)

No description

Parameters

bool $is_published

Return Value

void

string getLabelMask()

No description

Return Value

string

setLabelMask(string $label_mask)

No description

Parameters

string $label_mask

mixed getDescription()

No description

Return Value

mixed

setDescription(mixed $description)

No description

Parameters

mixed $description

string getEntityDisplayDescription(string $format = 'html')

No description

Parameters

string $format

Return Value

string

mixed getCreatedDate()

No description

Return Value

mixed

setCreatedDate(mixed $created_date)

No description

Parameters

mixed $created_date

ColumnSet getResultColumnSet()

No description

Return Value

ColumnSet

setResultColumnSet(mixed $result_column_set)

No description

Parameters

mixed $result_column_set

Form|null getDefaultViewForm()

No description

Return Value

Form|null

setDefaultViewForm(Form|null $default_view_form)

No description

Parameters

Form|null $default_view_form

Form|null getDefaultEditForm()

No description

Return Value

Form|null

setDefaultEditForm(Form|null $default_edit_form)

No description

Parameters

Form|null $default_edit_form

mixed getId()

No description

Return Value

mixed

setId(mixed $id)

No description

Parameters

mixed $id

mixed getName()

No description

Return Value

mixed

setName(mixed $name)

No description

Parameters

mixed $name

int getItemsPerPage()

No description

Return Value

int

setItemsPerPage(mixed $items_per_page)

No description

Parameters

mixed $items_per_page

string getEntityDisplayName(string $format = 'html')

No description

Parameters

string $format

Return Value

string

ExpressKey>|ExpressKey[] getAttributes()

No description

Return Value

ExpressKey>|ExpressKey[]

setAttributes($attributes)

No description

Parameters

$attributes

Association>|Association[] getAssociations()

No description

Return Value

Association>|Association[]

setAssociations(mixed $associations)

No description

Parameters

mixed $associations

Form>|Form[] getForms()

No description

Return Value

Form>|Form[]

setForms(mixed $forms)

No description

Parameters

mixed $forms

getForm($name)

No description

Parameters

$name

mixed getEntityResultsNodeId()

No description

Return Value

mixed

getEntityResultsNodeObject(Site $site = null)

No description

Parameters

Site $site

setEntityResultsNodeId(mixed $entity_results_node_id)

No description

Parameters

mixed $entity_results_node_id

CategoryInterface getAttributeKeyCategory()

Get the attribute key category.

Return Value

CategoryInterface

getPermissionObjectIdentifier()

No description

getPermissionResponseClassName()

No description

getAssociation($handle)

No description

Parameters

$handle

mixed usesSeparateSiteResultsBuckets()

No description

Return Value

mixed

setUseSeparateSiteResultBuckets(mixed $use_separate_site_result_buckets)

No description

Parameters

mixed $use_separate_site_result_buckets

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

ItemInterface getExporter()

No description

Return Value

ItemInterface

ControllerInterface getController()

No description

Return Value

ControllerInterface

UrlInterface getEntryListingUrl()

No description

Return Value

UrlInterface

__clone()

No description

bool getIncludeInRestApi()

No description

Return Value

bool

void setIncludeInRestApi(bool $include_in_rest_api)

No description

Parameters

bool $include_in_rest_api

Return Value

void