PHP Класс Kronolith_Calendar, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
Автор: Jan Schneider ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
__construct ( array $params = [] ) Constructor.
background ( ) : string Returns the background color for this calendar.
caldavUrl ( ) : string Returns the CalDAV URL to this calendar.
css ( boolean $with_attribute = true ) : string Returns the CSS color definition for this calendar.
description ( ) : string Returns the description of this calendar.
display ( ) : boolean Whether this calendar is supposed to be displayed in lists.
foreground ( ) : string Returns the foreground color for this calendar.
hasPermission ( integer $permission, string $user = null, string $creator = null ) : boolean Encapsulates permissions checking.
name ( ) : string Returns the name of this calendar.
owner ( ) : string Returns the owner of this calendar.
toHash ( ) : array Returns a hash representing this calendar.

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

Метод Описание
_caldavUrl ( string $id, string $interface ) : string Returns the CalDAV URL for a calendar or task list.

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

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

Constructor.
public __construct ( array $params = [] )
$params array A hash with any parameters that this calendar might need.

_caldavUrl() защищенный Метод

Returns the CalDAV URL for a calendar or task list.
protected _caldavUrl ( string $id, string $interface ) : string
$id string A collection ID.
$interface string The collection's application.
Результат string The collection's CalDAV URL.

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

Returns the background color for this calendar.
public background ( ) : string
Результат string A HTML color code.

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

Returns the CalDAV URL to this calendar.
public caldavUrl ( ) : string
Результат string This calendar's CalDAV URL.

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

Returns the CSS color definition for this calendar.
public css ( boolean $with_attribute = true ) : string
$with_attribute boolean Whether to wrap the colors inside a "style" attribute.
Результат string A CSS string with color definitions.

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

Returns the description of this calendar.
public description ( ) : string
Результат string This calendar's description.

display() абстрактный публичный Метод

Whether this calendar is supposed to be displayed in lists.
abstract public display ( ) : boolean
Результат boolean True if this calendar should be displayed.

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

Returns the foreground color for this calendar.
public foreground ( ) : string
Результат string A HTML color code.

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

Encapsulates permissions checking.
public hasPermission ( integer $permission, string $user = null, string $creator = null ) : boolean
$permission integer The permission to check for.
$user string The user to check permissions for. Defaults to the current user.
$creator string An event creator, to check for creator permissions.
Результат boolean Whether the user has the permission on this calendar.

name() абстрактный публичный Метод

Returns the name of this calendar.
abstract public name ( ) : string
Результат string This calendar's name.

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

Returns the owner of this calendar.
public owner ( ) : string
Результат string This calendar's owner.

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

Returns a hash representing this calendar.
public toHash ( ) : array
Результат array A simple hash.