class PageApiAction

Constants

API_ACTION_PAGE_DUPLICATE

API_ACTION_PAGE_DELETE

API_ACTION_PAGE_DELETE_REQUEST

API_ACTION_PAGE_DELETE_PERMISSION

API_ACTION_PAGE_MOVE_IN_NAVIGATION

API_ACTION_PAGES_LIST

API_ACTION_PAGE_UNPUBLISH

API_ACTION_PAGE_TOGGLE_VISIBILITY

API_ACTION_PAGEVERSION_PUBLISH

API_ACTION_PAGEVERSION_PUBLISH_REQUEST

API_ACTION_PAGEVERSION_DELETE_DRAFT

API_ACTION_PAGEVERSION_CANCEL_PUBLISH_REQUEST

API_ACTION_PAGEVERSION_TRANSLATE

API_ACTION_PAGE_LIST_TEMPLATES

API_ACTION_RENDER_PORTLET

Properties

PagesController $mod

Methods

void
apiActionResponse(bool $success = true, string $redirectURL = null, string $message = null)

No description

void
apiActionToggleVisibility(Page $page, bool $hidden = null)

Toggles the hidden flag for the passed page

array
getApiActionsForPage(Page $page)

Get action URLs for a specific PageModel respecting the status of the page and the role of the currently interacting user

array
getApiActionsForPageVersion(PageVersion $pageVersion)

No description

void
handleAPICallsForPage(Page $page, PageVersion|null $pageVersion = null, array $validActions = null)

No description

Details

at line 650
void apiActionResponse(bool $success = true, string $redirectURL = null, string $message = null)

No description

Parameters

bool $success
string $redirectURL
string $message

Return Value

void

at line 671
void apiActionToggleVisibility(Page $page, bool $hidden = null)

Toggles the hidden flag for the passed page

Parameters

Page $page
bool $hidden

Return Value

void

at line 165
array getApiActionsForPage(Page $page)

Get action URLs for a specific PageModel respecting the status of the page and the role of the currently interacting user

Parameters

Page $page

Return Value

array

at line 254
array getApiActionsForPageVersion(PageVersion $pageVersion)

No description

Parameters

PageVersion $pageVersion

Return Value

array

at line 59
void handleAPICallsForPage(Page $page, PageVersion|null $pageVersion = null, array $validActions = null)

No description

Parameters

Page $page
PageVersion|null $pageVersion
array $validActions

Specify valid actions from your endpoint

Return Value

void

Exceptions

AuditException