官术网_书友最值得收藏!

Adding a page selector field to a form

It is easy to add a page selector field to a form. When clicked on, the sitemap will appear in a modal window, allowing for easy browsing and selecting of a page. This allows for user friendly custom applications that can allow users to attach pages to any type of custom object, like a blog post or cooking recipe, for example.

Getting ready

We will need to use the FormPageSelectorHelper class, which we will need to load using the Loader library.

This recipe will need to be written inside of an HTML form somewhere in your site. We have created a basic single page for this purpose, which can be downloaded with the code from the website for this book. To install the single page, copy the code for this recipe to your concrete5 site directory and visit /dashboard/pages/single. Add a new single page with a path of /example.

How to do it...

concrete5 includes a helper to generate the necessary JavaScript and HTML text needed to show the sitemap selector widget. We will use the Loader class to include and return the PageSelectorHelper class, which will then return the entire HTML that we need. The steps are as follows:

  1. Make the pageSelector helper class available for us to use. The Loader class will automatically instantiate and return the instantiated helper object when the helper gets loaded.
    $pageSelector = Loader::helper('form/page_selector');
  2. Output the HTML and JavaScript required allowing users to select a page.
    echo $pageSelector->selectPage('page_id');

How it works...

The selectPage function returns the HTML and JavaScript necessary to produce a page selector field. There is only one parameter required, and that is a string indicating the name of the field. concrete5 will add a hidden <input> element to the form, which will allow the selected page ID to be read from a POST request.

In this example, once the form is submitted, you could retrieve the selected page ID by looking in the $_POST super variable.

$pageId = $_POST['page_id'];

There's more...

You can specify a page ID in the optional second parameter, which will populate the page selector with an existing page.

$page = Page::getByCollectionPath('/about-us');
echo $pageSelector->selectPage('page_id', $page->getCollectionID());

The pageSelector helper also has a function to display a sitemap in a modal window.

$args = array(
'display_mode' => 'full'
);
$pageSelector->sitemap($args);

Note that the sitemap() function loads an element, which is automatically printed to the screen, so there is no need to echo or print the result.

主站蜘蛛池模板: 铜川市| 阿克陶县| 吴堡县| 蒙自县| 临高县| 田阳县| 怀宁县| 绥滨县| 淅川县| 潼关县| 大理市| 禄丰县| 安庆市| 天等县| 新乐市| 古丈县| 军事| 美姑县| 乐至县| 南投县| 永平县| 沂源县| 泸水县| 禄劝| 桃园县| 远安县| 砀山县| 安图县| 东丰县| 全南县| 加查县| 庄浪县| 土默特左旗| 樟树市| 凤阳县| 新竹县| 天门市| 东平县| 浦东新区| 自贡市| 滨州市|