Galette\Repository\SavedSearches Class Reference

Public Member Functions
	__construct (Db $zdb, Login $login, SavedSearchesList $filters=null)
	getList (bool $as_search=false, ?array $fields=null)
	getCount ()
	remove (int|array $ids, History $hist, bool $transaction=true)

Public Attributes
const	TABLE = SavedSearch::TABLE
const	PK = SavedSearch::PK

Detailed Description

Saved searches

Author

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

Constructor & Destructor Documentation

__construct()

Galette\Repository\SavedSearches::__construct	(	Db	$zdb,
		Login	$login,
		SavedSearchesList	$filters = null
	)

Default constructor

Parameters

Db	$zdb	Database
Login	$login	Login
	?SavedSearchesList	$filters Filtering

Member Function Documentation

getCount()

Galette\Repository\SavedSearches::getCount

(

)

Get count for current query

Returns

int

getList()

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

Get saved searches list

Parameters

bool	$as_search	return the results as an array of SavedSearch 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

array<int, SavedSearch>|ResultSet

remove()

Galette\Repository\SavedSearches::remove	(	int|array	$ids,
		History	$hist,
		bool	$transaction = true
	)

Remove specified searches

Parameters

	integer|array<int>	$ids Searches identifiers to delete
History	$hist	History
boolean	$transaction	True to begin a database transaction

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