Pages::getPageSelector()

Version 3.8

UI: Select page from a folder

Form Input to select a page in folder.

Return value

Object pageSelector

Full documentation

Select all orders that are ordered:

$Input = $this->get('pages','order')->getPageSelector(Array(
    'name' => 'tallenna[order]',
    'value' => $value,
    'where' => 'status=Ordered',
    'order' => 'number',
    'title' => 'number customer.name'
));

Custom options handler:

$Input = $this->get('pages','order')->getPageSelector(Array(
   'name' => 'tallenna[order]',
   'value' => $value,
   'optionsMethod' => 'availableOrders' // Values from $Order->availableOrders()
));

// Method to return options
class AccountPageRengasyksilo EXTENDS Sivu
    function availableOrders($apiParams)
    {
        $options = Array();

        $options[] = Array(
            'value' => 1001,
            'title' => 'TITLE',
            'description' => 'Description',
            'info' => 'info',
            'color' => 'green'
        );

        return $options;
    }
}

Vanilla html select:

$Input = $this->get('pages','order')->getPageSelector()
  ->setName('order')
  ->setRenderer('select');

Select multiple pages with buttons that are 120 pixels width:

$Input = $this->get('pages','order')->getPageSelector()
  ->setName('order')
  ->setRenderer('button')
  ->setWidth(120)
  ->setMultiple(true);
Method list Return Description
setFolder(mixed)  this  Set folder to search from. id, name or (Pages)[/service/php/pages]. Default: current folder.
setName(string)  this  Form name.
setValue(mixed)  this  Selected value. Page or page id.
setMultiple(bool) this  Select multiple values.
setDefault(mixed)  this  Default value. Page or page id. Is used as selected value, if no value is selected.
setWidth(int)  this  Selector width in pixels.
setHeight(int)  this  Selector height in pixels. (Only renderers that support height)
setRenderer(string) this  Selector renderer name: default, select, button
setWhere(string)  this  Where clause as in Pages::hae()
setOrder(string)  this Order clause as in Pages::hae()
setTitle(string} this  Visible text. Default: page title. Keywords are replaced with field values as in parseText()
setOptionsMethod(name) this Retuirn value of given Page -method.
getOptions()  array  Selector options as: Array[][value,title]
getPages()  array  Selector Page in array.
getSelectedPage() Sivu  Selected Page
renderSelected() string  Selected value title.
render()  string  Selector HTML code.