Class Quform_Admin_Page

Direct known subclasses

Quform_Admin_Page_Dashboard, Quform_Admin_Page_Entries, Quform_Admin_Page_Forms_Add, Quform_Admin_Page_Forms_Edit, Quform_Admin_Page_Forms_List, Quform_Admin_Page_Help, Quform_Admin_Page_Preview, Quform_Admin_Page_Settings, Quform_Admin_Page_Tools

Indirect known subclasses

Quform_Admin_Page_Entries_Edit, Quform_Admin_Page_Entries_List, Quform_Admin_Page_Entries_View, Quform_Admin_Page_Tools_ExportEntries, Quform_Admin_Page_Tools_ExportForm, Quform_Admin_Page_Tools_Home, Quform_Admin_Page_Tools_ImportForm, Quform_Admin_Page_Tools_Migrate, Quform_Admin_Page_Tools_Uninstall

Abstract
Copyright: Copyright (c) 2009-2022 ThemeCatcher (https://www.themecatcher.net)
Located at Quform/Admin/Page.php

Methods summary
`public`	# `__construct( Quform_ViewFactory $viewFactory, Quform_Repository $repository )` Parameters `$viewFactory` `$repository`
`public`	# `bootstrap( )` Sets up the page and view Sets up the page and view Returns $this
`public`	# `init( )` Initialize this page Initialize this page Subclasses can override this method to add their own bootstrap functionality.
`public`	# `enqueueAssets( )` Enqueue the page assets Enqueue the page assets
`protected`	# `enqueueStyles( )` Enqueue the page styles Enqueue the page styles
`protected`	# `enqueueScripts( )` Enqueue the page scripts Enqueue the page scripts
`public`	# `process( )` Process this page Process this page Subclasses can override this method to add their own process functionality.
`protected string`	# `getAdminTitle( )` Subclasses can override this method to set a custom page title Subclasses can override this method to set a custom page title Returns string
`public string`	# `setAdminTitle( string $adminTitle )` Override the page title if the current page has a custom title Override the page title if the current page has a custom title Parameters `$adminTitle` The current admin title Returns string The new admin title
`public string`	# `display( )` Renders this page's view Renders this page's view Returns string
`public`	# `addMessage( string\|array $type, string $message = '' )` Add a notification message Add a notification message Parameters `$type` Type of message e.g. 'error' or 'success' `$message` The message content Returns $this
`public array`	# `getMessages( )` Get the notification messages for this page Get the notification messages for this page Returns array
`public string`	# `getMessagesHtml( )` Get the HTML for the page messages Get the HTML for the page messages Returns string
`public string`	# `getNavHtml( array $currentForm = null, array $extra = array() )` Get the HTML for the admin navigation menu Get the HTML for the admin navigation menu Parameters `$currentForm` The data for the current form (if any) `$extra` Extra HTML to add to the nav, the array key is the hook position Returns string
`protected string`	# `getFormSwitcherItemHtml( array $form, boolean $highlight = false )` Get the HTML for a single form list item in the form switcher Get the HTML for a single form list item in the form switcher Parameters `$form` The form config `$highlight` Whether to highlight the item Returns string
`protected string`	# `getExtraHtml( integer $index, array $extra )` Get extra HTML for the nav and call hooks Get extra HTML for the nav and call hooks Parameters `$index` `$extra` Returns string

Constants summary
`integer`	`BAD_REQUEST`	# `1`
`integer`	`NO_PERMISSION`	# `2`
`integer`	`NONCE_CHECK_FAILED`	# `3`

Properties summary
`protected string`	`$template` The path to the view template The path to the view template	#
`protected Quform_View`	`$view` The view instance for this page The view instance for this page	#
`protected Quform_ViewFactory`	`$viewFactory`	#
`protected array`	`$messages` Notification messages to be displayed Notification messages to be displayed	# `array()`
`protected Quform_Repository`	`$repository`	#