Documentation

Boards
in package
implements ActionInterface uses ActionTrait, BackwardCompatibility

Manages and maintains the boards and categories of the forum.

Table of Contents

Interfaces

ActionInterface
Interface for all action classes.

Properties

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

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
canBeLogged()  : bool
Determines whether this action can be logged in the online log.
canShowDebuggingInfo()  : bool
Determines whether debugging info should be shown.
canShowInMaintenanceMode()  : bool
Determines whether this action allows access in maintenance mode.
editBoard()  : void
Modify a specific board... screen for editing and repositioning a board.
editBoard2()  : void
Make changes to/delete a board.
editCategory()  : void
Modify a specific category.
editCategory2()  : void
Function for handling a submitted form saving the category.
execute()  : void
Dispatcher to whichever sub-action method is necessary.
getConfigVars()  : array<string|int, mixed>
Gets the configuration variables for this admin area.
getOutputType()  : OutputTypeInterface
Gets the output type for this action.
isAgreementAction()  : bool
Determines whether this action can be accessed without accepting the registration agreement and privacy policy.
isRestrictedGuestAccessAllowed()  : bool
Determines whether this action allows access if guest access is restricted.
isSimpleAction()  : bool
Determines whether this is a simple action.
load()  : static
Static wrapper for constructor.
main()  : void
The main control panel thing, the screen showing all boards and categories.
modifyCat()  : void
Used to retrieve data for modifying a board category.
settings()  : void
A screen to set a few general board and category settings.
subActionProvider()  : null|array<string|int, mixed>
Called by Subs-Compat.php BackwardCompatibility wrapper functions to provide subaction execution for existing mods
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().

Properties

$subaction

public string $subaction = 'main'

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

$subactions

public static array<string|int, mixed> $subactions = ['main' => ['main', 'manage_boards'], 'board' => ['editBoard', 'manage_boards'], 'board2' => ['editBoard2', 'manage_boards'], 'cat' => ['editCategory', 'manage_boards'], 'cat2' => ['editCategory2', 'manage_boards'], 'move' => ['main', 'manage_boards'], 'newcat' => ['editCategory', 'manage_boards'], 'newboard' => ['editBoard', 'manage_boards'], 'settings' => ['settings', 'admin_forum']]

Available sub-actions.

Format: 'sub-action' => array('function', 'permission')

$obj

protected static static $obj

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

Methods

call()

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

public static call() : void

canBeLogged()

Determines whether this action can be logged in the online log.

public canBeLogged() : bool
Return values
bool

canShowDebuggingInfo()

Determines whether debugging info should be shown.

public canShowDebuggingInfo() : bool
Return values
bool

canShowInMaintenanceMode()

Determines whether this action allows access in maintenance mode.

public canShowInMaintenanceMode() : bool
Return values
bool —

True if access is allowed, false otherwise.

editBoard()

Modify a specific board... screen for editing and repositioning a board.

public editBoard() : void

called by ?action=admin;area=manageboards;sa=board uses the modify_board sub-template of the ManageBoards template. requires manage_boards permission. also used to show the confirm deletion of category screen (sub-template confirm_board_delete).

editBoard2()

Make changes to/delete a board.

public editBoard2() : void

(function for handling a submitted form saving the board.)

It also handles deletion of a board.

Called by ?action=admin;area=manageboards;sa=board2 Redirects to ?action=admin;area=manageboards. It requires manage_boards permission.

editCategory()

Modify a specific category.

public editCategory() : void

(screen for editing and repositioning a category.)

Also used to show the confirm deletion of category screen (sub-template confirm_category_delete).

Called by ?action=admin;area=manageboards;sa=cat Requires manage_boards permission.

Tags
uses
template_modify_category()

editCategory2()

Function for handling a submitted form saving the category.

public editCategory2() : void

(complete the modifications to a specific category.)

It also handles deletion of a category.

It requires manage_boards permission. Called by ?action=admin;area=manageboards;sa=cat2 Redirects to ?action=admin;area=manageboards.

execute()

Dispatcher to whichever sub-action method is necessary.

public execute() : void

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 boards area.

isAgreementAction()

Determines whether this action can be accessed without accepting the registration agreement and privacy policy.

public isAgreementAction() : bool
Return values
bool

isRestrictedGuestAccessAllowed()

Determines whether this action allows access if guest access is restricted.

public isRestrictedGuestAccessAllowed() : bool
Return values
bool —

True if access is allowed, false otherwise.

isSimpleAction()

Determines whether this is a simple action.

public isSimpleAction() : bool
Return values
bool

load()

Static wrapper for constructor.

public static load() : static
Return values
static —

An instance of this class.

main()

The main control panel thing, the screen showing all boards and categories.

public main() : void

Called by ?action=admin;area=manageboards or ?action=admin;area=manageboards;sa=move. Requires manage_boards permission. It also handles the interface for moving boards.

Uses ManageBoards template, main sub-template.

modifyCat()

Used to retrieve data for modifying a board category.

public static modifyCat() : void

settings()

A screen to set a few general board and category settings.

public settings() : void

subActionProvider()

Called by Subs-Compat.php BackwardCompatibility wrapper functions to provide subaction execution for existing mods

public static subActionProvider([null|string $sa = null ][, bool $return_config = false ][, string|null $activity = null ]) : null|array<string|int, mixed>
Parameters
$sa : null|string = null
$return_config : bool = false
$activity : string|null = null
Return values
null|array<string|int, mixed>

__construct()

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

protected __construct() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results