Documentation

Calendar
in package
implements ActionInterface Uses BackwardCompatibility

This class allows you to manage the calendar.

Table of Contents

Interfaces

ActionInterface
Interface for all action classes.

Properties

$subaction  : string
$subactions  : array<string|int, mixed>
$obj  : object
$backcompat  : array<string|int, mixed>

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
edit()  : void
This method is used for adding/editing a specific holiday.
editHoliday()  : void
Backward compatibility wrapper for the editholiday sub-action.
execute()  : void
Dispatcher to whichever sub-action method is necessary.
exportStatic()  : void
Provides a way to export a class's public static properties and methods to global namespace.
getConfigVars()  : array<string|int, mixed>
Gets the configuration variables for this admin area.
holidays()  : void
The method that handles adding and deleting holiday data.
load()  : object
Static wrapper for constructor.
modifyCalendarSettings()  : void|array<string|int, mixed>
Backward compatibility wrapper for the settings sub-action.
modifyHolidays()  : void
Backward compatibility wrapper for the holidays sub-action.
settings()  : void
Handles showing and changing calendar settings.
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().

Properties

$subaction

public string $subaction = 'holidays'

The requested sub-action. This should be set by the constructor.

$subactions

public static array<string|int, mixed> $subactions = ['holidays' => 'holidays', 'editholiday' => 'edit', 'settings' => 'settings']

Available sub-actions.

$obj

protected static object $obj

An instance of this class. This is used by the load() method to prevent mulitple instantiations.

$backcompat

private static array<string|int, mixed> $backcompat = ['func_names' => ['call' => 'ManageCalendar', 'modifyHolidays' => 'ModifyHolidays', 'editHoliday' => 'EditHoliday']]

BackwardCompatibility settings for this class.

Methods

call()

Convenience method to load() and execute() an instance of this class.

public static call() : void

edit()

This method is used for adding/editing a specific holiday.

public edit() : void

editHoliday()

Backward compatibility wrapper for the editholiday sub-action.

public static editHoliday() : void

execute()

Dispatcher to whichever sub-action method is necessary.

public execute() : void

exportStatic()

Provides a way to export a class's public static properties and methods to global namespace.

public static exportStatic() : void

To do so:

  1. Use this trait in the class.
  2. At the END of the class's file, call its exportStatic() method.

Although it might not seem that way at first glance, this approach conforms to section 2.3 of PSR 1, since executing this method is simply a dynamic means of declaring functions when the file is included; it has no other side effects.

Regarding the $backcompat items:

A class's static properties are not exported to global variables unless explicitly included in $backcompat['prop_names']. Likewise, a class's static methods are not exported as global functions unless explicitly included in $backcompat['func_names'].

$backcompat['prop_names'] is a simple array where the keys are the names of one or more of a class's static properties, and the values are the names of global variables. In each case, the global variable will be set to a reference to the static property. Static properties that are not named in this array will not be exported.

$backcompat['func_names'] is a simple array where the keys are the names of one or more of a class's static methods, and the values are the names that should be used for global functions that will encapsulate those methods. Methods that are not named in this array will not be exported.

Adding non-static properties or methods to the $backcompat arrays will produce runtime errors. It is the responsibility of the developer to make sure not to do this.

getConfigVars()

Gets the configuration variables for this admin area.

public static getConfigVars() : array<string|int, mixed>
Return values
array<string|int, mixed> —

$config_vars for the calendar area.

holidays()

The method that handles adding and deleting holiday data.

public holidays() : void

load()

Static wrapper for constructor.

public static load() : object
Return values
object —

An instance of this class.

modifyCalendarSettings()

Backward compatibility wrapper for the settings sub-action.

public modifyCalendarSettings([bool $return_config = false ]) : void|array<string|int, mixed>
Parameters
$return_config : bool = false

Whether to return the $config_vars array (used for admin search)

Return values
void|array<string|int, mixed> —

Returns nothing or returns $config_vars if $return_config is true

modifyHolidays()

Backward compatibility wrapper for the holidays sub-action.

public static modifyHolidays() : void

settings()

Handles showing and changing calendar settings.

public settings() : void

__construct()

Constructor. Protected to force instantiation via self::load().

protected __construct() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results