API Documentation for: 1.1.1
Show:

AdminPageController Class

Extends AdminObjectController
Namespace: Canteen\Controllers

Controller to manage the page management form. Located in the namespace Canteen\Controllers.

Methods

addData

(
  • name
  • value
)

Inherited from Controller:

Add a data substitution variable

Parameters:

  • name String | Dictionary | Object

    The name of the data variable or an array of (name=>value, name=>value)

  • value Mixed

    The string of the value (optional if setting one data property)

addElement

(
  • element
)
protected

Inherited from AdminObjectController:

Add a custom form element

Parameters:

addNotice

(
  • message
)
protected

Inherited from AdminObjectController:

Add a notice to the buffer output

Parameters:

  • message String

    The message to output

addTemplate

(
  • template
  • [data=[]
)
protected

Inherited from AdminController:

Add the admin page by template, if there is no template use the default prerender() method

Parameters:

  • template String

    The template name

  • [data=[] Dictionary optional

    The optional substitution variables

addTitle

(
  • title
  • [separator=.]
)

Inherited from Controller:

Prepend to the page title

Parameters:

  • title String

    The title string to prepend

  • [separator=.] String optional

    The title separator, default is a period

getContents

() String private

Get the page contents from the path

Returns:

String:

The string for the page

getData

() Dictionary

Inherited from Controller:

Get the data variables

Returns:

Dictionary:

Data variables for substitution

getPage

() Page

Inherited from Controller

Get the current page object, this is an override before returning the page, we render the navigation

Returns:

Page:

The updated page object

getPageOptions

(
  • [selectId=null]
  • [ignoreId=null]
  • [showProtected=true]
  • initOption
)
String private

Get the users as options

Parameters:

  • [selectId=null] Int optional

    Select this optional page ID

  • [ignoreId=null] Int optional

    Ignore optional page ID

  • [showProtected=true] Boolean optional

    If we should show the error pages in the options

  • initOption String

    The initial zero option

Returns:

String:

The html options for the select element

ignoreFields

(
  • fields
)

Inherited from AdminObjectController:

Ignore field names

Parameters:

  • fields String multiple

    The field name as separate arguments

onElementAdd

(
  • event
)

Modify existing elements beign added

Parameters:

onElementAdded

(
  • event
)

When an element is added, inject the content

Parameters:

onStart

(
  • event
)

Do some setup before we start adding anything

Parameters:

onStartElements

(
  • event
)

Before any elements are added

Parameters:

optionalFields

(
  • fields
)

Inherited from AdminObjectController:

Don't add the required class to these fields

Parameters:

  • fields String multiple

    The field name as separate arguments

parse

(
  • content
  • substitutions
)
String protected

Inherited from CanteenBase

Convenience method for parsing content

Parameters:

  • content String

    The string to parse

  • substitutions Dictionary

    The dictionary of tags to replace

Returns:

String:

The parsed string

pre-render

() private

Inherited from AdminController:

Pre-render the admin page with the navigation

process

()

Inherited from Controller

The process method contains nothing navigation is created when renderNavigation is called.

service

(
  • alias
)
Service protected

Inherited from CanteenBase:

Get a service by alias

Parameters:

Returns:

Service:

The service matching the alias

setPage

(
  • page
)

Inherited from Controller:

Set the current page

Parameters:

  • page Page

    The page to build with this Controller

template

(
  • name
  • [substitutions=[]
)
String protected

Inherited from CanteenBase:

Convenience method for parsing content

Parameters:

  • name String

    The name of the template to parse

  • [substitutions=[] Dictionary optional

    The dictionary of tags to replace

Returns:

String:

The parsed string

Properties

_isPrerendered

Boolean private

Inherited from AdminController:

Check to see if we've already been pre-rendered

allObjects

Array protected

Inherited from AdminObjectController:

The collection of all object, this can be used to eliminate an additional database request for all the pages.

cache

ServerCache

Inherited from CanteenBase:

Get the instance of the site cache

data

Dictionary protected

Inherited from Controller:

Any custom substitutions for the parser

dynamicUri

String protected

Inherited from Controller:

For dynamic pages, the extra stuff after the page URI

formName

String protected

Inherited from AdminObjectController:

The name of the full form

getObject

String protected

Inherited from AdminObjectController:

The method name on the item service to get the object by id

getObjects

String protected

Inherited from AdminObjectController:

The method name on the item service to get all objects

ignoreFields

Array private

Inherited from AdminObjectController:

The collection of field names which we should ignore render for

isProtected

Boolean private

Certain properties are protected on certain build-in pages

isWriteable

Boolean private

If the page is writeable

object

Object protected

Inherited from AdminObjectController:

The selected object

optionalFields

Array private

Inherited from AdminObjectController:

The collection of field names which are optional to input

page

Page protected

Inherited from Controller:

The the current page

parser

Parser

Inherited from CanteenBase:

The parser is responsible for rendering templates

profiler

Profiler

Inherited from CanteenBase:

The instance of the profiler for debugging performance

readOnly

String private

If we are a readOnly page

removeEnabled

Boolean protected

Inherited from AdminObjectController:

If the delete button is enabled

Default: true

settings

SettingsManager

Inherited from CanteenBase:

Get the instance of the settings manager

site

Site

Inherited from CanteenBase:

Convenience getter for the site

titleName

String protected

Inherited from AdminObjectController:

The name of the item field for use in the select form list

Default: 'title'

user

Authorization

Inherited from CanteenBase:

Get the Authorization class to handle things like login, password change