• Inicio
  • Kronolith_Calendar_Remote

PHP Class Kronolith_Calendar_Remote, 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])
Inheritance: extends Kronolith_Calendar
Mostrar archivo Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_color string The color of this calendar.
$_desc string The description of this calendar.
$_name string The name of this calendar.
$_password string The HTTP password for this calendar.
$_url string The URL of this calendar.
$_user string The HTTP user name for this calendar.

Public Methods

Method Description
__construct ( array $params = [] ) Constructor.
background ( ) : string Returns the background color for this calendar.
credentials ( ) : array Returns the authentication credentials for this calendar.
description ( ) : string Returns the description of this calendar.
display ( ) : boolean Whether this calendar is supposed to be displayed in lists.
hasPermission ( integer $permission, string $user = null, string $creator = null ) : boolean Encapsulates permissions checking.
name ( ) : string Returns the name of this calendar.
toHash ( ) : array Returns a hash representing this calendar.
url ( ) : string Returns the URL of this calendar.

Method Details

__construct() public method

Constructor.
public __construct ( array $params = [] )
$params array A hash with any parameters that this calendar might need. Required parameters: - share: The share of this calendar.

background() public method

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

credentials() public method

Returns the authentication credentials for this calendar.
public credentials ( ) : array
return array This calendar's credentials.

description() public method

Returns the description of this calendar.
public description ( ) : string
return string This calendar's description.

display() public method

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

hasPermission() public method

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

name() public method

Returns the name of this calendar.
public name ( ) : string
return string This calendar's name.

toHash() public method

Returns a hash representing this calendar.
public toHash ( ) : array
return array A simple hash.

url() public method

Returns the URL of this calendar.
public url ( ) : string
return string This calendar's URL.

Property Details

$_color protected_oe property

The color of this calendar.
protected string $_color
return string

$_desc protected_oe property

The description of this calendar.
protected string $_desc
return string

$_name protected_oe property

The name of this calendar.
protected string $_name
return string

$_password protected_oe property

The HTTP password for this calendar.
protected string $_password
return string

$_url protected_oe property

The URL of this calendar.
protected string $_url
return string

$_user protected_oe property

The HTTP user name for this calendar.
protected string $_user
return string