Functions
	handleCache (bool $nocache=false)

	getCacheFilename ()

	prepareForCache ()

	makeCache ()

	getDataTocache ()

	loadCache ()

	cacheLoaded (mixed $content)

	setDeps (array $deps)

	disableAllDeps ()

	enableAllDeps ()

	enableDep (string $name)

	disableDep (string $name)

	isDepEnabled (string $name)

	getDynamicFields ()

	dynamicsCheck (array $post, array $required, array $disabled)

	dynamicsStore (bool $transaction=false)

	dynamicsFiles (array $files)

	dynamicsRemove (bool $transaction=false)

	getErrors ()

	dynamicsValidate (array $values, string $prefix='dynfield_')

	getFormName ()

	getEventsPrefix ()

	activateEvents ()

	disableEvents ()

	areEventsEnabled ()

	withAddEvent ()

	withoutAddEvent ()

	getAddEventName ()

	hasAddEvent ()

	withEditEvent ()

	withoutEditEvent ()

	getEditEventName ()

	hasEditEvent ()

	withDeleteEvent ()

	withoutDeleteEvent ()

	getDeleteEventName ()

	hasDeleteEvent ()

	addTranslation (string $text_orig)

	updateTranslation (string $text_orig, string $text_locale, string $text_trans)

	deleteTranslation (string $text_orig)

	getWarnings ()

	getPermissionName ()

	getPermission ()

	getDynamicPatterns (string $form_name, bool $legacy=true)

	setPatterns (array $patterns)

	setReplacements (array $replaces)

	getMainPatterns ()

	getMemberPatterns (bool $legacy=true)

	getContributionPatterns (bool $legacy=true)

	setMail (PHPMailer $mail)

	setMain ()

	setNoContribution ()

	setContribution (Contribution $contrib)

	setMember (Adherent $member)

	setDynamicFields (string $form_name, array $dynamic_fields, ?object $object)

	getLegend ()

	getReplacements ()

	setDb (Db $db)

	setLogin (Login $login)

	setPreferences (Preferences $preferences)

	setRouteparser (RouteParser $routeparser)

	proceedReplacements (string $source)

	getPatterns ()

	checkSocials (array $post)

	storeSocials (int $id=null)

	getCoreRegisteredTypes ()

	getMemberRegisteredTypes ()

	getRegisteredTypes (bool $core)

	getName (bool $translated=true)

Variables
trait	BatchList

trait	Cacheable

bool	$nocache = false

trait	Dependencies

trait	Dynamics

string	$name_pattern = 'info_field_'

DynamicFieldsHandle	$dynamics

trait	HasEvent

bool	$events_active = true

trait	I18n

trait	Permissions

bool	$can_public = false

trait	Replacements

Db	$zdb

Login	$login

Preferences	$preferences

RouteParser	$routeparser

trait	Socials

trait	Translatable

string	$name = null

Detailed Description

