Galette\Repository\Repository Class Reference

Inheritance diagram for Galette\Repository\Repository:

Collaboration diagram for Galette\Repository\Repository:

Public Member Functions
	__construct (Db $zdb, Preferences $preferences, Login $login, ?string $entity=null, ?string $ns=null, string $prefix='')
	getList ()
	installInit (bool $check_first=true)

Protected Member Functions
	getFilters ()
	setFilters (Pagination $filters)
	loadDefaults ()
	canOrderBy (string $field_name, ?array $fields)

Protected Attributes
Db	$zdb
Preferences	$preferences
string	$entity
Login	$login
Pagination	$filters
array	$defaults = []
string	$prefix

Detailed Description

Repositories

Author

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

Constructor & Destructor Documentation

__construct()

Galette\Repository\Repository::__construct	(	Db	$zdb,
		Preferences	$preferences,
		Login	$login,
		?string	$entity = null,
		?string	$ns = null,
		string	$prefix = ''
	)

Main constructor

Parameters

Db	$zdb	Database instance
Preferences	$preferences	Galette preferences
Login	$login	Logged in instance
	?string	$entity Related entity class name
	?string	$ns Related entity namespace
string	$prefix	Prefix (for plugins)

Member Function Documentation

canOrderBy()

Galette\Repository\Repository::canOrderBy ( string  $field_name, ?array  $fields  )

protected

Is field allowed to order? it should be present in provided fields list (those that are SELECT'ed).

Parameters

string	$field_name	Field name to order by
	?array<string>	$fields SELECTE'ed fields

Returns

boolean

getFilters()

Galette\Repository\Repository::getFilters ( )

protected

Get filters

Returns

Pagination

getList()

Galette\Repository\Repository::getList ( )

abstract

Get list

Returns

array<int, object>|ResultSet

Reimplemented in Galette\Repository\PdfModels.

installInit()

Galette\Repository\Repository::installInit ( bool  $check_first = true )

abstract

Add default values in database

Parameters

boolean

$check_first

Check first if it seems initialized, defaults to true

Returns

boolean

Reimplemented in Galette\Repository\PdfModels, and Galette\Repository\PaymentTypes.

loadDefaults()

Galette\Repository\Repository::loadDefaults ( )

protected

Load and get default values

Returns

array<string,mixed>

Reimplemented in Galette\Repository\PdfModels, and Galette\Repository\PaymentTypes.

setFilters()

Galette\Repository\Repository::setFilters ( Pagination  $filters )

protected

Set filters

Parameters

Pagination

$filters

Filters

Returns

self

---

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