HistoryLog_Form_Reports

HistoryLog_Form_Reports

History log report generation form class

• Class name: HistoryLog_Form_Reports
• Namespace:
• Parent class: Omeka_Form

Methods

\HistoryLog_Form_Reports::init()

void HistoryLog_Form_Reports::\HistoryLog_Form_Reports::init()()

Construct the report generation form.

• Visibility: public

\HistoryLog_Form_Reports::_registerElements()

void HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_registerElements()()

Define the form elements.

• Visibility: private

\HistoryLog_Form_Reports::ProcessPost()

string HistoryLog_Form_Reports::\HistoryLog_Form_Reports::ProcessPost()(string $style)

Process the data from the form and retrieve the requested log data.

• Visibility: public
• This method is static.

Arguments

• $style string - <p>The style in which to return the data. Accepted values: "html"(default), "JSON"</p>

\HistoryLog_Form_Reports::_getActionOptions()

array HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_getActionOptions()()

Retrieve possible log actions as selectable option list

• Visibility: private

\HistoryLog_Form_Reports::_getCollectionOptions()

array HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_getCollectionOptions()()

Retrieve Collections as selectable option list

• Visibility: private

\HistoryLog_Form_Reports::_getUserOptions()

array HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_getUserOptions()()

Retrieve Omeka Admin Users as selectable option list

• Visibility: private

\HistoryLog_Form_Reports::_getItem()

string HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_getItem()(int $itemID)

Retrieve title of an item by given itemID

• Visibility: private
• This method is static.

Arguments

• $itemID int - <p>The ID of the item</p>

\HistoryLog_Form_Reports::_getUser()

string HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_getUser()(int $userID)

Retrieve username of an omeka user by user ID

• Visibility: private
• This method is static.

Arguments

• $userID int - <p>The ID of the Omeka user</p>

\HistoryLog_Form_Reports::_getAction()

string HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_getAction()(string $actionSlug)

Retrieve displayable name of an action by its slug

• Visibility: private
• This method is static.

Arguments

• $actionSlug string - <p>All lower case action name from the database</p>

\HistoryLog_Form_Reports::_getValue()

string HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_getValue()(string $encodedValue, string $actionSlug)

Retrieve "value" parameter in user displayable form

• Visibility: private
• This method is static.

Arguments

• $encodedValue string - <p>The "value" parameter directly from the database</p>
• $actionSlug string - <p>the slug of the type of action associated with this value parameter</p>

\HistoryLog_Form_Reports::_getDate()

string HistoryLog_Form_Reports::\HistoryLog_Form_Reports::_getDate()(string $dateTime)

Format a date in standard form

• Visibility: private
• This method is static.

Arguments

• $dateTime string - <p>The unformatted dateTime</p>