ElementHelper

Type
Class
Namespace
craft\helpers
Inherits
craft\helpers\ElementHelper
Since
3.0.0

Class ElementHelper

View source

# Public Methods

Method Description
createSlug() Creates a slug based on a given string.
doesUriFormatHaveSlugTag() Returns whether a given URL format has a proper {slug} tag.
editableSiteIdsForElement() Returns the editable site IDs for a given element, taking user permissions into account.
findSource() Returns an element type's source definition based on a given source key/path and context.
isDraftOrRevision() Returns whether the given element (or its root element if a block element) is a draft or revision.
isElementEditable() Returns whether the given element is editable by the current user, taking user permissions into account.
isTempSlug() Returns whether the given slug is temporary.
rootElement() Returns the root element of a given element.
setNextPrevOnElements() Given an array of elements, will go through and set the appropriate "next" and "prev" elements on them.
setUniqueUri() Sets the URI on an element using a given URL format, tweaking its slug if necessary to ensure it's unique.
sourceElement() Returns the element, or if it’s a draft/revision, the source element.
supportedSitesForElement() Returns a list of sites that a given element supports.
tempSlug() Generates a new temporary slug.

# createSlug()

Creates a slug based on a given string.

View source

Arguments

Returns

string

# doesUriFormatHaveSlugTag()

Returns whether a given URL format has a proper {slug} tag.

View source

Arguments

Returns

boolean

# editableSiteIdsForElement()

Returns the editable site IDs for a given element, taking user permissions into account.

View source

Arguments

Returns

array

# findSource()

Returns an element type's source definition based on a given source key/path and context.

View source

Arguments

  • $elementType (string) – The element type class
  • $sourceKey (string) – The source key/path
  • $context (string, null) – The context

Returns

array, null – The source definition, or null if it cannot be found

# isDraftOrRevision()

Since
3.2.0

Returns whether the given element (or its root element if a block element) is a draft or revision.

View source

Arguments

Returns

boolean

# isElementEditable()

Returns whether the given element is editable by the current user, taking user permissions into account.

View source

Arguments

Returns

boolean

# isTempSlug()

Since
3.2.2

Returns whether the given slug is temporary.

View source

Arguments

Returns

boolean

# rootElement()

Since
3.2.0

Returns the root element of a given element.

View source

Arguments

Returns

craft\base\ElementInterface

# setNextPrevOnElements()

Given an array of elements, will go through and set the appropriate "next" and "prev" elements on them.

View source

Arguments

# setUniqueUri()

Sets the URI on an element using a given URL format, tweaking its slug if necessary to ensure it's unique.

View source

Arguments

Throws

# sourceElement()

Since
3.3.0

Returns the element, or if it’s a draft/revision, the source element.

View source

Arguments

Returns

craft\base\ElementInterface

# supportedSitesForElement()

Returns a list of sites that a given element supports.

Each site is represented as an array with 'siteId' and 'enabledByDefault' keys.

View source

Arguments

Returns

array

Throws

# tempSlug()

Since
3.2.2

Generates a new temporary slug.

View source

Returns

string