PHP Класс Mnemo_Notepads_Base, horde

Copyright 2001-2016 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.
См. ссылку: http://www.horde.org/apps/mnemo
Автор: Jon Parise ([email protected])
Автор: Gunnar Wrobel ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_params array Additional parameters for the notepad handling.
$_shares Horde_Share_Base The share backend.
$_user string The current user.

Открытые методы

Метод Описание
__construct ( Horde_Share_Base $shares, string $user, array $params ) 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 ( string $share ) Runs any actions after setting a new default tasklist.

Защищенные методы

Метод Описание
_getDefaultShareName ( ) : string Return the name of the default share.
_prepareDefaultShare ( Horde_Share_Object $share ) Add any modifiers required to the share in order to mark it as default.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( Horde_Share_Base $shares, string $user, array $params )
$shares Horde_Share_Base The share backend.
$user string The current user.
$params array Additional parameters.

_getDefaultShareName() абстрактный защищенный Метод

Return the name of the default share.
abstract protected _getDefaultShareName ( ) : string
Результат 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 )
$share Horde_Share_Object The new default share.

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
Результат 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
Результат string The default share ID.

setDefaultShare() публичный Метод

Runs any actions after setting a new default tasklist.
public setDefaultShare ( string $share )
$share string The default share ID.

Описание свойств

$_params защищенное свойство

Additional parameters for the notepad handling.
protected array $_params
Результат array

$_shares защищенное свойство

The share backend.
protected Horde_Share_Base $_shares
Результат Horde_Share_Base

$_user защищенное свойство

The current user.
protected string $_user
Результат string