Class Kronolith_Calendar
Kronolith_Calendar defines an API for single calendars.
Copyright 2010-2012 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.
Methods summary
public
|
#
__construct( array $params = array() )
Constructor.
Parameters
- $params
- <p>A hash with any parameters that this calendar
might need.</p>
|
public
string
|
#
owner( )
Returns the owner of this calendar.
Returns the owner of this calendar.
Returns
string
This calendar's owner.
|
abstract public
string
|
#
name( )
Returns the name of this calendar.
Returns the name of this calendar.
Returns
string
This calendar's name.
|
public
string
|
#
description( )
Returns the description of this calendar.
Returns the description of this calendar.
Returns
string
This calendar's description.
|
public
string
|
#
background( )
Returns the background color for this calendar.
Returns the background color for this calendar.
Returns
string
A HTML color code.
|
public
string
|
#
foreground( )
Returns the foreground color for this calendar.
Returns the foreground color for this calendar.
Returns
string
A HTML color code.
|
public
string
|
#
css( boolean $with_attribute = true )
Returns the CSS color definition for this calendar.
Returns the CSS color definition for this calendar.
Parameters
- $with_attribute
- <p>Whether to wrap the colors inside a
"style" attribute.</p>
Returns
string
A CSS string with color definitions.
|
public
boolean
|
#
hasPermission( integer $permission, string $user = null, string $creator = null )
Encapsulates permissions checking.
Encapsulates permissions checking.
Parameters
- $permission
- The permission to check for.
- $user
- <p>The user to check permissions for. Defaults
to the current user.</p>
- $creator
- <p>An event creator, to check for creator
permissions.</p>
Returns
boolean
Whether the user has the permission on this calendar.
|
abstract public
boolean
|
#
display( )
Whether this calendar is supposed to be displayed in lists.
Whether this calendar is supposed to be displayed in lists.
Returns
boolean
True if this calendar should be displayed.
|
public
array
|
#
toHash( )
Returns a hash representing this calendar.
Returns a hash representing this calendar.
Returns
array
A simple hash.
|