Public Member Functions
	loadGroups ()

	loadSocials ()

	isAdmin ()

	isStaff ()

	isDueFree ()

	isGroupMember (string $group_name)

	isGroupManager (?string $group_name)

	isCompany ()

	isMan ()

	isWoman ()

	appearsInMembersList ()

	isActive ()

	hasPicture ()

	hasParent ()

	hasChildren ()

	getRowClass (bool $public=false)

	getDues ()

	isSponsor ()

	setSelfMembership ()

	isUp2Date ()

	setDependencies (Preferences $preferences, array $fields, History $history)

	check (array $values, array $required, array $disabled)

	validate (string $field, mixed $value, array $values)

	store ()

	__get (string $name)

	__isset (string $name)

	getEmail ()

	getAddress ()

	getZipcode ()

	getTown ()

	getRegion ()

	getCountry ()

	getAge ()

	getParentFields ()

	handleFiles (array $files, array $cropping=null)

	setDuplicate ()

	getErrors ()

	getGroups ()

	getManagedGroups ()

	canCreate (Login $login)

	canEdit (Login $login)

	canShow (Login $login)

	isDuplicate ()

	setSendmail (bool $send=true)

	sendEMail ()

	setParent (int $id)

	getDueStatus ()

Static Public Member Functions
static	getSName (Db $zdb, int $id, bool $wid=false, bool $wnick=false)

static	getNameWithCase (?string $name, ?string $surname, Title\|bool $title=false, int\|bool $id=false, string\|bool $nick=false)

static	updatePassword (Db $zdb, int $id_adh, string $pass)

static	getDbFields (Db $zdb)

Public Attributes
const	TABLE = 'adherents'

const	PK = 'id_adh'

const	NC = 0

const	MAN = 1

const	WOMAN = 2

const	AFTER_ADD_DEFAULT = 0

const	AFTER_ADD_TRANS = 1

const	AFTER_ADD_NEW = 2

const	AFTER_ADD_SHOW = 3

const	AFTER_ADD_LIST = 4

const	AFTER_ADD_HOME = 5

Protected Member Functions
	getEventsPrefix ()

Member Function Documentation

◆ __get()

Galette\Entity\Adherent::__get ( string $name )

Global getter method

Parameters

string $name name of the property we want to retrieve

Returns: mixed

◆ __isset()

Galette\Entity\Adherent::__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

◆ appearsInMembersList()

Galette\Entity\Adherent::appearsInMembersList ( )

Can member appears in public members list?

Returns: bool

◆ canCreate()

Galette\Entity\Adherent::canCreate ( Login $login )

Can current logged-in user create member

Parameters

Login $login Login instance

Returns: boolean

◆ canEdit()

Galette\Entity\Adherent::canEdit ( Login $login )

Can current logged-in user edit member

Parameters

Login $login Login instance

Returns: boolean

◆ canShow()

Galette\Entity\Adherent::canShow ( Login $login )

Can current logged-in user display member

Parameters

Login $login Login instance

Returns: boolean

◆ check()

Galette\Entity\Adherent::check	(	array	$values,
		array	$required,
		array	$disabled
	)

Check posted values validity

Parameters

array<string,mixed>	$values All values to check, basically the $_POST array after sending the form
array<string,bool>	$required Array of required fields
array<string>	$disabled Array of disabled fields

Returns: true|array<string>

◆ getAddress()

Galette\Entity\Adherent::getAddress ( )

Get member address. If member does not have an address, but is attached to another member, we'll take information from its parent.

Returns: string

◆ getAge()

Galette\Entity\Adherent::getAge ( )

Get member age

Returns: string

◆ getCountry()

Galette\Entity\Adherent::getCountry ( )

Get member country. If member does not have an address, but is attached to another member, we'll take information from its parent.

Returns: string

◆ getDbFields()

static Galette\Entity\Adherent::getDbFields ( Db $zdb )

static

Retrieve fields from database

Parameters

Db $zdb Database instance

Returns: array<string>

◆ getDues()

Galette\Entity\Adherent::getDues ( )

Get current member due status

Returns: string i18n string representing state of due

