Craft Themes (4.x)

NeoField extends CraftField
in package

Handles a Neo field

Tags
since
4.1.0

Table of Contents

$craft_field_class  : string
$craft_field_id  : int
$dateCreated  : DateTime
$dateUpdated  : DateTime
$display_id  : int
$hidden  : bool
$id  : int
$labelHidden  : bool
$labelVisuallyHidden  : bool
$type  : string
$uid  : string
$visuallyHidden  : bool
$_craftField  : Field
$_display  : DisplayInterface
$_displayer  : FieldDisplayerInterface
$_displayerHandle  : string
$_parent  : FieldInterface|null
$_types  : mixed
afterValidate()  : mixed
buildConfig()  : array<string|int, mixed>
Build config from a field
create()  : FieldInterface
Create a new field from config
defineRules()  : array<string|int, mixed>
delete()  : bool
Delete a field
eagerLoad()  : array<string|int, mixed>
fields()  : array<string|int, mixed>
forField()  : string
getAvailableDisplayers()  : array<string|int, FieldDisplayerInterface>
Get all the displayers that can display this field
getCanBeCached()  : bool
Can this field be cached
getChildFieldName()  : string
Get the name of a field child of this field. This would only be used for fields that have children (Neo, Matrix etc)
getChildren()  : array<string|int, mixed>
getConfig()  : array<string|int, mixed>
Get project vonfig
getCraftField()  : Field
Get the associated craft field instance
getDisplay()  : DisplayInterface|null
Display getter
getDisplayer()  : FieldDisplayerInterface
Get the displayer for this field
getDisplayerHandle()  : string
Displayer handle getter
getDisplayName()  : string
Name to display
getErrors()  : mixed
getFieldByHandle()  : FieldInterface|null
getFieldByUid()  : FieldInterface|null
getFieldsByHandles()  : array<string|int, mixed>
getFieldsByUids()  : array<string|int, mixed>
getFieldTemplates()  : array<string|int, string>
Get available field templates
getFileTemplates()  : array<string|int, string>
Get available file templates
getHandle()  : string
getLayout()  : LayoutInterface
Layout getter
getName()  : string
getOptions()  : array<string|int, mixed>
Options getter
getParent()  : FieldInterface|null
Parent getter
getRenderingValue()  : mixed
getTargetClass()  : string
The class used by displayer for their field targets Will be the field class for custom fields and the craft field class for craft fields
getType()  : string
getTypes()  : array<string|int, mixed>
getViewMode()  : ViewModeInterface
View mode getter
getVisibleFields()  : array<string|int, mixed>
handleChanged()  : bool
Handle a project config change
handleDeleted()  : mixed
Deletes a field record
hasErrors()  : bool
isVisible()  : bool
populateFromData()  : mixed
rebuild()  : mixed
Rebuild the field
render()  : Markup
Render this item.
save()  : bool
Saves a field
setDisplay()  : mixed
Display setter
setDisplayerHandle()  : mixed
Displayer handle setter
setOptions()  : mixed
Options setter
setParent()  : mixed
Parent setter
setTypes()  : mixed
shouldExistOnLayout()  : bool
Should this field exist on a layout, called during the creation of a layout to automatically create this field on that layout.
buildNeoTypes()  : array<string|int, mixed>
Build neo block types from an array of data

Properties

$craft_field_class

public string $craft_field_class

$craft_field_id

public int $craft_field_id

$labelVisuallyHidden

public bool $labelVisuallyHidden = false

$_craftField

protected Field $_craftField

$_displayerHandle

protected string $_displayerHandle

Methods

afterValidate()

public afterValidate() : mixed
Tags
inheritDoc
Return values
mixed

buildConfig()

Build config from a field

public static buildConfig(Field $craftField) : array<string|int, mixed>
Parameters
$craftField : Field
Tags
inheritDoc
Return values
array<string|int, mixed>

create()

Create a new field from config

public static create(array<string|int, mixed> $config) : FieldInterface
Parameters
$config : array<string|int, mixed>
Tags
inheritDoc
Return values
FieldInterface

defineRules()

public defineRules() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

eagerLoad()

public eagerLoad([string $prefix = '' ], int $level[, array<string|int, mixed> &$dependencies = [] ]) : array<string|int, mixed>
Parameters
$prefix : string = ''
$level : int
$dependencies : array<string|int, mixed> = []
Tags
inheritDoc
Return values
array<string|int, mixed>

fields()

public fields() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

forField()

public static forField() : string
Tags
inheritDoc
Return values
string

getCanBeCached()

Can this field be cached

public getCanBeCached() : bool
Tags
inheritDoc
Return values
bool

