Documentation TYPO3 par Ameos

mod_user_task Class Reference

Inheritance diagram for mod_user_task:
[legend]
Collaboration diagram for mod_user_task:
[legend]
List of all members.

Public Member Functions

 JScode ()
 sendEmail ($recipient, $subject, $message)
 mod_user_task_init ($BE_USER)
 helpBubble ()
 headLink ($key, $dontLink=false, $params= '')
 fixed_lgd ($str, $len=0)
 errorIcon ()
 getUserAndGroupArrays ()
 dateTimeAge ($tstamp, $prefix=1)
 accessMod ($mod)
 mkMenuConfig ($htmlContent, $label="", $content="", $popUpDescription= '')
 urlInIframe ($url, $max=0)

Public Attributes

 $getUserNamesFields = 'username,usergroup,usergroup_cached_list,uid,realName,email'
 $userGroupArray = array()
 $perms_clause = ''
 $backPath
 $BE_USER

Detailed Description

Module class for task module

Author:
Kasper Skrhj <kasperYYYY@typo3.com>

Christian Jul Jensen <christian(at)jul(dot)net> Revision for TYPO3 3.8.0 / Native Workflow System

Definition at line 37 of file class.mod_user_task.php.


Member Function Documentation

mod_user_task::sendEmail ( recipient,
subject,
message 
)

Send an email...

Parameters:
string $email: the email address to send to
string $subject: the subject of the emil
string $message: the message body of the email
Returns:
void

Definition at line 57 of file class.mod_user_task.php.

References t3lib_div::getIndpEnv(), and t3lib_div::makeInstance().

mod_user_task::mod_user_task_init ( BE_USER  ) 

Initialise the object

Parameters:
object $BE_USER: instance of t3lib_beuserauth representing the current be user.
Returns:
void

Definition at line 84 of file class.mod_user_task.php.

References $BE_USER.

mod_user_task::helpBubble (  ) 

Return helpbubble image

Returns:
string image tag (HTML)

Definition at line 94 of file class.mod_user_task.php.

mod_user_task::headLink ( key,
dontLink = false,
params = '' 
)

Create a link to the module with the name of the module as link text.

Parameters:
string $key: the classname of the module
bool $dontLink: Just return the name of the module without a link.
stting $params: HTTP GET parameter string to add to the link (not used if dontLink true)
Returns:
string link (HTML) / name of module (regular string)

Definition at line 107 of file class.mod_user_task.php.

Referenced by tx_sysaction::overview_main(), and tx_impexp_modfunc1::overview_main().

mod_user_task::fixed_lgd ( str,
len = 0 
)

Return a string cropped to a fixed length according to system setting or parameter

Parameters:
string $str: string to be cropped.
int $len: length of the cropped string, system settings is used if none is given
Returns:
string cropped string

Definition at line 120 of file class.mod_user_task.php.

References t3lib_div::fixed_lgd().

Referenced by tx_sysaction::renderActionList().

mod_user_task::errorIcon (  ) 

Return an error icon

Returns:
string Image tag (HTML)

Definition at line 129 of file class.mod_user_task.php.

mod_user_task::getUserAndGroupArrays (  ) 

[Describe function...]

Returns:
array ...

Definition at line 138 of file class.mod_user_task.php.

References t3lib_BEfunc::blindUserNames(), t3lib_BEfunc::getListGroupNames(), and t3lib_BEfunc::getUserNames().

mod_user_task::dateTimeAge ( tstamp,
prefix = 1 
)

[Describe function...]

Parameters:
[type] $tstamp: ...
[type] $prefix: ...
Returns:
[type] ...

Definition at line 157 of file class.mod_user_task.php.

References t3lib_BEfunc::dateTimeAge().

mod_user_task::accessMod ( mod  ) 

[Describe function...]

Parameters:
[type] $mod: ...
Returns:
[type] ...

Definition at line 167 of file class.mod_user_task.php.

mod_user_task::mkMenuConfig ( htmlContent,
label = "",
content = "",
popUpDescription = '' 
)

Create configuration for entry in the left tab menu.

Parameters:
string $htmlContent: Content that does not get escaped, use this for icons links etc. (HTML)
string $label: bTitle of the tab, escaped for HTML, dispalyed after html content.
string $content: html content that gets displayed when the tab is activated. (HTML)
string $popUpDescription: alt-text for the tab text
Returns:
array proper configuration for the tab menu.

Definition at line 180 of file class.mod_user_task.php.

Referenced by tx_sysaction::overview_main(), and tx_impexp_modfunc1::overview_main().

mod_user_task::urlInIframe ( url,
max = 0 
)

Returns HTML code to dislay an url in an iframe with the right side of the taskcenter

Parameters:
string $url: url to display
[type] $max: ...
Returns:
string code that inserts the iframe (HTML)

Definition at line 196 of file class.mod_user_task.php.

Referenced by tx_impexp_modfunc1::main(), and tx_sysaction::renderActions().


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


Gnr par Les experts TYPO3 avec  doxygen 1.4.6