◆ getDueStatus()

Galette\Entity\Adherent::getDueStatus ( )

Get current due status

Returns: int

◆ getEmail()

Galette\Entity\Adherent::getEmail ( )

Get member email If member does not have an email address, but is attached to another member, we'll take information from its parent.

Returns: string

◆ getErrors()

Galette\Entity\Adherent::getErrors ( )

Get current errors

Returns: array<string>

◆ getEventsPrefix()

Galette\Entity\Adherent::getEventsPrefix ( )

protected

Get prefix for events

Returns: string

◆ getGroups()

Galette\Entity\Adherent::getGroups ( )

Get user groups

Returns: array<int, Group>

◆ getManagedGroups()

Galette\Entity\Adherent::getManagedGroups ( )

Get user managed groups

Returns: array<int, Group>

◆ getNameWithCase()

static Galette\Entity\Adherent::getNameWithCase	(	?string	$name,
		?string	$surname,
		Title\|bool	$title = `false`,
		int\|bool	$id = `false`,
		string\|bool	$nick = `false`
	)

static

Get member name with correct case

Parameters

	?string	$name Member name
	?string	$surname Member surname
false \| Title	$title	Member title to show or false
false \| integer	$id	Member id to display or false
false \| string	$nick	Member nickname to display or false

Returns: string

◆ getParentFields()

Galette\Entity\Adherent::getParentFields ( )

Get parent inherited fields

Returns: array<string>

◆ getRegion()

Galette\Entity\Adherent::getRegion ( )

Get member region. If member does not have an address, but is attached to another member, we'll take information from its parent.

Returns: string

◆ getRowClass()

Galette\Entity\Adherent::getRowClass ( bool $public = false )

Get row class related to current fee status

Parameters

boolean $public we want the class for public pages

Returns: string the class to apply

◆ getSName()

static Galette\Entity\Adherent::getSName	(	Db	$zdb,
		int	$id,
		bool	$wid = `false`,
		bool	$wnick = `false`
	)

static

Retrieve Full name and surname for the specified member id

Parameters

Db	$zdb	Database instance
integer	$id	Member id
boolean	$wid	Add member id
boolean	$wnick	Add member nickname

Returns: string formatted Name and Surname

◆ getTown()

Galette\Entity\Adherent::getTown ( )

Get member town. If member does not have an address, but is attached to another member, we'll take information from its parent.

Returns: string

◆ getZipcode()

Galette\Entity\Adherent::getZipcode ( )

Get member zipcode. If member does not have an address, but is attached to another member, we'll take information from its parent.

Returns: string

◆ handleFiles()

Galette\Entity\Adherent::handleFiles	(	array	$files,
		array	$cropping = `null`
	)

Handle files (photo and dynamics files)

Parameters

array<string,mixed>	$files Files sent
?array<string,mixed>	$cropping Cropping properties

Returns: array<string>|true

◆ hasChildren()

Galette\Entity\Adherent::hasChildren ( )

Does member have children?

Returns: bool

◆ hasParent()

Galette\Entity\Adherent::hasParent ( )

Does member have a parent?

Returns: bool

◆ hasPicture()

Galette\Entity\Adherent::hasPicture ( )

Does member have uploaded a picture?

Returns: bool

◆ isActive()

Galette\Entity\Adherent::isActive ( )

Is member active?

Returns: bool

◆ isAdmin()

Galette\Entity\Adherent::isAdmin ( )

Is member admin?

Returns: bool

◆ isCompany()

Galette\Entity\Adherent::isCompany ( )

Does current member represents a company?

Returns: boolean

◆ isDueFree()

Galette\Entity\Adherent::isDueFree ( )

Is member freed of dues?

Returns: bool

◆ isDuplicate()

Galette\Entity\Adherent::isDuplicate ( )

Are we currently duplicated a member?

Returns: boolean

◆ isGroupManager()

Galette\Entity\Adherent::isGroupManager ( ?string $group_name )

Is member manager of specified group?

Parameters

?string $group_name Group name

Returns: boolean

◆ isGroupMember()

Galette\Entity\Adherent::isGroupMember ( string $group_name )

