class FluentBadgeExtension extends Extension (View source)

Properties

protected object $owner

The object this extension is applied to.

from  Extension

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
object
getOwner()

Returns the owner of this extension.

public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

public
updateBadge(DBField|null $badgeField)

Push a badge to indicate the language that owns the current item

public
updateBreadcrumbs(ArrayList $breadcrumbs)

No description

protected
DBField|null
addFluentBadge(DBField|null $badgeField, DataObject $record)

Add the Fluent state badge before any existing badges and return the result

public
getBadge(DataObject $record)

Given a record with Fluent enabled, return a badge that represents the state of it in the current locale

Details

__construct()

No description

static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

object getOwner()

Returns the owner of this extension.

Return Value

object

static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

updateBadge(DBField|null $badgeField)

Push a badge to indicate the language that owns the current item

Parameters

DBField|null $badgeField

updateBreadcrumbs(ArrayList $breadcrumbs)

No description

Parameters

ArrayList $breadcrumbs

protected DBField|null addFluentBadge(DBField|null $badgeField, DataObject $record)

Add the Fluent state badge before any existing badges and return the result

Parameters

DBField|null $badgeField
DataObject $record

Return Value

DBField|null

DBField getBadge(DataObject $record)

Given a record with Fluent enabled, return a badge that represents the state of it in the current locale

Parameters

DataObject $record

Return Value

DBField