PHP Class 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.
Author: Jan Schneider ([email protected])
Afficher le fichier Open project: horde/horde Class Usage Examples

Méthodes publiques

Méthode Description
__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.

Méthodes protégées

Méthode Description
_caldavUrl ( string $id, string $interface ) : string Returns the CalDAV URL for a calendar or task list.

Method Details

__construct() public méthode

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

_caldavUrl() protected méthode

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.
Résultat string The collection's CalDAV URL.

background() public méthode

Returns the background color for this calendar.
public background ( ) : string
Résultat string A HTML color code.

caldavUrl() public méthode

Returns the CalDAV URL to this calendar.
public caldavUrl ( ) : string
Résultat string This calendar's CalDAV URL.

css() public méthode

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.
Résultat string A CSS string with color definitions.

description() public méthode

Returns the description of this calendar.
public description ( ) : string
Résultat string This calendar's description.

display() abstract public méthode

Whether this calendar is supposed to be displayed in lists.
abstract public display ( ) : boolean
Résultat boolean True if this calendar should be displayed.

foreground() public méthode

Returns the foreground color for this calendar.
public foreground ( ) : string
Résultat string A HTML color code.

hasPermission() public méthode

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.
Résultat boolean Whether the user has the permission on this calendar.

name() abstract public méthode

Returns the name of this calendar.
abstract public name ( ) : string
Résultat string This calendar's name.

owner() public méthode

Returns the owner of this calendar.
public owner ( ) : string
Résultat string This calendar's owner.

toHash() public méthode

Returns a hash representing this calendar.
public toHash ( ) : array
Résultat array A simple hash.