Is member in specified group?

Parameters

string $group_name Group name

Returns: boolean

◆ isMan()

Galette\Entity\Adherent::isMan ( )

Is current member a man?

Returns: boolean

◆ isSponsor()

Galette\Entity\Adherent::isSponsor ( )

Is member a sponsor for current period?

Returns: bool

◆ isStaff()

Galette\Entity\Adherent::isStaff ( )

Is user member of staff?

Returns: bool

◆ isUp2Date()

Galette\Entity\Adherent::isUp2Date ( )

Is member up to date?

Returns: boolean

◆ isWoman()

Galette\Entity\Adherent::isWoman ( )

Is current member a woman?

Returns: boolean

◆ loadGroups()

Galette\Entity\Adherent::loadGroups ( )

Load member groups

Returns: void

◆ loadSocials()

Galette\Entity\Adherent::loadSocials ( )

Load member social network/contact information

Returns: void

◆ sendEMail()

Galette\Entity\Adherent::sendEMail ( )

Should we send administrative emails to member?

Returns: boolean

◆ setDependencies()

Galette\Entity\Adherent::setDependencies	(	Preferences	$preferences,
		array	$fields,
		History	$history
	)

Set dependencies

Parameters

Preferences	$preferences	Preferences instance
	array<string,mixed>	$fields Members fields configuration
History	$history	History instance

Returns: void

◆ setDuplicate()

Galette\Entity\Adherent::setDuplicate ( )

Set member as duplicate

Returns: void

◆ setParent()

Galette\Entity\Adherent::setParent ( int $id )

Set member parent

Parameters

integer $id Parent identifier

Returns: $this

◆ setSelfMembership()

Galette\Entity\Adherent::setSelfMembership ( )

Mark as self membership

Returns: void

◆ setSendmail()

Galette\Entity\Adherent::setSendmail ( bool $send = true )

Flag creation mail sending

Parameters

boolean $send True (default) to send creation email

Returns: Adherent

◆ store()

Galette\Entity\Adherent::store ( )

Store the member

Returns: boolean

◆ updatePassword()

static Galette\Entity\Adherent::updatePassword	(	Db	$zdb,
		int	$id_adh,
		string	$pass
	)

static

Change password for a given user

Parameters

Db	$zdb	Database instance
integer	$id_adh	Member identifier
string	$pass	New password

Returns: boolean

◆ validate()

Galette\Entity\Adherent::validate	(	string	$field,
		mixed	$value,
		array	$values
	)

Validate data for given key Set valid data in current object, also resets errors list

Parameters

string	$field	Field name
mixed	$value	Value we want to set
	array<string,mixed>	$values All values, for some references

Returns: void

FIXME: add a preference for login length

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

	Galette API documentation Gestionnaire d’Adhérents en Ligne Extrêmement Tarabiscoté mais Tellement Efficace
1.0.0

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Member Function Documentation

◆ __get()

◆ __isset()

◆ appearsInMembersList()

◆ canCreate()

◆ canEdit()

◆ canShow()

◆ check()

◆ getAddress()

◆ getAge()

◆ getCountry()

◆ getDbFields()

◆ getDues()

◆ getDueStatus()

◆ getEmail()

◆ getErrors()

◆ getEventsPrefix()

◆ getGroups()

◆ getManagedGroups()

◆ getNameWithCase()

◆ getParentFields()

◆ getRegion()

◆ getRowClass()

◆ getSName()

◆ getTown()

◆ getZipcode()

◆ handleFiles()

◆ hasChildren()

◆ hasParent()

◆ hasPicture()

◆ isActive()

◆ isAdmin()

◆ isCompany()

◆ isDueFree()

◆ isDuplicate()

◆ isGroupManager()

◆ isGroupMember()

◆ isMan()

◆ isSponsor()

◆ isStaff()

◆ isUp2Date()

◆ isWoman()

◆ loadGroups()

◆ loadSocials()

◆ sendEMail()

◆ setDependencies()

◆ setDuplicate()

◆ setParent()

◆ setSelfMembership()

◆ setSendmail()

◆ store()

◆ updatePassword()

◆ validate()