Galette\Core\MailingHistory Class Reference

Inheritance diagram for Galette\Core\MailingHistory:

Collaboration diagram for Galette\Core\MailingHistory:

Public Member Functions
	__construct (Db $zdb, Login $login, Preferences $preferences, MailingsList $filters=null, Mailing $mailing=null)
	getHistory ()
	storeMailing (bool $sent=false)
	update ()
	store ()
	removeEntries (int|array $ids, History $hist)
	getCount ()
Public Member Functions inherited from Galette\Core\History
	__construct (Db $zdb, Login $login, Preferences $preferences, HistoryList $filters=null)
	add (string $action, string $argument='', string $query='')
	clean ()
	__get (string $name)
	__isset (string $name)
	__set (string $name, mixed $value)
	setFilters (HistoryList $filters)
	getUsersList ()
	getActionsList ()

Public Attributes
const	TABLE = 'mailing_history'
const	PK = 'mailing_id'
const	FILTER_DC_SENT = 0
const	FILTER_SENT = 1
const	FILTER_NOT_SENT = 2
Public Attributes inherited from Galette\Core\History
const	TABLE = 'logs'
const	PK = 'id_log'

Protected Member Functions
	buildOrderClause ()
	getTableName (bool $prefixed=false)
	getPk ()

Additional Inherited Members
Static Public Member Functions inherited from Galette\Core\History
static	findUserIPAddress ()
Protected Attributes inherited from Galette\Core\History
int	$count
Db	$zdb
Login	$login
Preferences	$preferences
HistoryList	$filters
array	$users
array	$actions
bool	$with_lists = true

Constructor & Destructor Documentation

__construct()

Galette\Core\MailingHistory::__construct	(	Db	$zdb,
		Login	$login,
		Preferences	$preferences,
		MailingsList	$filters = null,
		Mailing	$mailing = null
	)

Default constructor

Parameters

Db	$zdb	Database
Login	$login	Login
Preferences	$preferences	Preferences
MailingsList | null	$filters	Filtering
Mailing | null	$mailing	Mailing

Member Function Documentation

buildOrderClause()

Galette\Core\MailingHistory::buildOrderClause ( )

protected

Builds the order clause

Returns

array<int, string> SQL ORDER clauses

Reimplemented from Galette\Core\History.

getCount()

Galette\Core\MailingHistory::getCount

(

)

Get count for current query

Returns

int

Reimplemented from Galette\Core\History.

getHistory()

Galette\Core\MailingHistory::getHistory

(

)

Get the entire history list

Returns

array<int, object>

Reimplemented from Galette\Core\History.

getPk()

Galette\Core\MailingHistory::getPk ( )

protected

Get table's PK

Returns

string

Reimplemented from Galette\Core\History.

getTableName()

Galette\Core\MailingHistory::getTableName ( bool  $prefixed = false )

protected

Get table's name

Parameters

boolean

$prefixed

Whether table name should be prefixed

Returns

string

Reimplemented from Galette\Core\History.

removeEntries()

Galette\Core\MailingHistory::removeEntries	(	int|array	$ids,
		History	$hist
	)

Remove specified entries

Parameters

	integer|array<int>	$ids Mailing history entries identifiers
History	$hist	History instance

Returns

boolean

store()

Galette\Core\MailingHistory::store

(

)

Store in the database

Returns

boolean

storeMailing()

Galette\Core\MailingHistory::storeMailing

(

bool

$sent = false

)

Store a mailing in the history

Parameters

boolean

$sent

Defaults to false

Returns

boolean

update()

Galette\Core\MailingHistory::update

(

)

Update in the database

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/Core/MailingHistory.php