Entity
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
No description
No description
No description
No description
No description
No description
No description
No description
No description
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).
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Get the attribute key category.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Details
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).
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.
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
ColumnSet
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
CategoryInterface
getAttributeKeyCategory()
Get the attribute key category.
getPermissionObjectIdentifier()
No description
getPermissionResponseClassName()
No description
getAssociation($handle)
No description
mixed
usesSeparateSiteResultsBuckets()
No description
setUseSeparateSiteResultBuckets(mixed $use_separate_site_result_buckets)
No description
getPermissionAssignmentClassName()
No description
getPermissionObjectKeyCategoryHandle()
No description
ItemInterface
getExporter()
No description
ControllerInterface
getController()
No description
UrlInterface
getEntryListingUrl()
No description
__clone()
No description
bool
getIncludeInRestApi()
No description
void
setIncludeInRestApi(bool $include_in_rest_api)
No description