Documentation

Mnemo_Notepads_Base
in package

The base functionality of the notepads handler.

Copyright 2001-2017 Horde LLC (http://www.horde.org/)

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

Tags
category

Horde

author

Jon Parise jon@horde.org

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/apache

link
http://www.horde.org/apps/mnemo

Table of Contents

$_params  : array<string|int, mixed>
Additional parameters for the notepad handling.
$_shares  : Horde_Share_Base
The share backend.
$_user  : string
The current user.
__construct()  : mixed
Constructor.
ensureDefaultShare()  : string|null
Ensure the share system has a default notepad share for the current user if the default share feature is activated.
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 notepad 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

ensureDefaultShare()

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

public ensureDefaultShare() : string|null
Return values
string|null

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

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.

Return values
mixed

Search results