Galette\Entity\DynamicFieldsHandle Class Reference

Public Member Functions
	__construct (Db $zdb, Login $login, object $instance=null)
	load (object $object)
	getErrors ()
	getFields ()
	getSearchFields ()
	getValues (int $field)
	setValue (?int $item, int $field, int $index, string|int $value)
	unsetValue (int $field, int $index)
	storeValues (int $item_id=null, bool $transaction=false)
	hasChanged ()
	removeValues (int $item_id=null, bool $transaction=false)

Public Attributes
const	TABLE = 'dynamic_fields'

Protected Member Functions
	getCurrentFields ()

Detailed Description

Dynamic fields handle, aggregating field descriptors and values

Author

Johan Cwiklinski johan.nosp@m.@x-t.nosp@m.nd.be

Constructor & Destructor Documentation

__construct()

Galette\Entity\DynamicFieldsHandle::__construct	(	Db	$zdb,
		Login	$login,
		object	$instance = null
	)

Default constructor

Parameters

Db	$zdb	Database instance
Login	$login	Login instance
	?object	$instance Object instance

Member Function Documentation

getCurrentFields()

Galette\Entity\DynamicFieldsHandle::getCurrentFields ( )

protected

Get current fields resultset

Returns

ResultSet

only load values for accessible fields

getErrors()

Galette\Entity\DynamicFieldsHandle::getErrors

(

)

Get errors

Returns

array<string>

getFields()

Galette\Entity\DynamicFieldsHandle::getFields

(

)

Get fields

Returns

array<int, DynamicField>

getSearchFields()

Galette\Entity\DynamicFieldsHandle::getSearchFields

(

)

Get fields for search pages

Returns

array<int, DynamicField>

getValues()

Galette\Entity\DynamicFieldsHandle::getValues

(

int

$field

)

Get values

Parameters

integer

$field

Field ID

Returns

array<int, array<string, mixed>>

hasChanged()

Galette\Entity\DynamicFieldsHandle::hasChanged

(

)

Is there any change in dynamic fields?

Returns

boolean

load()

Galette\Entity\DynamicFieldsHandle::load

(

object

$object

)

Load dynamic fields values for specified object

Parameters

object

$object

Object instance

Returns

bool

removeValues()

Galette\Entity\DynamicFieldsHandle::removeValues	(	int	$item_id = null,
		bool	$transaction = false
	)

Remove values

Parameters

	?integer	$item_id Current item id to use (will be used if current item_id is 0)
boolean	$transaction	True if a transaction already exists

Returns

boolean

setValue()

Galette\Entity\DynamicFieldsHandle::setValue	(	?int	$item,
		int	$field,
		int	$index,
		string|int	$value
	)

Set field value

Parameters

	?integer	$item Item ID
integer	$field	Field ID
integer	$index	Value index
string | int	$value	Value

Returns

void

storeValues()

Galette\Entity\DynamicFieldsHandle::storeValues	(	int	$item_id = null,
		bool	$transaction = false
	)

Store values

Parameters

	?integer	$item_id Current item id to use (will be used if current item_id is 0)
boolean	$transaction	True if a transaction already exists

Returns

boolean

unsetValue()

Galette\Entity\DynamicFieldsHandle::unsetValue	(	int	$field,
		int	$index
	)

Unset field value

Parameters

integer	$field	Field ID
integer	$index	Value index

Returns

void

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/galette-apidoc/checkouts/develop/galette/lib/Galette/Entity/DynamicFieldsHandle.php