getChildFieldName()

Get the name of a field child of this field. This would only be used for fields that have children (Neo, Matrix etc)

public getChildFieldName(FieldInterface $field) : string
Parameters
$field : FieldInterface
Tags
inheritDoc
Return values
string

getChildren()

public getChildren() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getConfig()

Get project vonfig

public getConfig() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getCraftField()

Get the associated craft field instance

public getCraftField() : Field
Tags
inheritDoc
Return values
Field

getDisplayerHandle()

Displayer handle getter

public getDisplayerHandle() : string
Tags
inheritDoc
Return values
string

getDisplayName()

Name to display

public getDisplayName() : string
Tags
inheritDoc
Return values
string

getErrors()

public getErrors([mixed $attribute = null ]) : mixed
Parameters
$attribute : mixed = null
Tags
inheritDoc
Return values
mixed

getFieldByHandle()

public getFieldByHandle(MatrixBlock $block, string $handle) : FieldInterface|null
Parameters
$block : MatrixBlock
$handle : string
Tags
inheritDoc
Return values
FieldInterface|null

getFieldByUid()

public getFieldByUid(MatrixBlock $block, string $uid) : FieldInterface|null
Parameters
$block : MatrixBlock
$uid : string
Tags
inheritDoc
Return values
FieldInterface|null

getFieldsByHandles()

public getFieldsByHandles(MatrixBlock $block, array<string|int, mixed> $handles) : array<string|int, mixed>
Parameters
$block : MatrixBlock
$handles : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getFieldsByUids()

public getFieldsByUids(MatrixBlock $block, array<string|int, mixed> $uids) : array<string|int, mixed>
Parameters
$block : MatrixBlock
$uids : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getFieldTemplates()

Get available field templates

public getFieldTemplates() : array<string|int, string>
Tags
inheritDoc
Return values
array<string|int, string>

getHandle()

public getHandle() : string
Tags
inheritDoc
Return values
string

getName()

public getName() : string
Tags
inheritDoc
Return values
string

getOptions()

Options getter

public getOptions() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getRenderingValue()

public getRenderingValue() : mixed
Tags
inheritDoc
Return values
mixed

getTargetClass()

The class used by displayer for their field targets Will be the field class for custom fields and the craft field class for craft fields

public getTargetClass() : string
Tags
inheritDoc
Return values
string

getType()

public static getType() : string
Tags
inheritDoc
Return values
string

getTypes()

public getTypes() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getVisibleFields()

public getVisibleFields(Block $block) : array<string|int, mixed>
Parameters
$block : Block
Tags
inheritDoc
Return values
array<string|int, mixed>

handleChanged()

Handle a project config change

public static handleChanged(string $uid, array<string|int, mixed> $data) : bool
Parameters
$uid : string
$data : array<string|int, mixed>
Tags
inheritDoc
Return values
bool

handleDeleted()

Deletes a field record

public static handleDeleted(string $uid, array<string|int, mixed> $data) : mixed
Parameters
$uid : string
$data : array<string|int, mixed>
Tags
inheritDoc
Return values
mixed

hasErrors()

public hasErrors([mixed $attribute = null ]) : bool
Parameters
$attribute : mixed = null
Tags
inheritDoc
Return values
bool

isVisible()

public isVisible() : bool
Tags
inheritDoc
Return values
bool

populateFromData()

public populateFromData(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Tags
inheritDoc
Return values
mixed

rebuild()

Rebuild the field

public rebuild() : mixed
Tags
inheritDoc
Return values
mixed

render()

Render this item.

public render([mixed $value = null ]) : Markup
Parameters
$value : mixed = null
Tags
inheritDoc
Return values
Markup

setDisplayerHandle()

Displayer handle setter

public setDisplayerHandle(string $handle) : mixed
Parameters
$handle : string
Tags
inheritDoc
Return values
mixed

setOptions()

Options setter

public setOptions(mixed $options) : mixed
Parameters
$options : mixed
Tags
inheritDoc
Return values
mixed

setTypes()

public setTypes(array<string|int, mixed> $types) : mixed
Parameters
$types : array<string|int, mixed>
Tags
inheritDoc
Return values
mixed

shouldExistOnLayout()

Should this field exist on a layout, called during the creation of a layout to automatically create this field on that layout.

public static shouldExistOnLayout(LayoutInterface $layout) : bool
Parameters
$layout : LayoutInterface
Tags
inheritDoc
Return values
bool

buildNeoTypes()

Build neo block types from an array of data

protected static buildNeoTypes(array<string|int, mixed> $data, NeoField $neoField) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$neoField : NeoField
Return values
array<string|int, mixed>

Search results