Gentics Portal.Node PHP API
 All Classes Namespaces Functions Variables Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
HistoryModule Class Reference

Public Member Functions

 init ()
 save ($url, $title, $page_id, $collection_id=null)
 getCollectionId ()
 flushHistory ($collection_id=null)

Static Public Member Functions

static t ($str= '', $params=array(), $dic= 'core')

Public Attributes

 $cacheTime = 3600
 $autoSave = false

Detailed Description

Gentics Portal.Node PHP Author & Copyright (c) by Gentics Software GmbH sales.nosp@m.@gen.nosp@m.tics..nosp@m.com http://www.gentics.com Licenses can be found in the LICENSE.txt file in the root-folder of this installation You must not use this software without a valid license agreement.

HistoryModule This module allows user to remember pages he was visited

Interaction with module performs with one widget and one function Widget:

HistoryModule::save() function save specified page to user history HistoryModule::flushHistory() flush current user history

Definition at line 22 of file HistoryModule.php.

Member Function Documentation

HistoryModule::flushHistory (   $collection_id = null)

Flush(clear) user history

Parameters
string$collection_idid of collection which to flush. If empty then current user history will flushed
Returns
void

Definition at line 78 of file HistoryModule.php.

References VisitedHistory\flush().

{
VisitedHistory::flush($collection_id);
}
HistoryModule::getCollectionId ( )

Current collection id

Returns
string

Definition at line 67 of file HistoryModule.php.

References VisitedHistory\getCurrentCollectionId().

HistoryModule::save (   $url,
  $title,
  $page_id,
  $collection_id = null 
)

When this function invokes it saves specified page to user history

Returns
void
Author
Me

Definition at line 57 of file HistoryModule.php.

{
VisitedHistory::addItem($url, $title, $page_id, $collection_id);
}
static HistoryModule::t (   $str = '',
  $params = array(),
  $dic = 'core' 
)
static

Translates a message to the specified language.

Parameters
string$strmessage
array$paramsparams
string$dicdictionary
Returns
string

Definition at line 92 of file HistoryModule.php.

{
return Yii::t("HistoryModule." . $dic, $str, $params);
}

The documentation for this class was generated from the following file: