JsonCalendarController
extends Controller
in package
implements
JsonAdapter
JSON Adapter for Calendar module
Tags
Table of Contents
Interfaces
- JsonAdapter
- JSON Adapter for JSON requests
Properties
Methods
- __call() : mixed
- Route methods like getName(), getType(), getDirectory(), etc.
- __construct() : mixed
- Creates new controller
- getAccessableMethods() : array<string|int, mixed>
- Returns an array of method names accessable from a JSON request
- getDefaultPermissions() : object
- Returns default permission as object
- getExceptionDates() : array<string|int, mixed>
- Returns all series dates from the given post data
- getMessagesAsString() : string
- Returns all messages as string
- getName() : string
- Returns the internal name used as identifier for this adapter
- getRecipientCount() : int
- Get the count of the selected recipients of a event invitation
- getSystemComponentController() : SystemComponentController
- Returns the main controller
- toggleStatus() : void
- Toggles the status of an entity
Properties
$cx
Main class instance
protected
Cx
$cx
= null
$messages
List of messages
private
array<string|int, mixed>
$messages
= array()
Methods
__call()
Route methods like getName(), getType(), getDirectory(), etc.
public
__call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
- $methodName : string
-
Name of method to call
- $arguments : array<string|int, mixed>
-
List of arguments for the method to call
Attributes
- #[ReturnTypeWillChange]
Return values
mixed —Return value of the method to call
__construct()
Creates new controller
public
__construct(SystemComponentController $systemComponentController, Cx $cx) : mixed
Parameters
- $systemComponentController : SystemComponentController
-
Main controller for this system component
- $cx : Cx
-
Main class instance
getAccessableMethods()
Returns an array of method names accessable from a JSON request
public
getAccessableMethods() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of method names
getDefaultPermissions()
Returns default permission as object
public
getDefaultPermissions() : object
Return values
objectgetExceptionDates()
Returns all series dates from the given post data
public
getExceptionDates() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of dates
getMessagesAsString()
Returns all messages as string
public
getMessagesAsString() : string
Return values
string —HTML encoded error messages
getName()
Returns the internal name used as identifier for this adapter
public
getName() : string
Return values
string —Name of this adapter
getRecipientCount()
Get the count of the selected recipients of a event invitation
public
getRecipientCount([array<string|int, mixed> $params = array() ]) : int
Parameters
- $params : array<string|int, mixed> = array()
-
List of get and post parameters which were sent to the json adapter.
Return values
int —The count of the recipients
getSystemComponentController()
Returns the main controller
public
getSystemComponentController() : SystemComponentController
Return values
SystemComponentController —Main controller for this system component
toggleStatus()
Toggles the status of an entity
public
toggleStatus(array<string|int, mixed> $params) : void
This expects GET params "id" for the entity's ID and "type" for the entity type to be set. Currently only the type "event" is supported.
Parameters
- $params : array<string|int, mixed>
-
JsonAdapter params.