Galette\Entity\Status Class Reference

Public Member Functions
	__construct (Db $zdb, int|ArrayObject $args=null)
	installInit ()
	getList ()
	getCompleteList ()
	get (int $id)
	getLabel (int $id, bool $translated=true)
	getIdByLabel (string $label)
	add (string $label, int $extra)
	update (int $id, string $label, int $extra)
	delete (int $id)
	isUsed (int $id)
	__get (string $name)
	__isset (string $name)
	getErrors ()

Public Attributes
const	DEFAULT_STATUS = 9
const	TABLE = 'statuts'
const	PK = 'id_statut'
const	ID_NOT_EXITS = -1
const	ID_NOT_EXISTS = -1

Static Protected Attributes
static array	$defaults

Detailed Description

Members status

Author

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

Constructor & Destructor Documentation

__construct()

Galette\Entity\Status::__construct	(	Db	$zdb,
		int|ArrayObject	$args = null
	)

Default constructor

Parameters

Db	$zdb	Database
	int|ArrayObject<string,int|string>|null	$args Optional existing result set

Member Function Documentation

__get()

Galette\Entity\Status::__get

(

string

$name

)

Global getter method

Parameters

string

$name

name of the property we want to retrieve

Returns

mixed the called property

__isset()

Galette\Entity\Status::__isset

(

string

$name

)

Global isset method Required for twig to access properties via __get

Parameters

string

$name

name of the property we want to retrieve

Returns

bool

add()

Galette\Entity\Status::add	(	string	$label,
		int	$extra
	)

Add a new entry

Parameters

string	$label	The label
integer	$extra	Extra values (priority for statuses, extension for contributions types, ...)

Returns

bool|integer -2 : label already exists

delete()

Galette\Entity\Status::delete

(

int

$id

)

Delete entry

Parameters

integer

$id

Entry ID

Returns

self::ID_NOT_EXITS|boolean

get()

Galette\Entity\Status::get

(

int

$id

)

Get an entry

Parameters

integer

$id

Entry ID

Returns

ArrayObject<string, int|string>|false Row if succeed ; false: no such id

getCompleteList()

Galette\Entity\Status::getCompleteList

(

)

Complete list

Returns

array<int, array<string,mixed>> of all objects

getErrors()

Galette\Entity\Status::getErrors

(

)

Get errors

Returns

array<string>

getIdByLabel()

Galette\Entity\Status::getIdByLabel

(

string

$label

)

Get an ID from a label

Parameters

string

$label

The label

Returns

int|false Return id if it exists false otherwise

getLabel()

Galette\Entity\Status::getLabel	(	int	$id,
		bool	$translated = true
	)

Get a label

Parameters

integer	$id	Id
boolean	$translated	Do we want translated or original label? Defaults to true.

Returns

string|int

getList()

Galette\Entity\Status::getList

(

)

Get list in an array built as: $array[id] = "translated label"

Returns

array<int, string>

installInit()

Galette\Entity\Status::installInit

(

)

Set defaults at install time

Returns

boolean

Exceptions

Throwable

isUsed()

Galette\Entity\Status::isUsed

(

int

$id

)

Check if this entry is used.

Parameters

integer

$id

Entry ID

Returns

boolean

update()

Galette\Entity\Status::update	(	int	$id,
		string	$label,
		int	$extra
	)

Update in database.

Parameters

integer	$id	Entry ID
string	$label	The label
integer	$extra	Extra values (priority for statuses, extension for contributions types, ...)

Returns

self::ID_NOT_EXITS|boolean

Member Data Documentation

$defaults

array Galette\Entity\Status::$defaults

staticprotected

Initial value:

= array(
        array('id' => 1, 'libelle' => 'President', 'priority' => 0),
        array('id' => 2, 'libelle' => 'Treasurer', 'priority' => 10),
        array('id' => 3, 'libelle' => 'Secretary', 'priority' => 20),
        array('id' => 4, 'libelle' => 'Active member', 'priority' => 30),
        array('id' => 5, 'libelle' => 'Benefactor member', 'priority' => 40),
        array('id' => 6, 'libelle' => 'Founder member', 'priority' => 50),
        array('id' => 7, 'libelle' => 'Old-timer', 'priority' => 60),
        array('id' => 8, 'libelle' => 'Society', 'priority' => 70),
        array('id' => 9, 'libelle' => 'Non-member', 'priority' => 80),
        array('id' => 10, 'libelle' => 'Vice-president', 'priority' => 5)
    )

---

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