Galette\Entity\ListsConfig Class Reference

Inheritance diagram for Galette\Entity\ListsConfig:

Collaboration diagram for Galette\Entity\ListsConfig:

Public Member Functions
	getDisplayElements (Login $login)
	getListedFields ()
	getRemainingFields ()
	setListFields (array $fields)
	getAclMapping ()
	getVisibility (string $field)
Public Member Functions inherited from Galette\Entity\FieldsConfig
	__construct (Db $zdb, string $table, array $defaults, array $cats_defaults, bool $install=false)
	isRequired (string $field)
	setNotRequired (string $field)
	installInit ()
	getNonRequired ()
	getFormElements (Login $login, bool $new, bool $selfs=false)
	getRequired ()
	getVisibilities ()
	getCategorizedFields ()
	setFields (array $fields)
	migrateRequired ()
	isSelfExcluded (string $name)
	filterVisible (Login $login, array &$fields)
	getMassiveFormElements (array $fields, Login $login)
	getField (string $name)

Protected Member Functions
	buildField (ArrayObject $rset)
	buildLists ()
	addToLists (array $field)
Protected Member Functions inherited from Galette\Entity\FieldsConfig
	prepareField (ArrayObject $rset)

Protected Attributes
array	$listed_fields = array()
Protected Attributes inherited from Galette\Entity\FieldsConfig
Db	$zdb
array	$core_db_fields = array()
array	$all_required = array()
array	$all_visibles = array()
array	$categorized_fields = array()
string	$table
array	$defaults = null
array	$cats_defaults = null

Additional Inherited Members
Public Attributes inherited from Galette\Entity\FieldsConfig
const	NOBODY = 0
const	USER_WRITE = 1
const	ADMIN = 2
const	STAFF = 3
const	MANAGER = 4
const	USER_READ = 5
const	ALL = 10
const	TYPE_STR = 0
const	TYPE_HIDDEN = 1
const	TYPE_BOOL = 2
const	TYPE_INT = 3
const	TYPE_DEC = 4
const	TYPE_DATE = 5
const	TYPE_TXT = 6
const	TYPE_PASS = 7
const	TYPE_EMAIL = 8
const	TYPE_URL = 9
const	TYPE_RADIO = 10
const	TYPE_SELECT = 11
const	TABLE = 'fields_config'

Detailed Description

Lists config class for galette: defines fields order and visibility

Author

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

Member Function Documentation

addToLists()

Galette\Entity\ListsConfig::addToLists ( array  $field )

protected

Adds a field to lists

Parameters

array<string,mixed>

$field Field values

Returns

void

Reimplemented from Galette\Entity\FieldsConfig.

buildField()

Galette\Entity\ListsConfig::buildField ( ArrayObject  $rset )

protected

Prepare a field (required data, automation)

Parameters

ArrayObject<string,int|string>

$rset DB ResultSet row

Returns

array<string, int|string>

Reimplemented from Galette\Entity\FieldsConfig.

buildLists()

Galette\Entity\ListsConfig::buildLists ( )

protected

Create field array configuration, Several lists of fields are kept (visible, requireds, etc), build them.

Returns

void

Reimplemented from Galette\Entity\FieldsConfig.

getAclMapping()

Galette\Entity\ListsConfig::getAclMapping

(

)

Get ACL mapping for list elements not present in form configuration

Returns

array<string,string>

getDisplayElements()

Galette\Entity\ListsConfig::getDisplayElements

(

Login

$login

)

Retrieve display elements

Parameters

Login

$login

Login instance

Returns

array<int,object>

Reimplemented from Galette\Entity\FieldsConfig.

getListedFields()

Galette\Entity\ListsConfig::getListedFields

(

)

Get all fields for list

Returns

array<int,array<string,mixed>>

getRemainingFields()

Galette\Entity\ListsConfig::getRemainingFields

(

)

Get remaining free fields for list

Returns

array<string,array<string,mixed>>

getVisibility()

Galette\Entity\ListsConfig::getVisibility

(

string

$field

)

Get visibility for specified field

Parameters

string

$field

The requested field

Returns

integer

Reimplemented from Galette\Entity\FieldsConfig.

setListFields()

Galette\Entity\ListsConfig::setListFields

(

array

$fields

)

Set fields

Parameters

array<int,array<string,mixed>>

$fields categorized fields array

Returns

boolean

---

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/ListsConfig.php