Package DE_EPAGES::Presentation::API::History
Implements helper functions for the event history and favorites. Use the TLE function DE_EPAGES::Presentation::API::TLE::HistoryHandler::SaveHistory to add new history entries from within a template. Use the ChangeAction CopyHistoryToFavorite to convert a history entry to a favorite.
@EXPORT_OK |
Functions
GetFavorites
Returns the list of favorites of the user. If the user currently has more than $MaxEntries favorites, then the oldest entries are deleted until the number of favorites is $MaxEntries.
Syntax |
$ahFavorites = GetFavorites($UserID); $ahFavorites = GetFavorites($UserID, $MaxEntries); |
Input |
|
Return |
|
GetHistory
Returns objects of EventHistory by alternate key SessionID. Deletes old history events if the number is larger than $MaxEntries.
Syntax |
$ahEvents = GetHistory($SessionID, $MaxEntries); |
Input |
|
Return |
|
InsertHistory
Creates an entry of EventHistory.
Syntax |
$EventHistoryID = InsertHistory($hEventHistory); |
Input |
|
Return |
|
ReplaceHistory
Replaces EventFavorite and EventHistory of old object with entries of new object. This function replaces only the object id in the URI (no names or path infos).
Syntax |
ReplaceHistory($OldObject, $NewObject); |
Input |
|