Kronolith_Calendars_Base
in package
The base functionality of the calendars handler.
See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
Tags
Table of Contents
- $_params : array<string|int, mixed>
- Additional parameters for the tasklist handling.
- $_shares : Horde_Share_Base
- The share backend.
- $_user : string
- The current user.
- __construct() : mixed
- Constructor.
- createDefaultShare() : Horde_Share_Object
- Create the default calendar share for the current user.
- getDefaultShare() : string
- Returns the default share's ID, if it can be determined from the share backend.
- setDefaultShare() : mixed
- Runs any actions after setting a new default tasklist.
- _getDefaultShareName() : string
- Return the name of the default share.
- _prepareDefaultShare() : mixed
- Add any modifiers required to the share in order to mark it as default
Properties
$_params
Additional parameters for the tasklist handling.
protected
array<string|int, mixed>
$_params
$_shares
The share backend.
protected
Horde_Share_Base
$_shares
$_user
The current user.
protected
string
$_user
Methods
__construct()
Constructor.
public
__construct(Horde_Share_Base $shares, string $user, array<string|int, mixed> $params) : mixed
Parameters
- $shares : Horde_Share_Base
-
The share backend.
- $user : string
-
The current user.
- $params : array<string|int, mixed>
-
Additional parameters.
Return values
mixed —createDefaultShare()
Create the default calendar share for the current user.
public
createDefaultShare() : Horde_Share_Object
Return values
Horde_Share_Object —The new default share.
getDefaultShare()
Returns the default share's ID, if it can be determined from the share backend.
public
getDefaultShare() : string
Return values
string —The default share ID.
setDefaultShare()
Runs any actions after setting a new default tasklist.
public
setDefaultShare(string $share) : mixed
Parameters
- $share : string
-
The default share ID.
Return values
mixed —_getDefaultShareName()
Return the name of the default share.
protected
abstract _getDefaultShareName() : string
Return values
string —The name of a default share.
_prepareDefaultShare()
Add any modifiers required to the share in order to mark it as default
protected
_prepareDefaultShare(Horde_Share_Object $share) : mixed
Parameters
- $share : Horde_Share_Object
-
The new default share.