\CGBetterUploadsFieldDefinition

A class to represent a single field definition.

This is an immutable class

Summary

Methods

Properties

Constants

getExtraData()
setExtraData()
withName()

$id
$name
$type
$iorder

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: class.FieldDefinition.php
Package: CGBetterUploads
Class hierarchy: \CGBetterUploads\FieldDefinition

Properties

$id

$id : integer

An automatically assigned id for this field definition

Type

integer

$name

$name : string

The name of this property definition

Type

string

$type

$type : string

The type of the property definition.

Type

string

$iorder

$iorder : integer

The sort position of this property definition

Type

integer

Methods

getExtraData()

getExtraData(string  $key, string  $dflt = null) : mixed

Get extra data with this field definition.

Parameters

string	$key
string	$dflt	The default value to return if the data does not exist.

Returns

mixed

setExtraData()

setExtraData(string  $key, mixed  $val) : \CGBetterUploads\FieldDefinition

Associate extra data with this field definition.

Parameters

string	$key
mixed	$val	The data to associate

Returns

\CGBetterUploads\FieldDefinition

withName()

withName(string  $name) : \CGBetterUploads\FieldDefinition

Adjust the name of the field definition

Parameters

string

$name

Returns

\CGBetterUploads\FieldDefinition