This file is part of Galette (https://galette.eu).

Galette is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Galette is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Galette. If not, see http://www.gnu.org/licenses/.

Function Documentation

◆ activateEvents()

Galette\Features\activateEvents ( )

Activate events

Returns: self

◆ addTranslation()

Galette\Features\addTranslation ( string $text_orig )

protected

Add a translation stored in the database

Parameters

string $text_orig Text to translate

Returns: boolean

◆ areEventsEnabled()

Galette\Features\areEventsEnabled ( )

Are events enabled

Returns: bool

◆ cacheLoaded()

Galette\Features\cacheLoaded ( mixed $content )

abstractprotected

Called once cache has been loaded.

Parameters

mixed $content Content from cache

Returns: bool

◆ checkSocials()

Galette\Features\checkSocials ( array $post )

protected

Check socials

Parameters

array<string,mixed> $post User input

Returns: void

◆ deleteTranslation()

Galette\Features\deleteTranslation ( string $text_orig )

protected

Delete a translation stored in the database

Parameters

string $text_orig Text to translate

Returns: boolean

◆ disableAllDeps()

Galette\Features\disableAllDeps ( )

Reset dependencies to load

Returns: self

◆ disableDep()

Galette\Features\disableDep ( string $name )

Enable a load dependency

Parameters

string $name Dependency name

Returns: self

◆ disableEvents()

Galette\Features\disableEvents ( )

Disable events

Returns: self

◆ dynamicsCheck()

Galette\Features\dynamicsCheck	(	array	$post,
		array	$required,
		array	$disabled
	)

protected

Extract posted values for dynamic fields

Parameters

array<string,mixed>	$post Posted values
array<string,int\|bool>	$required Array of required fields
array<string>	$disabled Array of disabled fields

Returns: bool

◆ dynamicsFiles()

Galette\Features\dynamicsFiles ( array $files )

protected

Store dynamic Files

Parameters

array<string,mixed> $files Posted files

Returns: void

◆ dynamicsRemove()

Galette\Features\dynamicsRemove ( bool $transaction = false )

protected

Remove dynamic fields values

Parameters

bool $transaction True if a transaction already exists

Returns: bool

◆ dynamicsStore()

Galette\Features\dynamicsStore ( bool $transaction = false )

protected

Stores dynamic fields

Parameters

bool $transaction True if a transaction already exists

Returns: bool

◆ dynamicsValidate()

Galette\Features\dynamicsValidate	(	array	$values,
		string	$prefix = `'dynfield_'`
	)

Validate data for dynamic fields Set valid data in current object, also resets errors list

Parameters

	array<string>	$values Dynamic fields values
string	$prefix	Prefix to replace, default to 'dynfield_'

Returns: bool

◆ enableAllDeps()

Galette\Features\enableAllDeps ( )

Enable all dependencies to load

Returns: self

◆ enableDep()

Galette\Features\enableDep ( string $name )

Enable a load dependency

Parameters

string $name Dependency name

Returns: self

◆ getAddEventName()

Galette\Features\getAddEventName ( )

Get add event name

Returns: ?string

◆ getCacheFilename()

Galette\Features\getCacheFilename ( )

abstractprotected

Complete path to cache file

Returns: string

◆ getContributionPatterns()

Galette\Features\getContributionPatterns ( bool $legacy = true )

protected

Get patterns for a contribution

Parameters

boolean $legacy Whether to load legacy patterns

Returns: array<string,array<string,string>>

◆ getCoreRegisteredTypes()

Galette\Features\getCoreRegisteredTypes ( )

protected

Get core registered types

Returns: array<string,string>

◆ getDataTocache()

Galette\Features\getDataTocache ( )

protected

Get data to cache

Returns: string

◆ getDeleteEventName()

Galette\Features\getDeleteEventName ( )

Get edit event name

Returns: ?string

◆ getDynamicFields()

Galette\Features\getDynamicFields ( )

Get dynamic fields

Returns: DynamicFieldsHandle

◆ getDynamicPatterns()

Galette\Features\getDynamicPatterns	(	string	$form_name,
		bool	$legacy = `true`
	)

Get dynamic patterns

Parameters

string	$form_name	Dynamic form name
boolean	$legacy	Whether to load legacy patterns

Returns: array<string,array<string,string>>

◆ getEditEventName()

Galette\Features\getEditEventName ( )

Get edit event name

Returns: ?string

◆ getErrors()

Galette\Features\getErrors ( )

Get errors

Returns: array<string>

◆ getEventsPrefix()

Galette\Features\getEventsPrefix ( )

abstractprotected

Get prefix for events

Returns: string

◆ getFormName()

Galette\Features\getFormName ( )

Get form name

Returns: string

◆ getLegend()

Galette\Features\getLegend ( )

Build legend array

Returns: array<string,array<string,string>>

◆ getMainPatterns()

Galette\Features\getMainPatterns ( )

protected

Get main patterns

Returns: array<string,array<string,string>>

◆ getMemberPatterns()

Galette\Features\getMemberPatterns ( bool $legacy = true )

protected

Get patterns for a member

Parameters

boolean $legacy Whether to load legacy patterns

Returns: array<string,array<string,string>>

◆ getMemberRegisteredTypes()

Galette\Features\getMemberRegisteredTypes ( )

Get member registered types

Returns: array<string,string>

◆ getName()

Galette\Features\getName ( bool $translated = true )

Get field name

Parameters

boolean $translated Get translated or raw name

Returns: string

◆ getPatterns()

Galette\Features\getPatterns ( )

Get patterns

Returns: array<string,array<string,string>>

◆ getPermission()

Galette\Features\getPermission ( )

Get current permissions

Returns: integer|null

◆ getPermissionName()

Galette\Features\getPermissionName ( )

Get permission name

Returns: string

◆ getRegisteredTypes()

Galette\Features\getRegisteredTypes ( bool $core )

protected

Get registered types

Parameters

bool $core True for core type, false for members ones

Returns: array<string,string>

◆ getReplacements()

Galette\Features\getReplacements ( )

Get configured replacements

Returns: array<string,string>

◆ getWarnings()

Galette\Features\getWarnings ( )

Get warnings

Returns: array<string>

◆ handleCache()

Galette\Features\handleCache ( bool $nocache = false )

protected

Handle cache

Parameters

boolean $nocache Do not try to cache

Returns: void

◆ hasAddEvent()

Galette\Features\hasAddEvent ( )

Has add event

Returns: bool

◆ hasDeleteEvent()

Galette\Features\hasDeleteEvent ( )

Has delete event

Returns: bool

◆ hasEditEvent()

Galette\Features\hasEditEvent ( )

Has edit event

Returns: bool

◆ isDepEnabled()

Galette\Features\isDepEnabled ( string $name )

protected

Is load dependency enabled?

Parameters

string $name Dependency name

Returns: boolean

◆ loadCache()

Galette\Features\loadCache ( )

protected

Loads entries from cache

Returns: void

◆ makeCache()

Galette\Features\makeCache ( )

protected

Creates/update the cache

Returns: void

◆ prepareForCache()

Galette\Features\prepareForCache ( )

abstractprotected

Ensure data to cache are present

Returns: void

◆ proceedReplacements()

Galette\Features\proceedReplacements ( string $source )

protected

Proceed replacement on given entry

Parameters

string $source Source string

Returns: string

◆ setContribution()

Galette\Features\setContribution ( Contribution $contrib )

Set contribution and proceed related replacements

Parameters

Contribution $contrib Contribution

Returns: self

the list of all dynamic fields

◆ setDb()

Galette\Features\setDb ( Db $db )

Set Db dependency

Parameters

Db $db Db instance

Returns: self

◆ setDeps()

Galette\Features\setDeps ( array $deps )

Set dependencies

Parameters

array<string,bool> $deps Dependencies to set

Returns: self

◆ setDynamicFields()

Galette\Features\setDynamicFields	(	string	$form_name,
		array	$dynamic_fields,
		?object	$object
	)

Set dynamic fields and proceed related replacements

Parameters

string	$form_name	Form name
	array<string,mixed>	$dynamic_fields Dynamic fields
	?object	$object Related object (Adherent, Contribution, ...)

Returns: self

dynamic field label

dynamic field value

◆ setLogin()

Galette\Features\setLogin ( Login $login )

Set Login dependency

Parameters

Login $login Login instance

Returns: self

◆ setMail()

Galette\Features\setMail ( PHPMailer $mail )

Set mail instance

Parameters

PHPMailer $mail PHPMailer instance

Returns: self

◆ setMain()

Galette\Features\setMain ( )

Set main replacements

Returns: self

◆ setMember()

Galette\Features\setMember ( Adherent $member )

Set member and proceed related replacements

Parameters

Adherent $member Member

Returns: self

the list of all dynamic fields

◆ setNoContribution()

Galette\Features\setNoContribution ( )

Set contribution and proceed related replacements

Returns: self

the list of all dynamic fields

◆ setPatterns()

Galette\Features\setPatterns ( array $patterns )

protected

Set patterns

Parameters

array<string,array<string,string>> $patterns Patterns to add

Returns: self

◆ setPreferences()

Galette\Features\setPreferences ( Preferences $preferences )

Set Preferences dependency

Parameters

Preferences $preferences Preferences instance

Returns: self

◆ setReplacements()

Galette\Features\setReplacements ( array $replaces )

Set replacements

Parameters

array<string,?string> $replaces Replacements to add

Returns: void

◆ setRouteparser()

Galette\Features\setRouteparser ( RouteParser $routeparser )

Set RouteParser dependency

Parameters

RouteParser $routeparser RouteParser instance

Returns: self

◆ storeSocials()

Galette\Features\storeSocials ( int $id = null )

protected

Store social networks/contacts

Parameters

int | null $id ID

Returns: bool

◆ updateTranslation()

Galette\Features\updateTranslation	(	string	$text_orig,
		string	$text_locale,
		string	$text_trans
	)

protected

Update a translation stored in the database

Parameters

string	$text_orig	Text to translate
string	$text_locale	The locale
string	$text_trans	Translated text

Returns: boolean

◆ withAddEvent()

Galette\Features\withAddEvent ( )

Activate add event

Returns: self

◆ withDeleteEvent()

Galette\Features\withDeleteEvent ( )

Activate add event

Returns: self

◆ withEditEvent()

Galette\Features\withEditEvent ( )

Activate edit event

Returns: self

◆ withoutAddEvent()

Galette\Features\withoutAddEvent ( )

Disable add event

Returns: self

◆ withoutDeleteEvent()

Galette\Features\withoutDeleteEvent ( )

Disable delete event

Returns: self

◆ withoutEditEvent()

Galette\Features\withoutEditEvent ( )

Disable edit event

Returns: self

Variable Documentation

◆ BatchList

trait Galette::Features\BatchList

Initial value:

{
    
    abstract public function getFilterName(array $args = null): string

Batch list feature

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

◆ Cacheable

trait Galette::Features\Cacheable

Initial value:

{
    
    protected int $cache_timeout = 24

Cacheable objects trait

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

◆ Dependencies

trait Galette::Features\Dependencies

Initial value:

{
    
    protected array $deps = array(
        'picture'   => true,
        'groups'    => true,
        'dues'      => true,
        'parent'    => false,
        'children'  => false,
        'dynamics'  => false,
        'socials'   => false
    )

Dependencies feature

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

◆ Dynamics

trait Galette::Features\Dynamics

Initial value:

{

use Dependencies

Galette\Features\Dependencies

trait Dependencies

Definition: Dependencies.php:47

Dynamics fields trait

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

◆ HasEvent

trait Galette::Features\HasEvent

Initial value:

{

private bool $has_add_event = false

Translatable objects trait

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

◆ I18n

trait Galette::Features\I18n

Initial value:

{
    
    protected array $warnings = []

Files

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

◆ Permissions

trait Galette::Features\Permissions

Initial value:

{

protected ?int $permission = null

Permissions

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

◆ Replacements

trait Galette::Features\Replacements

Initial value:

{
    
    private array $patterns = []

Replacements feature

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

◆ Socials

trait Galette::Features\Socials

Initial value:

{
    
    protected array $socials_input = []

Socials feature

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

◆ Translatable

trait Galette::Features\Translatable

Initial value:

{

protected ?string $old_name = null

Translatable objects trait

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

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

Functions

Variables

Detailed Description

Function Documentation

◆ activateEvents()

◆ addTranslation()

◆ areEventsEnabled()

◆ cacheLoaded()

◆ checkSocials()

◆ deleteTranslation()

◆ disableAllDeps()

◆ disableDep()

◆ disableEvents()

◆ dynamicsCheck()

◆ dynamicsFiles()

◆ dynamicsRemove()

◆ dynamicsStore()

◆ dynamicsValidate()

◆ enableAllDeps()

◆ enableDep()

◆ getAddEventName()

◆ getCacheFilename()

◆ getContributionPatterns()

◆ getCoreRegisteredTypes()

◆ getDataTocache()

◆ getDeleteEventName()

◆ getDynamicFields()

◆ getDynamicPatterns()

◆ getEditEventName()

◆ getErrors()

◆ getEventsPrefix()

◆ getFormName()

◆ getLegend()

◆ getMainPatterns()

◆ getMemberPatterns()

◆ getMemberRegisteredTypes()

◆ getName()

◆ getPatterns()

◆ getPermission()

◆ getPermissionName()

◆ getRegisteredTypes()

◆ getReplacements()

◆ getWarnings()

◆ handleCache()

◆ hasAddEvent()

◆ hasDeleteEvent()

◆ hasEditEvent()

◆ isDepEnabled()

◆ loadCache()

◆ makeCache()

◆ prepareForCache()

◆ proceedReplacements()

◆ setContribution()

◆ setDb()

◆ setDeps()

◆ setDynamicFields()

◆ setLogin()

◆ setMail()

◆ setMain()

◆ setMember()

◆ setNoContribution()

◆ setPatterns()

◆ setPreferences()

◆ setReplacements()

◆ setRouteparser()

◆ storeSocials()

◆ updateTranslation()

◆ withAddEvent()

◆ withDeleteEvent()

◆ withEditEvent()

◆ withoutAddEvent()

◆ withoutDeleteEvent()

◆ withoutEditEvent()

Variable Documentation

◆ BatchList

◆ Cacheable

◆ Dependencies

◆ Dynamics

◆ HasEvent

◆ I18n