API Documentation
\
Nag
Backup

\Nag_Tasklists_Default

The default tasklists handler.

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Summary

Methods
Properties
Constants
__construct()
ensureDefaultShare()
getDefaultShare()
setDefaultShare()
No public properties found
No constants found
_getDefaultShareName()
_prepareDefaultShare()
$_shares
$_user
$_params
N/A
No private methods found
$_identity
N/A

Properties

$_shares

$_shares : \Horde_Share_Base

The share backend.

Type

\Horde_Share_Base

$_user

$_user : string

The current user.

Type

string

$_params

$_params : array

Additional parameters for the tasklist handling.

Type

array

$_identity

$_identity : \Horde_Prefs_Identity

The current identity.

Type

\Horde_Prefs_Identity

Methods

__construct()

__construct(\Horde_Share_Base  $shares, string  $user, array  $params)

Constructor.

Parameters

\Horde_Share_Base $shares

The share backend.
string $user

The current user.
array $params

Additional parameters.

ensureDefaultShare()

ensureDefaultShare() : string|NULL

Ensure the share system has a default tasklist share for the current user if the default share feature is activated.

Returns

string|NULL —

The id of the new default share or NULL if no share was created.

getDefaultShare()

getDefaultShare() : string

Returns the default share's ID, if it can be determined from the share backend.

Returns

string —

The default share ID.

setDefaultShare()

setDefaultShare(string  $share)

Runs any actions after setting a new default tasklist.

Parameters

string $share

The default share ID.

_getDefaultShareName()

_getDefaultShareName() : string

Return the name of the default share.

Returns

string —

The name of a default share.

_prepareDefaultShare()

_prepareDefaultShare(\Horde_Share_Object  $share)

Add any modifiers required to the share in order to mark it as default.

Parameters

\Horde_Share_Object $share

The new default share.