Craft Activity (2.x)

Transforms extends DefaultHandler
in package

Tags
since
2.2.0

Table of Contents

EVENT_REGISTER_TARGETS  = 'register-targets'
$data  : mixed
$fancyValue  : mixed
$value  : mixed
getDbValue()  : array<string|int, mixed>
Get the value to be stored in database.
getDirty()  : array<string|int, mixed>
Get dirty values compared to another field handler
getTargets()  : array<string|int, mixed>
Get the targets this field handler applies to, can be modified through an event
getTemplate()  : string|null
Get the template used to render this field description
hasFancyValue()  : bool
init()  : void
isDirty()  : bool
Is the value dirty compared to another field handler
_getTargets()  : array<string|int, mixed>
Get the targets this field handler applies to
getTransformName()  : string
Get a transform name by uid

Constants

EVENT_REGISTER_TARGETS

public mixed EVENT_REGISTER_TARGETS = 'register-targets'

Properties

Methods

getDbValue()

Get the value to be stored in database.

public getDbValue(string $valueKey) : array<string|int, mixed>

$valueKey is either 'f' for a from value, or 't' for a to value If this handler has a fancy value, the db value will also contain 'ff' or 'tf'

Parameters
$valueKey : string
Return values
array<string|int, mixed>

getDirty()

Get dirty values compared to another field handler

public getDirty(FieldHandler $handler) : array<string|int, mixed>
Parameters
$handler : FieldHandler
Return values
array<string|int, mixed>

getTargets()

Get the targets this field handler applies to, can be modified through an event

public static getTargets() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTemplate()

Get the template used to render this field description

public static getTemplate() : string|null
Return values
string|null

hasFancyValue()

public hasFancyValue() : bool
Tags
inheritDoc
Return values
bool

init()

public init() : void
Tags
inheritDoc
Return values
void

_getTargets()

Get the targets this field handler applies to

protected static _getTargets() : array<string|int, mixed>
Tags
since
2.2.0
Return values
array<string|int, mixed>

getTransformName()

Get a transform name by uid

protected getTransformName(string $uid) : string
Parameters
$uid : string
Return values
string

Search results