Galette\Repository\Members Class Reference

Public Member Functions
	__construct (MembersList|AdvancedMembersList|null $filters=null)
	getStaffMembersList (bool $as_members=false, ?array $fields=null, bool $count=true, bool $limit=true)
	getManagedMembersList (bool $as_members=false, ?array $fields=null, bool $count=true, bool $limit=true)
	getMembersList (bool $as_members=false, ?array $fields=null, bool $count=true, bool $staff=false, bool $managed=false, bool $limit=true, bool $export=false)
	removeMembers (int|array $ids)
	getList (bool $as_members=false, ?array $fields=null)
	getPublicList (bool $with_photos)
	getArrayList (int|array $ids, ?array $orderby=null, bool $with_photos=false, bool $as_members=true, ?array $fields=null, bool $export=false, bool $dues=false, bool $parent=false)
	emptyLogins ()
	getRemindersCount ()
	getCount ()
	getErrors ()
	getFilters ()
	getDropdownMembers (Db $zdb, Login $login, ?int $current=null)

Static Public Member Functions
static	getEmails (Db $zdb)

Public Attributes
const	TABLE = Adherent::TABLE
const	PK = Adherent::PK
const	ALL_ACCOUNTS = 0
const	ACTIVE_ACCOUNT = 1
const	INACTIVE_ACCOUNT = 2
const	SHOW_LIST = 0
const	SHOW_PUBLIC_LIST = 1
const	SHOW_ARRAY_LIST = 2
const	SHOW_STAFF = 3
const	SHOW_MANAGED = 4
const	SHOW_EXPORT = 5
const	FILTER_NAME = 0
const	FILTER_ADDRESS = 1
const	FILTER_MAIL = 2
const	FILTER_JOB = 3
const	FILTER_INFOS = 4
const	FILTER_DC_EMAIL = 5
const	FILTER_W_EMAIL = 6
const	FILTER_WO_EMAIL = 7
const	FILTER_COMPANY_NAME = 8
const	FILTER_DC_PUBINFOS = 9
const	FILTER_W_PUBINFOS = 10
const	FILTER_WO_PUBINFOS = 11
const	FILTER_ID = 12
const	FILTER_NUMBER = 13
const	MEMBERSHIP_ALL = 0
const	MEMBERSHIP_UP2DATE = 3
const	MEMBERSHIP_NEARLY = 1
const	MEMBERSHIP_LATE = 2
const	MEMBERSHIP_NEVER = 4
const	MEMBERSHIP_STAFF = 5
const	MEMBERSHIP_ADMIN = 6
const	MEMBERSHIP_NONE = 7
const	ORDERBY_NAME = 'name'
const	ORDERBY_NICKNAME = 'nickname'
const	ORDERBY_STATUS = 'status'
const	ORDERBY_FEE_STATUS = 'fee_status'
const	ORDERBY_MODIFDATE = 'modif_date'
const	ORDERBY_ID = 'id'
const	NON_STAFF_MEMBERS = 30

Detailed Description

Members class for galette

Author

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

Constructor & Destructor Documentation

__construct()

Galette\Repository\Members::__construct

(

MembersList|AdvancedMembersList|null

$filters = null

)

Default constructor

Parameters

MembersList | AdvancedMembersList | null

$filters

Filtering

Member Function Documentation

emptyLogins()

Galette\Repository\Members::emptyLogins

(

)

Login and password field cannot be empty.

If those are not required, or if a file has been imported (from a CSV file for example), we fill here random values.

Returns

boolean

getArrayList()

Galette\Repository\Members::getArrayList	(	int|array	$ids,
		?array	$orderby = null,
		bool	$with_photos = false,
		bool	$as_members = true,
		?array	$fields = null,
		bool	$export = false,
		bool	$dues = false,
		bool	$parent = false
	)

Get list of members that has been selected

Parameters

	int|array<int>	$ids an array of members id that has been selected
	?array<string>	$orderby SQL order clause (optional)
