Page Selector

class Nos\Page\Renderer_Selector
This renderer is used to pick a page.
It displays a tree of the pages with radio buttons.
Page selector UI

Configuration

property Nos\Page\Renderer_Selector::$input_name

Name for the radio input.

property Nos\Page\Renderer_Selector::$selected

Array

id:Pre-selected page id (value).
property Nos\Page\Renderer_Selector::$treeOptions

Array

context:Context of the pages displayed in the page selector.
property Nos\Page\Renderer_Selector::$height

Height of the renderer. Default is 150px.

property Nos\Page\Renderer_Selector::$width

Width of the renderer. Default is none.

Methods

Nos\Page\Renderer_Selector::renderer($renderer)
Parameters:
  • $renderer (Model) – Array the attributes.
Returns:

The <input> tag with JavaScript to initialise it

Displays a page selector renderer in a standalone manner.

Example

Adding a page in a CRUD form configuration:

<?php

return array(
    'label' => __('Location:'),
    'renderer' => 'Nos\Page\Renderer_Selector',
    'renderer_options' => array(
        'height' => '250px',
    ),
);

Displaying a media selector:

<?php

echo Nos\Renderer_Media::renderer(array(
    'input_name' => 'my_page',
    'selected' => array(
        'id' => 2, // ID of the previously selected page
    ),
    'treeOptions' => array(
        'context' => 'main::en_GB',
    ),
    'height' => '250px',
));
Read the Docs v: 0.2
Versions
latest
chiba.2
chiba.1
0.2
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.