• Home
  • Kronolith_Calendar_Resource

PHP Class Kronolith_Calendar_Resource, 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
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_resource Kronolith_Resource_Single The share of this calendar.

Public Methods

Method Description
__construct ( array $params = [] ) Constructor.
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.
owner ( ) : string Returns the owner of this calendar.
toHash ( ) : array Returns a hash representing 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.

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.

owner() public method

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

toHash() public method

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

Property Details

$_resource protected property

The share of this calendar.
protected Kronolith_Resource_Single $_resource
return Kronolith_Resource_Single