boolean	$with_photos	Should photos be loaded?
boolean	$as_members	Return Adherent[] or simple ResultSet
	?array<string>	$fields Fields to use
boolean	$export	True if we are exporting
boolean	$dues	True if load dues as Adherent dependency
boolean	$parent	True if load parent as Adherent dependency

Returns

array <int,Adherent|ArrayObject<string, int|string>>|false

getCount()

Galette\Repository\Members::getCount

(

)

Get count for current query

Returns

int

getDropdownMembers()

Galette\Repository\Members::getDropdownMembers	(	Db	$zdb,
		Login	$login,
		?int	$current = null
	)

Get members list to instanciate dropdowns

Parameters

Db	$zdb	Database instance
Login	$login	Login instance
	?integer	$current Current member

Returns

array<int, string>

getEmails()

static Galette\Repository\Members::getEmails ( Db  $zdb )

static

Get all existing emails

Parameters

Db

$zdb

Database instance

Returns

array<string,int> ['email' => 'id_adh']

getErrors()

Galette\Repository\Members::getErrors

(

)

Get registered errors

Returns

array<string>

getFilters()

Galette\Repository\Members::getFilters

(

)

Get current filters

Returns

MembersList|AdvancedMembersList

getList()

Galette\Repository\Members::getList	(	bool	$as_members = false,
		?array	$fields = null
	)

Get members list

Parameters

boolean	$as_members	return the results as an array of Member object.
	?array<string>	$fields field(s) name(s) to get. Should be a string or an array. If null, all fields will be returned

Returns

Adherent[]|ResultSet

getManagedMembersList()

Galette\Repository\Members::getManagedMembersList	(	bool	$as_members = false,
		?array	$fields = null,
		bool	$count = true,
		bool	$limit = true
	)

Get managed members list (for groups managers)

Parameters

bool	$as_members	return the results as an array of Member object.
	?array<string>	$fields field(s) name(s) to get. Should be a string or an array. If null, all fields will be returned
boolean	$count	true if we want to count members
boolean	$limit	true to LIMIT query

Returns

Adherent[]|ResultSet

getMembersList()

Galette\Repository\Members::getMembersList	(	bool	$as_members = false,
		?array	$fields = null,
		bool	$count = true,
		bool	$staff = false,
		bool	$managed = false,
		bool	$limit = true,
		bool	$export = false
	)

Get members list

Parameters

bool	$as_members	return the results as an array of Member object.
	?array<string>	$fields field(s) name(s) to get. Should be a string or an array. If null, all fields will be returned
boolean	$count	true if we want to count members
boolean	$staff	true if we want only staff members
boolean	$managed	true if we want only managed groups
boolean	$limit	true if we want records pagination
boolean	$export	true if we are exporting

Returns

Adherent[]|ResultSet

getPublicList()

Galette\Repository\Members::getPublicList

(

bool

$with_photos

)

Get members list with public information available

Parameters

boolean

$with_photos

get only members which have uploaded a photo (for trombinoscope)

Returns

array<string, Adherent[]>

getRemindersCount()

Galette\Repository\Members::getRemindersCount

(

)

Get reminders count based on members state of dues

Returns

array<string, mixed>

getStaffMembersList()

Galette\Repository\Members::getStaffMembersList	(	bool	$as_members = false,
		?array	$fields = null,
		bool	$count = true,
		bool	$limit = true
	)

Get staff members list

Parameters

bool	$as_members	return the results as an array of Member object.
	?array<string>	$fields field(s) name(s) to get. Should be a string or an array. If null, all fields will be returned
boolean	$count	true if we want to count members
boolean	$limit	true to LIMIT query

Returns

Adherent[]|ResultSet

removeMembers()

Galette\Repository\Members::removeMembers

(

int|array

$ids

)

Remove specified members

Parameters

integer|array<int>

$ids Members identifiers to delete

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/Repository/Members.php