feindura Docs - Docs For Class Feindura

Quick Menu

Class Overview
Inherited Elements
Properties | Descriptions
Methods | Descriptions

Properties

Methods

__construct()
setStartPage()
setLanguage()
getLanguage()
getLanguageFile()
getLocalized()
createMetaTags()
createHref()
createLink()
createMenu()
createMenuByTags()
createMenuByDate()
createMenuBySortFunction()
isSubCategory()
isSubCategoryOf()
getParentPagesOf()
createSubMenu()
createSubMenuOfPage()
createSubMenuOfSubCategory()
createLanguageMenu()
createBreadCrumbsMenu()
showTitle()
showPage()
hasPlugins()
showPlugins()
hasTags()
listPages()
listSubPages()
listSubCategory()
listPagesByTags()
listPagesByDate()
listPagesBySortFunction()
startCache()
endCache()

Class Feindura File source: /library/classes/Feindura.class.php

Class Overview

FeinduraBase
   |
   --Feindura

Description

The class for implementing feindura - Flat File Content Management System in a website.

It's methods provide necessary functions for implementing the CMS in a website.
It contains, for example, methods for building a menu and get page contents, etc.

Additional

author: Fabian Vogelsteller <fabian@feindura.org>
copyright: Fabian Vogelsteller
license: GNU General Public License version 3

Version

2.0
ChangeLog
- 2.0 add Feindura::createSubMenuOfPage(), Feindura::isSubCategory(), Feindura::isSubCategoryOf(), Feindura::createMenuOfSubCategory(), Feindura::createLanguageMenu(), Feindura::createBreadCrumbsMenu(), Feindura::hasTags(), Feindura::getLocalized(), Feindura::listSubPages(), Feindura::listSubCategory()
- 1.0.1 add setStartPage()
- 1.0 initial release

Class located in /library/classes/Feindura.class.php [in line 43]

Property Summary

array	$metaData	Contains metaData which can be used in the website.
bool	$xHtml	TRUE when the pages content should be handled as XHTML.
string	$language	A country code (example: de, en, ..) to set the language of the frontend language-files
int	$page	Contains the current page ID get from the `$_GET` variable.
int	$category	Contains the current category ID get from the `$_GET` variable.
int	$startPage	Contains the startpage ID from the website-settings config.
int	$startCategory	Contains the start category ID
int\|false	$linkLength	The number of maximal visible characters in the link text of any link created by Feindura::createLink() or Feindura::createMenu().
string\|false	$linkId	Contains an id-Attribute which will be add to any <a ...> tag of any link created by Feindura::createLink() or Feindura::createMenu().
string\|false	$linkClass	Contains a class, which will be add to any <a ...> tag of any link created by Feindura::createLink() or Feindura::createMenu().
string	$linkActiveClass	This class name will be add to every link created with Feindura::createLink() or Feindura::createMenu(), when it is matching the currently selected page. When using the Feindura::createMenu() method, this class will also be add to the wrapping element of the link, like <li> or <td>.
string\|false	$linkAttributes	Contains a string with attributes which will be add to any <a ...> tag of any link created by Feindura::createLink() or Feindura::createMenu().
string\|false	$linkBefore	Contains a string which will be add before any <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().
string\|false	$linkAfter	Contains a string which will be add after any <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().
string\|false	$linkBeforeText	Contains a string which will be add before the link text but inside any <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().
string\|false	$linkAfterText	Contains a string which will be add after the link text but inside any <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().
bool	$linkShowThumbnail	If TRUE and the page has a thumbnail, it places the thumbnail <img> tag inside the <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().
bool	$linkShowThumbnailAfterText	If TRUE and the page has a thumbnail, it places the thumbnail <img> tag after the link text but inside the <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().
bool	$linkShowPageDate	If TRUE, page dates are allowed for the pages in this category and the page has a page date then it will be add before the link text of any link created by Feindura::createLink() or Feindura::createMenu().
string	$linkPageDateSeparator	If the Feindura::$linkShowPageDate property is TRUE, this string will be used as a separator between the page date and the link text of any link created by Feindura::createLink() or Feindura::createMenu().
bool	$linkShowCategory	If TRUE, the category name of the page will be add before the link text with the Feindura::$linkCategorySpacer property as separator of any link created by Feindura::createLink() or Feindura::createMenu().
string	$linkCategorySeparator	If the Feindura::$linkShowCategory property is TRUE, this string will be used as a separator between the category name and the link text of any link created by Feindura::createLink() or Feindura::createMenu().
bool	$menuShowAllPages	If this property is TRUE, it overwrites the "show in menu" setting of all pages, so that all pages are visible in the following menus.
string\|false	$menuId	Contains an id-Attribute which will be add to the menu tag created by any Feindura::createMenu() method.
string\|false	$menuClass	Contains a class which will be add to the menu tag created by any Feindura::createMenu() method.
string\|false	$menuAttributes	Contains string with attributes which will be add to the menu tag created by any Feindura::createMenu() method.
int\|false	$titleLength	A number of maximal characters visible in the page title.
bool	$titleAsLink	If TRUE the page title is also a link to the page.
bool	$titleShowPageDate	If TRUE, page dates are allowed for the pages in this category and the page has a page date then it will be add before the page title.
string	$titlePageDateSeparator	If the Feindura::$titleShowPageDate property is TRUE, this string will be used as a separator between the page date and the page title.
bool	$titleShowCategory	If TRUE, the category name of the page will be add before the page title with the Feindura::$linkCategorySpacer property as separator.
string	$titleCategorySeparator	If the Feindura::$titleShowCategory property is TRUE, this string will be used as a separator between the category name and the page title.
bool	$thumbnailAsLink	If TRUE the page thumbnail will be wrapped with a link to the page.
string\|false	$thumbnailAlign	Contains the position of the thumbnail picture, the possible values are "left", "right" or FALSE.
string\|false	$thumbnailId	Contains an id-Attribute which will be add to the thumbnail <img> tag.
string\|false	$thumbnailClass	Contains a class which will be add the thumbnail <img> tag.
string\|false	$thumbnailAttributes	Contains a string with attributes which will be add the thumbnail <img> tag.
string\|false	$thumbnailBefore	Contains a string which will be add before the thumbnail <img> tag.
string\|false	$thumbnailAfter	Contains a string which will be add after the thumbnail <img> tag.
bool	$showErrors	If TRUE an error will be displayed if the requested page doesn't exists or is currently not public.
string\|false	$errorTag	The tag which will be used to wrap the error message. E.g. if a pages is deactivated or doesnt exist.
array	$cachedScriptCache	Tells the Feindura::endCache() method to write the a cache file or not.

Method Summary

void	__construct()	The constructor of the class, sets all basic properties. Calls the FeinduraBase::__construct() class constructor...
void	setStartPage()	Set a page ID to the Feindura::$startPage and Feindura::$page property.
string\|false	setLanguage()	Set the FeinduraBase::$language property and reloads the frontend language file. Note The country code will NOT...
string	getLanguage()	Returns the language country code which was set in the feinduraBase:__construct().
array	getLanguageFile()	Check a specific directory for files which have a language code inside the filename (see $filename parameter)....
string	getLocalized()	Gets the localized version of given $value parameter from the $localizedArray , which matches the...
string	createMetaTags()	Creates a string with basic HTML5 meta tags. See the example for a detailed list of the meta tags created. Note :...
string\|false	createHref()	Generates a href attribute which links to a page. Depending whether Pretty URLs is in the administrator-settings...
string\|false	createLink()	This method uses the $link... and Feindura::$thumbnail... properties. Creates a link of a page. If the given...
array	createMenu()	This method uses the $link... , $menu... and $thumbnail... properties. Creates a menu from a category(ies)...
array	createMenuByTags()	This method uses the $link... , $menu... and $thumbnail... properties. Create a menu from category(ies) or...
array	createMenuByDate()	This method uses the $link... , $menu... and $thumbnail... properties. Creates a menu from category(ies) or...
array	createMenuBySortFunction()	Alias createMenuBySort() Alias createMenuBySortCallback() Alias createMenuByCallback() This...
bool	isSubCategory()	Check if the given $category ID is a subcategory. Note : If the $category parameter is FALSE or empty, it uses...
bool	isSubCategoryOf()	Check if the given $pageId ID has the given $categoryId as a subcategory. Note : If the $pageID parameter...
array\|false	getParentPagesOf()	Loads the parent pages of a subcategory. Note : If the $categoryId parameter is FALSE or empty, it uses the...
array	createSubMenu()	This method uses the $link... , $menu... and $thumbnail... properties. Creates a sub menu from the current...
array	createSubMenuOfPage()	This method uses the $link... , $menu... and $thumbnail... properties. Creates a sub menu out of the...
array	createSubMenuOfSubCategory()	Alias createSubMenuOfCategory() Alias createSubMenuFromSubCategory() Alias createSubMenuFromCategory()...
array	createLanguageMenu()	This method uses the $link... , $menu... properties. Creates a menu as language selection for the multi...
array	createBreadCrumbsMenu()	Alias createBreadCrumbMenu() Alias createBreadCrumbs() Alias createBreadCrumb() This method uses the...
string	showTitle()	This method uses the $title... properties. Returns the title of a page. This page title will be generated...
array	showPage()	This method uses the $error... , $title... and $thumbnail... properties. Returns an array which contains all...
bool	hasPlugins()	Alias hasPlugin() Alias isPlugins() Alias isPlugin() Check whether the given plugin(s) are activated for...
array\|string\|false	showPlugins()	Returns the plugin(s) of a page ready for displaying in a HTML page. It can return an array where each element...
array\|false	hasTags()	Load the $pagesMetaData array of pages which have one or more tags from the given $tags parameter. Can be used...
array	listPages()	This method uses the $error... , $title... and $thumbnail... properties. List pages by given category(ies)...
array	listSubPages()	This method uses the $error... , $title... and $thumbnail... properties. List pages of the subcategory of a...
array	listSubCategory()	This method uses the $error... , $title... and $thumbnail... properties. List the pages of a subcategory....
array	listPagesByTags()	This method uses the $error... , $title... and $thumbnail... properties. List pages by given category(ies)...
array	listPagesByDate()	This method uses the $error... , $title... and $thumbnail... properties. List pages by given a category(ies)...
array	listPagesBySortFunction()	Alias listPagesBySort() Alias listPagesBySortCallback() Alias listPagesByCallback() This...
bool	startCache()	This method can cache parts of your script, to speed up page loading time. You need to call Feindura::endCache()...
void	endCache()	This method writes the cache, which was started with Feidnura::startCache(). It will save the last started cache....

Properties

array $metaData = array()

Default value

array()

Description

Contains metaData which can be used in the website.

Example of the array
Show Example

<?php
 
$metaData['title']       = 'My Website Title';
$metaData['publisher']   = 'Max Mustermann';
$metaData['copyright']   = 'XY Company';
$metaData['keywords']    = 'keyword1,keyword2,keyword3';
$metaData['description'] = 'This is a example website.';
 
?>

Additional

access: public

bool $xHtml = false

Default value

false

Description

TRUE when the pages content should be handled as XHTML.

In XHTML standalone tags end with " />" instead of ">".
Therefor when a page content is displayed and this property is FALSE all " />" will be changed to ">".

Additional

access: public

Used By

string $language = 'en'

Default value

'en'

Description

A country code (example: de, en, ..) to set the language of the frontend language-files

This country code is used to include the right frontend language-file. The frontend language-file is used when displaying page warnings or errors and additional texts like "more", etc.
This property will be set in the Feindura::__construct() constructor.

The standard value is "en" (english).

Additional

Used By

Feindura::getLanguageFile() - to be loaded if no <var>$currentLangCode</var> parameter is given
Feindura::getLocalized() - the language used to get the localized version

int $page = null

Default value

null

Description

Contains the current page ID get from the $_GET variable.

This property is used when a page loading method is called (for example: Feindura::showPage()) and no page ID parameter is given.

This property will be set in the Feindura::__construct() constructor through the FeinduraBase::setCurrentPageId() method.

Additional

Used By

FeinduraBase::setCurrentPageId() - as the property to set
FeinduraBase::generatePage()
Feindura::createMetaTags() - to load the page title of the right page
Feindura::showPage()
Feindura::hasPlugins()
Feindura::showPlugins()
Feindura::setStartPage()

int $category = null

Default value

null

Description

Contains the current category ID get from the $_GET variable.

This property is used when a page-loading method is called (for example: Feindura::showPage()) and no category ID parameter is given.

This property will be set in the Feindura::__construct() constructor through the FeinduraBase::setCurrentCategoryId() method.

Additional

see: Feindura::__construct()
see: FeinduraBase::getCurrentCategoryId()
access: public

Used By

FeinduraBase::setCurrentCategoryId() - as the property to set
Feindura::createMetaTags() - to load the page title of the right page
Feindura::isSubCategory()
Feindura::isSubCategoryOf()
Feindura::getParentPagesOf()

int $startPage = null

Default value

null

Description

Contains the startpage ID from the website-settings config.

This property is set to the Feindura::$page property when the $_GET page variable and the Feindura::$page property is empty and setting a startpage is activated in the page-settings.

This property will be set in the Feindura::__construct() constructor through the FeinduraBase::setCurrentPageId() method.

Additional

Used By

FeinduraBase::setCurrentPageId() - if the $setStartPage parameter is TRUE this property will also be set
Feindura::setStartPage()

int $startCategory = null

Default value

null

Description

Contains the start category ID

Its fetched from the Feindura::$startPage through the GeneralFunctions::getPageCategory() method.
This property is set to the Feindura::$category property when the $_GET category variable and the Feindura::$category property is empty and setting a startpage is activated in the page-settings.

This property will be set in the Feindura::__construct() constructor through the FeinduraBase::setCurrentCategoryId() method.

Additional

see: Feindura::$startPage
see: Feindura::$category
see: Feindura::__construct()
see: FeinduraBase::setCurrentCategoryId()
see: FeinduraBase::getCurrentCategoryId()
access: public

Used By

FeinduraBase::getCurrentCategoryId() - if no $_GET variable exists it will try to get the Feindura::$startCategory property
FeinduraBase::setCurrentCategoryId() - if the $setStartCategory parameter is TRUE this property will also be set

int|false $linkLength = false

Default value

false

Description

The number of maximal visible characters in the link text of any link created by Feindura::createLink() or Feindura::createMenu().

The link text will be shorten to the last complete word.

For example the following string will be shorten to a $linkLength of "30": "Example Category -> Example Page Title" => "Example Category -> Example..."

Additional

var: a number of characters, or FALSE to don't shorten the link text.
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $linkId = false

Default value

false

Description

Contains an id-Attribute which will be add to any <a ...> tag of any link created by Feindura::createLink() or Feindura::createMenu().

Note: You should set a unique id-Attribute only once to elements in a HTML page, if you set this property and call Feindura::createMenu() every link in the menu will get this id-Attribute.

Additional

var: If no id-Attribute should be add, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $linkClass = false

Default value

false

Description

Contains a class, which will be add to any <a ...> tag of any link created by Feindura::createLink() or Feindura::createMenu().

You can also add multiple classes, just separate the classes with spaces. 'class1 class2'

Note: If you set this property and call Feindura::createMenu() every link in the menu will get this class-Attribute.

Additional

var: If no class-Attribute should be add, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string $linkActiveClass = 'active'

Default value

'active'

Description

This class name will be add to every link created with Feindura::createLink() or Feindura::createMenu(), when it is matching the currently selected page. When using the Feindura::createMenu() method, this class will also be add to the wrapping element of the link, like <li> or <td>.

Additional

see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $linkAttributes = false

Default value

false

Description

Contains a string with attributes which will be add to any <a ...> tag of any link created by Feindura::createLink() or Feindura::createMenu().

Note: If you set this property and call Feindura::createMenu() every link in the menu will get this attributes string.

The string should have the following format 'key1="value" key2="value"'

Additional

var: If no additional attributes should be add, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $linkBefore = false

Default value

false

Description

Contains a string which will be add before any <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().

Note: If you set this property and call Feindura::createMenu() every link in the menu will get this string.

Additional

var: If no text should be add before a link, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $linkAfter = false

Default value

false

Description

Contains a string which will be add after any <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().

Note: If you set this property and call Feindura::createMenu() every link in the menu will get this string.

Additional

var: If no text should be add after a link, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $linkBeforeText = false

Default value

false

Description

Contains a string which will be add before the link text but inside any <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().

Note: If you set this property and call Feindura::createMenu() every link in the menu will get this string.

Additional

var: If no text should be add before a link text, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $linkAfterText = false

Default value

false

Description

Contains a string which will be add after the link text but inside any <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().

Note: If you set this property and call Feindura::createMenu() every link in the menu will get this string.

Additional

var: If no text should be add after a link text, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

bool $linkShowThumbnail = false

Default value

false

Description

If TRUE and the page has a thumbnail, it places the thumbnail <img> tag inside the <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().

Additional

var: Set it to FALSE to don't show the thumbnails in links
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

bool $linkShowThumbnailAfterText = false

Default value

false

Description

If TRUE and the page has a thumbnail, it places the thumbnail <img> tag after the link text but inside the <a></a> tag of any link created by Feindura::createLink() or Feindura::createMenu().

Additional

var: Set it to TRUE to place the thumbnail <img> tag after the link text
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

bool $linkShowPageDate = false

Default value

false

Description

If TRUE, page dates are allowed for the pages in this category and the page has a page date then it will be add before the link text of any link created by Feindura::createLink() or Feindura::createMenu().

If the Feindura::$linkShowCategory property is TRUE, the page date is placed between the category name + separator and the link text.
The page date will be added with the page before-date-text and after-date-text from the page editor in the backend

Note: The page date will only be displayed if the $linkText parameter of Feindura::createLink() or Feindura::createMenu() methods is TRUE and not a string.

Example: <a href="?page=2" ...>200-12-31 Page Title</a>

Additional

var: Set it to TRUE to place the page date before the link text
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

string $linkPageDateSeparator = ' '

Default value

' '

Description

If the Feindura::$linkShowPageDate property is TRUE, this string will be used as a separator between the page date and the link text of any link created by Feindura::createLink() or Feindura::createMenu().

Note: If you set this property and call Feindura::createMenu() every link in the menu will use this separator.

Additional

see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

bool $linkShowCategory = false

Default value

false

Description

If TRUE, the category name of the page will be add before the link text with the Feindura::$linkCategorySpacer property as separator of any link created by Feindura::createLink() or Feindura::createMenu().

The category name will only be displayed if the $linkText parameter of Feindura::createLink() or Feindura::createMenu() methods is TRUE and not a string.

Example: <a href="?page=2" ...>Catgory Name: Page Title</a>

Additional

var: Set it to TRUE to place the category name before the link text
see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

Feindura::createLink()
Feindura::createMenu()
Feindura::createMenuByTags()
Feindura::createMenuByDate()
Feindura::createMenuBySortFunction()
Feindura::createSubMenu()
Feindura::createSubMenuOfPage()
Feindura::createSubMenuOfSubCategory()
Feindura::createBreadCrumbsMenu() - This is set to FALSE for all links, which are in a sub category (So the sub category name doesn't appear). You can change the separator between the category and the page name by setting the Feindura::$linkCategorySeparator

string $linkCategorySeparator = ': '

Default value

': '

Description

If the Feindura::$linkShowCategory property is TRUE, this string will be used as a separator between the category name and the link text of any link created by Feindura::createLink() or Feindura::createMenu().

Note: If you set this property and call Feindura::createMenu() every link in the menu will use this separator.

Additional

see: Feindura::createLink()
see: Feindura::createMenu()
example: example
access: public

Used By

bool $menuShowAllPages = false

Default value

false

Description

If this property is TRUE, it overwrites the "show in menu" setting of all pages, so that all pages are visible in the following menus.

Additional

see: Feindura::createMenu()
example: example
access: public

string|false $menuId = false

Default value

false

Description

Contains an id-Attribute which will be add to the menu tag created by any Feindura::createMenu() method.

Notice: You can also add the ID, classes and attributes directly to a specific menu using the $menuTag parameter. See the $menuTag parameter of the Feindura::createMenu() method for details. Notice: This id-Attribute will only be add, if the $menuTag parameter in the Feindura::createMenu() method is not FALSE.
Notice: You can only set one specific id-Attribute to elements in a HTML page.

Additional

var: If no id-Attribute should be add, set it to FALSE.
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $menuClass = false

Default value

false

Description

Contains a class which will be add to the menu tag created by any Feindura::createMenu() method.

You can also add multiple classes, just separate the classes with spaces. 'class1 class2'

Notice: You can also add the ID, classes and attributes directly to a specific menu using the $menuTag parameter. See the $menuTag parameter of the Feindura::createMenu() method for details. Note: This class-Attribute will only be add, if the $menuTag parameter in the Feindura::createMenu() method is not FALSE.

Additional

var: If no class-Attribute should be add, set it to FALSE.
see: Feindura::createMenu()
example: example
access: public

Used By

string|false $menuAttributes = false

Default value

false

Description

Contains string with attributes which will be add to the menu tag created by any Feindura::createMenu() method.

Notice: You can also add the ID, classes and attributes directly to a specific menu using the $menuTag parameter. See the $menuTag parameter of the Feindura::createMenu() method for details. Note: This string with attributes will only be add, if the $menuTag parameter in the Feindura::createMenu() method is not FALSE.

The string should have the following format 'key1="value" key2="value"'

Additional

var: If no additional attributes should be add, set it to FALSE.
see: Feindura::createMenu()
example: example
access: public

Used By

int|false $titleLength = false

Default value

false

Description

A number of maximal characters visible in the page title.

The page title will be shorten to the last complete word.

For example the following string will be shorten to a $titleLength of "30": "Example Category -> Example Page Title" => "Example Category -> Example..."

Additional

var: Number of characters or FALSE to don't shorten the page title
see: Feindura::getTitle()
see: FeinduraBase::createTitle()
example: example
access: public

Used By

bool $titleAsLink = false

Default value

false

Description

If TRUE the page title is also a link to the page.

Additional

see: Feindura::getTitle()
see: FeinduraBase::createTitle()
example: example
access: public

Used By

bool $titleShowPageDate = false

Default value

false

Description

If TRUE, page dates are allowed for the pages in this category and the page has a page date then it will be add before the page title.

If the Feindura::$titleShowCategory property is TRUE, the page date is placed between the category name + separator and the page title.
The page date will be added with the page before-date-text and after-date-text from the page editor in the backend.

Example: Catgory Name: 200-12-31 Page Title

Additional

var: Set it to TRUE to place the page date before the page title
see: Feindura::getTitle()
see: FeinduraBase::createTitle()
example: example
access: public

Used By

string $titlePageDateSeparator = ' '

Default value

' '

Description

If the Feindura::$titleShowPageDate property is TRUE, this string will be used as a separator between the page date and the page title.

Additional

see: Feindura::getTitle()
see: FeinduraBase::createTitle()
example: example
access: public

Used By

Feindura::showPage()

bool $titleShowCategory = false

Default value

false

Description

If TRUE, the category name of the page will be add before the page title with the Feindura::$linkCategorySpacer property as separator.

Example: Catgory Name: Page Title

Additional

var: Set it to TRUE to place the category name before the page title
see: Feindura::getTitle()
see: FeinduraBase::createTitle()
example: example
access: public

Used By

string $titleCategorySeparator = ': '

Default value

': '

Description

If the Feindura::$titleShowCategory property is TRUE, this string will be used as a separator between the category name and the page title.

Additional

see: Feindura::getTitle()
see: FeinduraBase::createTitle()
example: example
access: public

Used By

bool $thumbnailAsLink = false

Default value

false

Description

If TRUE the page thumbnail will be wrapped with a link to the page.

Additional

string|false $thumbnailAlign = false

Default value

false

Description

Contains the position of the thumbnail picture, the possible values are "left", "right" or FALSE.

If the values are "left" or "right" a style-attribute will be add to the thumbnail <img> tag with "float:left/right;".

Note: If you set this property, you can't add any style attribute with the Feindura::$thumbnailAttributes property anymore, it would not be used by the browser.

<img src="/path/image.png" ... style="float:left;" />

Additional

var: If no style="float:left/right;" attribute should be add, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
see: Feindura::showPage()
see: FeinduraBase::generatePage()
example: example
access: public

Used By

string|false $thumbnailId = false

Default value

false

Description

Contains an id-Attribute which will be add to the thumbnail <img> tag.

Note: You can only set one specific id-Attribute to elements in a HTML page.

Additional

var: If no id-Attribute should be add, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
see: Feindura::showPage()
see: FeinduraBase::generatePage()
example: example
access: public

Used By

string|false $thumbnailClass = false

Default value

false

Description

Contains a class which will be add the thumbnail <img> tag.

You can also add multiple classes, just separate the classes with spaces. 'class1 class2'

Additional

var: If no class-Attribute should be add, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
see: Feindura::showPage()
see: FeinduraBase::generatePage()
example: example
access: public

Used By

string|false $thumbnailAttributes = false

Default value

false

Description

Contains a string with attributes which will be add the thumbnail <img> tag.

The string should have the following format 'key1="value" key2="value"'

Additional

var: If no additional attributes should be add, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
see: Feindura::showPage()
see: FeinduraBase::generatePage()
example: example
access: public

Used By

string|false $thumbnailBefore = false

Default value

false

Description

Contains a string which will be add before the thumbnail <img> tag.

Additional

var: If no string should be add before the thumbnail <img> tag, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
see: Feindura::showPage()
see: FeinduraBase::generatePage()
example: example
access: public

Used By

string|false $thumbnailAfter = false

Default value

false

Description

Contains a string which will be add after the thumbnail <img> tag.

Additional

var: If no string should be add after the thumbnail <img> tag, set it to FALSE.
see: Feindura::createLink()
see: Feindura::createMenu()
see: Feindura::showPage()
see: FeinduraBase::generatePage()
example: example
access: public

Used By

bool $showErrors = true

Default value

true

Description

If TRUE an error will be displayed if the requested page doesn't exists or is currently not public.

Example: <span>The requested page is currently not available.</span>

Additional

see: Feindura::showPage()
see: FeinduraBase::generatePage()
example: example
access: public

Used By

string|false $errorTag = ''

Default value

Description

The tag which will be used to wrap the error message. E.g. if a pages is deactivated or doesnt exist.

Note: You can add simple Zen Code selectors to this string to add id, classes and attributes. E.g. "div#myId.myClass1.myClass2[attribute1=value][attribute2=value]" converts to <div id="myId" class="myClass1 myClass2" attribute1="value" attribute2="value">

Example:
Show Example

 <?php
 
 // assume we have already created an instance of feindura
 $feindura->errorTag = 'div.errorMessage';
 
 ?>
 
 <!-- Will look like this if an error occours -->
 
 <div class="errorMessage">The requested page is currently not available.</div>

Additional

var: If no tag should be add, set it to FALSE.
see: Feindura::showPage()
see: FeinduraBase::generatePage()
example: example
access: public

Used By

array $cachedScriptCache = false

Default value

false

Description

Tells the Feindura::endCache() method to write the a cache file or not.

Additional

see: Feindura::startCache()
see: Feindura::endCache()
access: protected

Methods

File source:
line 831

void Constructor __construct (

[string $language = false])

Parameters

string

$language

(optional) A country code like "de", "en", ... to load the right frontend language-file and is set to the FeinduraBase::$language property
Default false

Redefinition of:

FeinduraBase::__construct(): Type constructor

Description

Type constructor

The constructor of the class, sets all basic properties.

Calls the FeinduraBase::__construct() class constructor to set all necessary properties Fetch the $_GET variable (if existing) and set it to the Feindura::$page and Feindura::$category properties.
If there is no page and category ID it sets the start page ID from the website-settings config.

Example:
Show Example

<?php
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...

Additional

see: FeinduraBase::__construct()
access: public

Uses

FeinduraBase::__construct() - the constructor of the parent class to load all necessary properties
FeinduraBase::setCurrentCategoryId() - to set the fetched category ID from the $_GET variable to the Feindura::$category property
FeinduraBase::setCurrentPageId() - to set the fetched page ID from the $_GET variable to the Feindura::$page property

Version

1.3
ChangeLog
- 1.3 add set timezone from the backend as default timezone
- 1.2 changed the name of $_SESSION['feinduraSession']['websiteLanguage'] to $_SESSION['feinduraSession']['language'], so it differs from the backend version
- 1.1 fixed language detection
- 1.0 initial release

File source:
line 935

void setStartPage (

int $pageId)

Parameters

int

$pageId

the page ID to set

Description

Name setStartPage()

Set a page ID to the Feindura::$startPage and Feindura::$page property.

Additional

access: public

Uses

Feindura::$startPage
Feindura::$page
GeneralFunctions::getPageCategory() - to get the category of the page

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 968

string|false setLanguage (

string $language)

Parameters

string

$language

a language country code like "en", "de", ...

Description

Name setLanguage()

Set the FeinduraBase::$language property and reloads the frontend language file.

Note The country code will NOT set to any $_SESSION variable, you have to take care of this yourself.

Return Value

string|false - the language country code or FALSE if the given $language parameter is no country code

Additional

see: FeinduraBase::__construct()
access: public

Uses

FeinduraBase::$language - the language country code like "en", "de", ... which will be returned
FeinduraBase::$metaData - to change it to the new language

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 1006

string getLanguage (

)

Description

Name getLanguage()

Returns the language country code which was set in the feinduraBase:__construct().

Return Value

string - the language country code

Additional

see: feindura()
see: FeinduraBase::__construct()
access: public

Uses

FeinduraBase::$language - the language country code like "en", "de", ... which will be returned

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 1043

array getLanguageFile (

[string|false $langPath = false],
[string $filename = '%lang%.php'],
[string|false &$currentLangCode = false],
[bool $standardLang = 'en'])

Parameters

string\|false	$langPath	(optional) a absolut path to look for a language file which fit the $filename parameter or FALSE to use the "feindura-cms/library/languages" folder Default false
string	$filename	(optional) the structure of the filename, which should be loaded. the "%lang%" will be replaced with the country code like "%lang%.backend.php" -> "en.backend.php" Default '%lang%.php'
string\|false	&$currentLangCode	(optional) (Note: this variable will also be changed outside of this method) a variable with the current language code, if this is set it will be first try to load this language file, when it couldn't find a language file which fits the browsers language code. Default false
bool	$standardLang	(optional) a standard language for use if no match was found Default 'en'

Description

Name getLanguageFile()

Check a specific directory for files which have a language code inside the filename (see $filename parameter). When a matching file is found it includes these and return it. If no match could be found it try to find a file with the browser language code, if the $currentLangCode is empty it uses the Feindura::$language property.

Example of a language file
Show Example

<?php
 
$langFile['SEARCH_TITLE'] = 'Search';
$langFile['TITLE_NEWS']   = 'What\'s new';
...
 
return $langFile;
  
?>

Used Constants

DOCUMENTROOT the absolut path of the webserver

Return Value

array - the loaded language file array or an empty array

Additional

see: GeneralFunctions::loadLanguageFile()
access: public

Uses

GeneralFunctions::loadLanguageFile() - to load the right language file
Feindura::$language - to be loaded if no <var>$currentLangCode</var> parameter is given

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 1105

string getLocalized (

array $localizedArray,
string $value,
[string|false $language = false])

Parameters

array	$localizedArray	an array with an ['localized'] array in the form of: array('de' => .. , 'en' => .. )
string	$value	the name of the value, which should be returned localized
string\|false	$language	(optional) a language code ("en","de", etc) to use for loading the localized version of the given `$value` paramter Default false

Description

Name getLocalized()
Alias getLocalization()

Gets the localized version of given $value parameter from the $localizedArray, which matches the Feindura::$language property.
If no matching localized version for this language exists, it returns the "mainLanguage" or the first one in the localization array.

Example usage:
Show Example

 <?php
 
 require_once('cms/feindura.include.php');
 $feindura = new Feindura();
 
 // For example, you can use this function to get the name of a category (for the current language)
 echo $feindura->getLocalized($feindura->categoryConfig[1],'name');
 
 // RESULT
 // Name of the Category with ID 1
 
 ?>

Return Value

string - the localized version of the $value parameter

Additional

Uses

GeneralFunctions::getLocalized() - to get the right localization
Feindura::$language - the language used to get the localized version

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 1154

string createMetaTags (

[string|false $author = false],
[bool $openGraph = true],
[bool $googleSnippets = true])

Parameters

string\|false	$author	(optional) the author of the website Default false
bool	$openGraph	(optional) if TRUE it add the following open graph meta tags: "og:site_name", "og:url", "og:title", "og:description" and "og:image", you should add ( prefix="og: http://ogp.me/ns#" ) to the <html> tag, like this <html prefix="og: http://ogp.me/ns#"> Default true
bool	$googleSnippets	(optional) if TRUE it add the following google snippets meta tags: "url", "name", "description" and "image" Default true

Description

Name createMetaTags()
Alias createMetaTag()

Creates a string with basic HTML5 meta tags. See the example for a detailed list of the meta tags created.

Note: You have to call this method in the <head> tags of your website, to enable the frontend editing feature.
Note: This method also adds the Feed tags.

Example:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
// start to write HTML page
?>
<!DOCTYPE html>
  <html>
  <head>';
  <?php
    // John Doe is the author of the website.
    echo $feindura->createMetaTags('John Doe');
  ?>
  </head>
  <body>
  ...
 
 
<?php                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<!DOCTYPE html>
<html>
<head>
 
  <meta charset="UTF-8">
  <title>Welcome - An Example Website</title>
 
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <!-- enable google chrome frame, if available -->
 
  <meta name="author" content="Max Musterman">
  <meta name="publisher" content="Somebody From the Backend">
  <meta name="copyright" content="Somebody From the Backend">
  <meta name="generator" content="feindura - Flat File CMS 1.2 build:999">
 
  <link rel="alternate" type="application/atom+xml" title="Eine Beispiel Website (Atom, DE)" href="http://localhost/cms/pages/atom.de.xml">
  <link rel="alternate" type="application/rss+xml" title="Eine Beispiel Website (RSS 2.0, DE)" href="http://localhost/cms/pages/rss2.de.xml">
  <link rel="alternate" type="application/atom+xml" title="An Example Website (Atom, EN)" href="http://localhost/cms/pages/atom.en.xml">
  <link rel="alternate" type="application/rss+xml" title="An Example Website (RSS 2.0, EN)" href="http://localhost/cms/pages/rss2.en.xml">
 
  <link rel="stylesheet" type="text/css" href="/cms/plugins/contactForm/css/style.css">
  <link rel="stylesheet" type="text/css" href="/cms/plugins/imageGallery/milkbox/css/milkbox.css">
  <link rel="stylesheet" type="text/css" href="/cms/plugins/imageGallery/milkbox copy/css/milkbox.css">
 
</head>
<body>
...
 
?>

Return Value

string - with all meta tags ready to display in a HTML page

Additional

access: public

Uses

Feindura::$page - to load the page title of the right page
Feindura::$category - to load the page title of the right page
FeinduraBase::$websiteConfig - for the website title, publisher, copyright, description and keywords
GeneralFunctions::readPage() - to load the page for the page title
GeneralFunctions::setVisitorTimezone() - to try to set the timezone to the visitors one

Version

1.1
ChangeLog
- 1.1 add maintenance message
- 1.0.2 add GeneralFunctions::setVisitorTimzone() to set the local timezone
- 1.0.1 changed readPage() from getCurrentPage() to use only the page property
- 1.0 initial release

File source:
line 1454

string|false createHref (

[int|string|array|bool $id = false],
[bool $fullUrl = false])

Parameters

int\|string\|array\|bool	$id	(optional) a page ID, array with page and category ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. See Additional -> $id parameter example Default false
bool	$fullUrl	(optional) whether the full url should be returned or one relative to the website path. Default false

Description

Name createHref()

Generates a href attribute which links to a page. Depending whether Pretty URLs is in the administrator-settings activated, it generates a different href attribute.
If cookies are deactivated it attaches the FeinduraBase::$sessionId on the end.

Note: If the $id parameter is empty or FALSE it uses the Feindura::$page property.

Examples of the returned href string:

Pages without category: ?page=1 Pages with category: ?category=1&page=1

Pretty URL href for pages without category: /page/page-title/ Pretty URL href for pages with category: /category/category-name/page-title/

Return Value

string|false - the generated href attribute, or FALSE if no page could be loaded

Additional

Used By

Feindura::createMenu() - to create the href attribute
Feindura::createLink() - to create the href-attribute

Uses

FeinduraBase::getIdsFromString() - to load the right page and category IDs depending on the $ids parameter
GeneralFunctions::createHref() - call the right createHref functions in the GeneralFunctions class
GeneralFunctions::getPageCategory() - to get the category of the page
FeinduraBase::language

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 1533

string|false createLink (

[int|string|array|bool $id = false],
[string|bool $linkText = true])

Parameters

int\|string\|array\|bool	$id	(optional) a page ID, array with page and category ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. See Additional -> $id parameter example Default false
string\|bool	$linkText	(optional) a string with a linktext which the link will use, if TRUE it uses the page title of the page, if FALSE no linktext will be used Default true

Description

Name createLink()

This method uses the $link... and Feindura::$thumbnail... properties.

Creates a link of a page.

If the given $page parameter is a string with "previous" or "next", it creates a link for the previous or the next page, starting from the current page ID stored in the Feindura::$page property. If there is no current, next or previous page in it returns FALSE.

Note: If the $id parameter is empty or FALSE it uses the Feindura::$page property.
Note: It will add the Feindura::$linkActiveClass property as a CSS class to the link (and also its wrapping element, e.g. <li> or <td>), when the links page is matching the current page, or the current page is a sub page of the links page.

Example:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example uses all possible properties.
It's also works much more simple: just call createLink(1) without setting properties
and you have a simple link with the page title.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// set link properties
$feindura->linkLength                 = 20; // shortens the page title in the link
$feindura->linkId                     = 'exampleId';
$feindura->linkClass                  = 'exampleClass';
$feindura->linkAttributes             = 'test="exampleAttribute1" onclick="exampleAttribute2"';
$feindura->linkBefore                 = 'text before link ';
$feindura->linkAfter                  = ' text after link';
$feindura->linkBeforeText             = 'text before ';
$feindura->linkAfterText              = ' text after';
$feindura->linkShowThumbnail          = true;
$feindura->linkShowThumbnailAfterText = false;
$feindura->linkShowPageDate           = true;
$feindura->linkPageDateSeparator      = ' - ';
$feindura->linkShowCategory           = true;
$feindura->linkCategorySeparator      = ' -> ';
 
// set thumbnail properties
$feindura->thumbnailAlign             = 'left';
$feindura->thumbnailId                = 'thumbId';
$feindura->thumbnailClass             = 'thumbClass';
$feindura->thumbnailAttributes        = 'test="thumbnailAttr1" onclick="thumbnailAttr2"';
$feindura->thumbnailBefore            = 'text before thumbnail ';
$feindura->thumbnailAfter             = ' text after thumbnail';
 
 
// finally create the link from the page with ID "1" using the above set link properties
$link = $feindura->createLink(1);
 
// displays the link
echo $link;
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
text before link <a href="?category=1&amp;page=1" title="Example Category -> 2010-12-31 - Example Page"
id="exampleId" class="exampleClass" test="exampleAttribute1" onclick="exampleAttribute2">
text before thumbnail <img src="/path/thumb_page1.png" class="feinduraThumbnail" alt="Thumbnail" title="Example Page"
id="thumbId" class="thumbClass" test="thumbnailAttr1" onclick="thumbnailAttr2" style="float:left;">
text after thumbnail
text before Example Category -> 2010-12-31 - Example ... text after
</a> text after link
 
?>

Return Value

string|false - the created link, ready to display in a HTML-page, or FALSE if the page doesn't exist or is not public

Additional

Used By

Feindura::createMenu() - to create a link from every $pageContent array

Uses

Feindura::$linkLength
Feindura::$linkId
Feindura::$linkClass
Feindura::$linkActiveClass
Feindura::$linkAttributes
Feindura::$linkBefore
Feindura::$linkAfter
Feindura::$linkBeforeText
Feindura::$linkAfterText
Feindura::$linkShowThumbnail
Feindura::$linkShowThumbnailAfterText
Feindura::$linkShowPageDate
Feidnura::$linkPageDateSeparator
Feindura::$linkShowCategory
Feindura::$linkCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
Feindura::createHref() - to create the href-attribute
FeinduraBase::getIdsFromString() - to load the right page and category IDs depending on the $ids parameter
FeinduraBase::createAttributes() - to create the attributes used by the link <a> tag
FeinduraBase::createThumbnail() - to create the thumbnail for the link if the $linkShowThumbnail property is TRUE
FeinduraBase::shortenText() - to shorten the linktext if the $linkLength property is set
GeneralFunctions::getPageCategory() - to get the category of the page
GeneralFunctions::isPublicCategory() - to check whether the category is public

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 1703

array createMenu (

[string $idType = 'category'],
[int|array|bool $ids = false],
[int|bool $menuTag = false],
[string|bool $linkText = true],
[bool $sortPages = false],
[bool $reverseList = false])

Parameters

string	$idType	(optional) the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages" Default 'category'
int\|array\|bool	$ids	(optional) the category or page ID(s), can be a number or an array with numbers (can also be a $pageContent array), if TRUE it loads all pages, if FALSE it uses the Feindura::$page or Feindura::$category property Default false
int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "menu", "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div". You can also add simple Zen Code selectors to this string to add id, classes and attributes. E.g. "ul#myId.myClass1.myClass2[attribute1=value][attribute2=value]" converts to <ul id="myId" class="myClass1 myClass2" attribute1="value" attribute2="value"> Default false
string\|bool	$linkText	(optional) a string with a linktext which all links will use, if TRUE it uses the page titles of the pages, if FALSE no linktext will be used Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name createMenu()

This method uses the $link..., $menu... and $thumbnail... properties.

Creates a menu from a category(ies) or page(s).
In case no page with the given category or page ID(s) exist it returns an empty array.

Note: The $menuTag parameter can be an "menu", "ul", "ol" or "table", it will then create the necessary child HTML-tags for this element. If its any other tag name it just enclose the links with this HTML-tag.
Note: If the $ids parameter is FALSE it uses the Feindura::$page or Feindura::$category property depending on the $idType parameter.
Note: It will add the Feindura::$linkActiveClass property as a CSS class to the link (and also its wrapping element, e.g. <li> or <td>), when the links page is matching the current page, or the current page is a sub page of the links page.

Example Usage:
Show Example

<?php
/*                               *** SIMPLE EXAMPLE *** 
-------------------------------------------------------------------------------- */
 
// add before any HTML Tag. (eg. before the <!doctype html>)
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// create a menu from the category with ID "1"
$menu = $feindura->createMenu('category',1,'ul.myNav');
 
// displays the menu
foreach($menu as $item) {
  echo $item['menuItem'];
}
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<ul class="myNav">
  <li><a href="?category=1&amp;page=1" title="Example Page 1">Example Page 1</a></li>
  <li><a href="?category=1&amp;page=2" title="Example Page 2">Example Page 2</a></li>
</ul>
 
 
/*                               *** EXTENDED EXAMPLE *** 
--------------------------------------------------------------------------------
This example uses all possible properties.
It's also works much more simple: just call createMenu('category',1)
and you have a simple array with links of the pages from this category.
*/
 
// add before any HTML Tag. (eg. before the <!doctype html>)
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// set menu properties
$feindura->menuShowAllPages           = true; // will overwrite the pages "show in menu" setting
$feindura->menuId                     = 'menuId';
$feindura->menuClass                  = 'menuClass';
$feindura->menuAttributes             = 'test="menuAttribute1" onclick="menuAttribute2"';
 
// set link properties
$feindura->linkLength                 = 20; // shortens the page title in the link
$feindura->linkId                     = false; // set no id otherwise it will be repeated
$feindura->linkClass                  = 'linkClass';
$feindura->linkAttributes             = 'test="linkAttribute1" onclick="linkAttribute2"';
$feindura->linkBefore                 = 'text before link ';
$feindura->linkAfter                  = ' text after link';
$feindura->linkBeforeText             = 'text before ';
$feindura->linkAfterText              = ' text after';
$feindura->linkShowThumbnail          = true;
$feindura->linkShowThumbnailAfterText = false;
$feindura->linkShowPageDate           = true;
$feindura->linkPageDateSeparator      = ' - ';
$feindura->linkShowCategory           = true;
$feindura->linkCategorySeparator      = ' -> ';
 
// set thumbnail properties
$feindura->thumbnailAlign             = 'left';
$feindura->thumbnailId                = false; // set no id otherwise it will be repeated
$feindura->thumbnailClass             = 'thumbnailClass';
$feindura->thumbnailAttributes        = 'test="thumbnailAttribute1" onclick="thumbnailAttribute2"';
$feindura->thumbnailBefore            = 'text before thumbnail ';
$feindura->thumbnailAfter             = ' text after thumbnail';
 
// finally create the menu from the category with ID "1" using the above set properties
$menu = $feindura->createMenu('category',1,'table',true,2);
 
// displays the menu
foreach($menu as $item) {
  echo $item['menuItem'];
}
 
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<table id="menuId" class="menuClass" test="menuAttribute1" onclick="menuAttribute2">
  <tbody>
    <tr><td>
      text before link <a href="?category=1&amp;page=1" title="Example Category -> 2010-12-31 - Example Page 1"
      class="linkClass" test="linkAttribute1" onclick="linkAttribute2">
      text before thumbnail
      <img src="/path/thumb_page1.png" class="feinduraThumbnail" alt="Thumbnail" title="Example Page 1"
      class="thumbnailClass" test="thumbnailAttribute1" onclick="thumbnailAttribute2" style="float:left;">
      text after thumbnail
      text before Example Category -> 2010-12-31 - Example ... text after
      </a> text after link
    </td><td>
      text before link <a href="?category=1&amp;page=2" title="Example Category -> 2010-11-25 - Example Page 2"
      class="linkClass" test="linkAttribute1" onclick="linkAttribute2">
      text before thumbnail
      <img src="/path/thumb_page2.png" class="feinduraThumbnail" alt="Thumbnail" title="Example Page 2"
      class="thumbnailClass" test="thumbnailAttribute1" onclick="thumbnailAttribute2" style="float:left;">
      text after thumbnail
      text before Example Category -> 2010-11-25 - Example ... text after
      </a> text after link
    </td>
    </tr><tr>
    <td>
      text before link <a href="?category=1&amp;page=3" title="Example Category -> 2010-10-15 - Example Page 3"
      class="linkClass" test="linkAttribute1" onclick="linkAttribute2">
      text before thumbnail
      <img src="/path/thumb_page3.png" class="feinduraThumbnail" alt="Thumbnail" title="Example Page 3"
      class="thumbnailClass" test="thumbnailAttribute1" onclick="thumbnailAttribute2" style="float:left;">
      text after thumbnail
      text before Example Category -> 2010-10-15 - Example ... text after
      </a> text after link
    </td><td>
      text before link <a href="?category=1&amp;page=4" title="Example Category -> 2010-09-05 - Example Page 4"
      class="linkClass" test="linkAttribute1" onclick="linkAttribute2">
      text before thumbnail
      <img src="/path/thumb_page4.png" class="feinduraThumbnail" alt="Thumbnail" title="Example Page 4"
      class="thumbnailClass" test="thumbnailAttribute1" onclick="thumbnailAttribute2" style="float:left;">
      text after thumbnail
      text before Example Category -> 2010-09-05 - Example ... text after
      </a> text after link
    </td></tr>
  </tbody>
</table>
 
?>

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="?page=5&category=1" class="active">Example Page 1</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=5&category=1" class="active">Example Page 1</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 1',
    'href'               => '?page=5&category=1',
    'pageDate'           => '2000-12-31',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'pageId' or 'id'     => 5,
    'categoryId'         => 1
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="?page=8&category=1">Example Page 2</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=8&category=1">Example Page 2</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 2',
    'href'               => '?page=8&category=1',
    'pageDate'           => '2000-10-10',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393465, // 'date' and 'start' is the same
                    'start' => 1325393465,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 8,
    'categoryId'         => 1
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="?page=9&category=1">Example Page 3</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=9&category=1">Example Page 3</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 3',
    'href'               => '?page=9&category=1',
    'pageDate'           => '2000-10-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393322, // 'date' and 'start' is the same
                    'start' => 1325393322,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 9,
    'categoryId'         => 1
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created menu in an array, ready to display in a HTML-page, or an empty array

Additional

Used By

Feindura::createMenuByTags() - to create the menu from the pages load by FeinduraBase::checkPagesForTags()
Feindura::createMenuByDate() - to create the menu from the pages
Feindura::createMenuBySortFunction() - to create the menu from the pages
Feindura::createSubMenu() - to create the menu
Feindura::createSubMenuOfPage() - to create the menu
Feindura::createSubMenuOfSubCategory() - to create the menu

Uses

Feindura::$menuId
Feindura::$menuClass
Feindura::$menuAttributes
Feindura::$linkLength
Feindura::$linkId
Feindura::$linkClass
Feindura::$linkActiveClass
Feindura::$linkAttributes
Feindura::$linkBefore
Feindura::$linkAfter
Feindura::$linkBeforeText
Feindura::$linkAfterText
Feindura::$linkShowThumbnail
Feindura::$linkShowThumbnailAfterText
Feindura::$linkShowPageDate
Feindura::$linkPageDateSeparator
Feindura::$linkShowCategory
Feindura::$linkCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
Feindura::createHref() - to create the href attribute
Feindura::createLink() - to create a link from every $pageContent array
FeinduraBase::getPropertyIdsByType() - if the $ids parameter is FALSE it gets the property category or page ID, depending on the $idType parameter
FeinduraBase::loadPagesByType() - to load the page $pageContent array(s) from the given ID(s)
GeneralFunctions::sortPages() - to sort the $pageContent arrays by category
FeinduraBase::generateMenu() - to generate the final menu

Version

1.1
ChangeLog
- 1.1 changed returned array
- 1.0 initial release

File source:
line 1855

array createMenuByTags (

Parameters

string\|array	$tags	a string with tags seperated by "," or ";" or an array with tags
string	$idType	(optional) the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages" Default 'category'
int\|array\|bool	$ids	(optional) the category or page ID(s), can be a number or an array with numbers (can also be a $pageContent array), if TRUE it loads all pages, if FALSE it uses the Feindura::$page or Feindura::$category property Default false
int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div" Default false
string\|bool	$linkText	(optional) a string with a linktext which all links will use, if TRUE it uses the page titles of the pages, if FALSE no linktext will be used Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name createMenuByTags()
Alias createMenuByTag()

This method uses the $link..., $menu... and $thumbnail... properties.

Create a menu from category(ies) or page(s), with pages which have one or more of the tags from the given $tags parameter.
In case no page with the given category or page ID(s) or tags exist it returns an empty array.

Note: the tags will be compared case insensitive.
Note: The $menuTag parameter can be an "menu", "ul", "ol" or "table", it will then create the necessary HTML-tags of this element. If its any other tag name it just enclose the links with this HTML-tag.
Note: If the $ids parameter is FALSE it uses the Feindura::$page or Feindura::$category property depending on the $idType parameter.
Note: It will add the Feindura::$linkActiveClass property as a CSS class to the link (and also its wrapping element, e.g. <li> or <td>), when the links page is matching the current page, or the current page is a sub page of the links page.

Example:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example shows only the usage of tags for creating a menu,
for a detailed menu example see createMenu()
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// the tags where the pages in the menu should have atleast one
$tags = 'winter summer spring';
// could also be an array like
// $tags = array(0 => 'winter', 1 => 'summer', 2 => 'spring');
 
// finally create the menu from the category with ID "1" using the above set tags
$menu = $feindura->createMenuByTags($tags,'category',1,array('table',2));
 
// displays the menu
foreach($menu as $item) {
  echo $item['menuItem'];
}
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<table>
  <tbody>
    <tr><td>
      <a href="?category=1&amp;page=1" title="Summer Page">
      Summer Page
      </a>
    </td><td>
      <a href="?category=1&amp;page=2" title="Winter Page">
      Winter Page
      </a>
    </td>
    </tr><tr>
    <td>
      <a href="?category=1&amp;page=6" title="Spring Page">
      Spring Page
      </a>
    </td><td></td>
    </tr>
  </tbody>
</table>
 
 
?>

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="?page=5&category=1" class="active">Example Page 1</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=5&category=1" class="active">Example Page 1</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 1',
    'href'               => '?page=5&category=1',
    'pageDate'           => '2000-12-31',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'pageId' or 'id'     => 5,
    'categoryId'         => 1
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="?page=8&category=1">Example Page 2</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=8&category=1">Example Page 2</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 2',
    'href'               => '?page=8&category=1',
    'pageDate'           => '2000-10-10',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393465, // 'date' and 'start' is the same
                    'start' => 1325393465,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 8,
    'categoryId'         => 1
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="?page=9&category=1">Example Page 3</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=9&category=1">Example Page 3</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 3',
    'href'               => '?page=9&category=1',
    'pageDate'           => '2000-10-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393322, // 'date' and 'start' is the same
                    'start' => 1325393322,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 9,
    'categoryId'         => 1
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created menu in an array, ready to display in a HTML-page, or an empty array

Additional

Uses

Feindura::$menuId
Feindura::$menuClass
Feindura::$menuAttributes
Feindura::$linkLength
Feindura::$linkId
Feindura::$linkClass
Feindura::$linkActiveClass
Feindura::$linkAttributes
Feindura::$linkBefore
Feindura::$linkAfter
Feindura::$linkBeforeText
Feindura::$linkAfterText
Feindura::$linkShowThumbnail
Feindura::$linkShowThumbnailAfterText
Feindura::$linkShowPageDate
Feindura::$linkPageDateSeparator
Feindura::$linkShowCategory
Feindura::$linkCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::getPropertyIdsByType() - if the $ids parameter is FALSE it gets the property category or page ID, depending on the $idType parameter
FeinduraBase::checkPagesForTags() - to get only the pages which have one or more tags from the given $tags parameter
Feindura::createMenu() - to create the menu from the pages load by FeinduraBase::checkPagesForTags()

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 1952

array createMenuByDate (

Parameters

int\|bool\|string	$from	(optional) number of months in the past, if TRUE it show all pages in the past, if FALSE it loads only pages starting from the current date. Can also be a string with a date format (e.g. '2 weeks' or '27.06.2012'), for more details see: http://www.php.net/manual/en/datetime.formats.php Default true
int\|bool\|string	$to	(optional) number of months in the future, if TRUE it show all pages in the future, if FALSE it loads only pages until the current date. Can also be a string with a date format (e.g. '10 days' or '27.06.2012'), for more details see: http://www.php.net/manual/de/datetime.formats.php Default true
string	$idType	(optional) the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages" Default 'category'
int\|array\|bool	$ids	(optional) the category or page ID(s), can be a number or an array with numbers (can also be a $pageContent array), if TRUE it loads all pages, if FALSE it uses the Feindura::$page or Feindura::$category property Default false
int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div" Default false
string\|bool	$linkText	(optional) a string with a linktext which all links will use, if TRUE it uses the page titles of the pages, if FALSE no linktext will be used Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE it sorts the pages by date (If date range: by start date). Can also be a sort function e.g. "sortByEndDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name createMenuByDate()
Alias createMenuByDates()

This method uses the $link..., $menu... and $thumbnail... properties.

Creates a menu from category(ies) or page(s) parameter. Applies for pages which have a page date (and page date is activated for that category!) and it fit in the time period from the $from and the $to parameter (relative to the current date).

The $from and $to parameters can also be a string with a (relative or specific) date, for more information see: http://www.php.net/manual/de/datetime.formats.php.

In case no page with the given category or page ID(s) or tags exist it returns an empty array.

Note: The $menuTag parameter can be an "menu", "ul", "ol" or "table", it will then create the necessary HTML-tags of this element. If its any other tag name it just enclose the links with this HTML-tag.
Note: If the $ids parameter is FALSE it uses the Feindura::$page or Feindura::$category property depending on the $idType parameter.
Note: It will add the Feindura::$linkActiveClass property as a CSS class to the link (and also its wrapping element, e.g. <li> or <td>), when the links page is matching the current page, or the current page is a sub page of the links page.

Example:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example shows only the usage of a time period for creating a menu,
for a detailed menu example see createMenu()
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// set this property to show the page date in the links text
// the "text before date" and "text after date" was set in the page editor in the backend
$feindura->linkShowPageDate      = true;
$feindura->linkPageDateSeparator = ': ';
 
// create the menu from the category with ID "1" using the time period:
// load all pages in the past until 8 months in the future starting from the date today: 31.05.2010
$menu = $feindura->createMenuByDate('category',1,array('table',2));
 
// displays the menu
foreach($menu as $item) {
  echo $item['menuItem'];
}
 
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<table>
  <tbody>
    <tr><td>
      <a href="?category=1&amp;page=1" title="text before date 2005-10-31 text after date: Oldest Page">
      text before date 2005-10-31 text after date: Oldest Page
      </a>
    </td><td>
      <a href="?category=1&amp;page=2" title="text before date 2010-11-31 text after date: Newer Page">
      text before date 2010-11-31 text after date: Newer Page
      </a>
    </td>
    </tr><tr>
    <td>
      <a href="?category=1&amp;page=3" title="text before date 2010-12-31 text after date: Newest Page">
      text before date 2010-12-31 text after date: Newest Page
      </a>
    </td><td></td>
    </tr>
  </tbody>
</table>
 
?>

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="?page=5&category=1" class="active">Example Page 1</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=5&category=1" class="active">Example Page 1</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 1',
    'href'               => '?page=5&category=1',
    'pageDate'           => '2000-12-31',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'pageId' or 'id'     => 5,
    'categoryId'         => 1
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="?page=8&category=1">Example Page 2</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=8&category=1">Example Page 2</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 2',
    'href'               => '?page=8&category=1',
    'pageDate'           => '2000-10-10',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393465, // 'date' and 'start' is the same
                    'start' => 1325393465,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 8,
    'categoryId'         => 1
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="?page=9&category=1">Example Page 3</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=9&category=1">Example Page 3</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 3',
    'href'               => '?page=9&category=1',
    'pageDate'           => '2000-10-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393322, // 'date' and 'start' is the same
                    'start' => 1325393322,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 9,
    'categoryId'         => 1
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created menu in an array, ready to display in a HTML-page, or an empty array

Additional

Uses

Feindura::$menuId
Feindura::$menuClass
Feindura::$menuAttributes
Feindura::$linkLength
Feindura::$linkId
Feindura::$linkClass
Feindura::$linkActiveClass
Feindura::$linkAttributes
Feindura::$linkBefore
Feindura::$linkAfter
Feindura::$linkBeforeText
Feindura::$linkAfterText
Feindura::$linkShowThumbnail
Feindura::$linkShowThumbnailAfterText
Feindura::$linkShowPageDate
Feindura::$linkPageDateSeparator
Feindura::$linkShowCategory
Feindura::$linkCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::loadPagesByDate() - to load the pages which fit in the given time period parameters, sorted by the page date
Feindura::createMenu() - to create the menu from the pages

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2046

array createMenuBySortFunction (

string $sortCallback,
[string $idType = 'category'],
[int|array|bool $ids = false],
[int|bool $menuTag = false],
[string|bool $linkText = true],
[bool $reverseList = false])

Parameters

string	$sortCallback	the name of the callback function to sort the menu (uses usort()). For a list of available predefined functions see GeneralFunctions::sortPages()
string	$idType	(optional) the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages" Default 'category'
int\|array\|bool	$ids	(optional) the category or page ID(s), can be a number or an array with numbers (can also be a $pageContent array), if TRUE it loads all pages, if FALSE it uses the Feindura::$page or Feindura::$category property Default false
int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div" Default false
string\|bool	$linkText	(optional) a string with a linktext which all links will use, if TRUE it uses the page titles of the pages, if FALSE no linktext will be used Default true
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name createMenuBySortFunction()

Alias createMenuBySort()
Alias createMenuBySortCallback()
Alias createMenuByCallback()

This method uses the $link..., $menu... and $thumbnail... properties.

Creates a menu from category(ies) or page(s), sorted by a custom sort function passed in the first parameter $sortCallback.

In case no page with the given category or page ID(s) or tags exist it returns an empty array.

Example:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example uses all possible properties.
It's also works much more simple: just call createMenu('category',1)
and you have a simple array with links of the pages from this category.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// create the sort function, which we use with the createMenuBySortFunction() method
function sortByLastEditDate($a,$b) {
  if ($a['lastSaveDate'] == $b['lastSaveDate'])
    return 0;
  return ($a['lastSaveDate'] > $b['lastSaveDate']) ? -1 : 1;
}
 
// now we create the menu from the category with ID "1"
$menu = $feindura->createMenuBySortFunction('sortByLastEditDate','category',1,array('table',2));
 
// displays the menu
foreach($menu as $item) {
  echo $item['menuItem'];
}
 
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<table>
  <tbody>
    <tr><td>
      <a href="?category=1&amp;page=2" title="Example Page 2">
      Example Page 2
      </a>
    </td>
    <td>
      <a href="?category=1&amp;page=1" title="Example Page 1">
      Example Page 1
      </a>
    </td>
    </tr><tr>
    <td>
      <a href="?category=1&amp;page=4" title="Example Page 4">
      Example Page 4
      </a>
    </td>
    <td>
      <a href="?category=1&amp;page=3" title="Example Page 3">
      Example Page 3
      </a>
    </td></tr>
  </tbody>
</table>
 
?>

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="?page=5&category=1" class="active">Example Page 1</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=5&category=1" class="active">Example Page 1</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 1',
    'href'               => '?page=5&category=1',
    'pageDate'           => '2000-12-31',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'pageId' or 'id'     => 5,
    'categoryId'         => 1
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="?page=8&category=1">Example Page 2</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=8&category=1">Example Page 2</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 2',
    'href'               => '?page=8&category=1',
    'pageDate'           => '2000-10-10',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393465, // 'date' and 'start' is the same
                    'start' => 1325393465,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 8,
    'categoryId'         => 1
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="?page=9&category=1">Example Page 3</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=9&category=1">Example Page 3</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 3',
    'href'               => '?page=9&category=1',
    'pageDate'           => '2000-10-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393322, // 'date' and 'start' is the same
                    'start' => 1325393322,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 9,
    'categoryId'         => 1
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created menu in an array, ready to display in a HTML-page, or an empty array

Additional

Uses

Feindura::$menuId
Feindura::$menuClass
Feindura::$menuAttributes
Feindura::$linkLength
Feindura::$linkId
Feindura::$linkClass
Feindura::$linkActiveClass
Feindura::$linkAttributes
Feindura::$linkBefore
Feindura::$linkAfter
Feindura::$linkBeforeText
Feindura::$linkAfterText
Feindura::$linkShowThumbnail
Feindura::$linkShowThumbnailAfterText
Feindura::$linkShowPageDate
Feindura::$linkPageDateSeparator
Feindura::$linkShowCategory
Feindura::$linkCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::loadPagesByType() - to load the pages which fit in the given time period parameters, sorted by the page date
Feindura::createMenu() - to create the menu from the pages

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2107

bool isSubCategory (

[int|string|bool $categoryId = false])

Parameters

int|string|bool

$categoryId

(optional) a category ID, or a string with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$category property.
Default false

Description

Name isSubCategory()

Check if the given $category ID is a subcategory.

Note: If the $category parameter is FALSE or empty, it uses the current category (means the Feindura::$category property).

Return Value

bool - whether or not the checked category is a subcategory

Additional

access: public

Uses

Feindura::$category
Feindura::$categoryConfig

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2142

bool isSubCategoryOf (

[int|string|bool $pageId = false],
[int|string|bool $categoryId = false])

Parameters

int\|string\|bool	$pageId	(optional) a page ID, or a string with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. Default false
int\|string\|bool	$categoryId	(optional) a category ID, or a string with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$category property. Default false

Description

Name isSubCategoryOf()

Check if the given $pageId ID has the given $categoryId as a subcategory.

Note: If the $pageID parameter is FALSE or empty, it uses the current page (means the Feindura::$page property).
Note: If the $categoryId parameter is FALSE or empty, it uses the current page (means the Feindura::$page property).

Return Value

bool - whether or not the given page has the given category as subcategory

Additional

access: public

Uses

Feindura::$category
Feindura::$categoryConfig

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2180

array|false getParentPagesOf (

[int|string|bool $categoryId = false])

Parameters

int|string|bool

$categoryId

(optional) a category ID, or a string with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$category property.
Default false

Description

Name getParentPagesOf()

Loads the parent pages of a subcategory.

Note: If the $categoryId parameter is FALSE or empty, it uses the current page (means the Feindura::$page property).

Return Value

array|false - and array with all the parent pages or FALSE if it is not a sub category

Additional

access: public

Uses

Feindura::$category
Feindura::$categoryConfig

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2271

array createSubMenu (

[int|bool $menuTag = false],
[string|bool $linkText = true],
[bool $sortPages = false],
[bool $reverseList = false])

Parameters

int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div" Default false
string\|bool	$linkText	(optional) a string with a linktext which all links will use, if TRUE it uses the page titles of the pages, if FALSE no linktext will be used Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name createSubMenu()

This method uses the $link..., $menu... and $thumbnail... properties.

Creates a sub menu from the current page (Feindura::$page) or the current category (Feindura::$category), if its a subcategory.
In case the current page has no subcategory or the current category is no subcategory it returns an empty array.

Note: The $menuTag parameter can be an "menu", "ul", "ol" or "table", it will then create the necessary child HTML-tags of this element. If its any other tag name it just enclose the links with this HTML-tag.
Note: It will add the Feindura::$linkActiveClass property as a CSS class to the link (and also its wrapping element, e.g. <li> or <td>), when the links page is matching the current page, or the current page is a sub page of the links page.

Example:
Show Example

<?php
/*                               *** CODE ***
--------------------------------------------------------------------------------
This example uses no extra properties. To see an example using all the properties, see the createMenu() method example.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
 
// will create a <ul> menu from the current page, when it has a subcategory or the current subcategory
foreach($feindura->createSubMenu('ul') as $item) {
  echo $item['menuItem'];
}
 
 
                               *** RESULT ***
--------------------------------------------------------------------------------
 
<ul>
  <li>
    <a href="?category=1&page=1" title="Example Page 1">
    Example Page 1
    </a>
 
    <ul>
      <li>
        <a href="?category=2&page=4" title="Example Page in SubCategory 1">
        Example Page in SubCategory 1
        </a>
      </li>
      <li>
        <a href="?category=2&page=5" title="Example Page in SubCategory 2">
        Example Page in SubCategory 2
        </a>
      </li>
    </ul>
 
  </li>
  <li>
    <a href="?category=1&page=2" title="Example Page 2">
    Example Page 2
    </a>
  </li>
  <li>
    <a href="?category=1&page=3" title="Example Page 3">
    Example Page 3
    </a>
  </li>
</ul>
 
?>

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="?page=5&category=1" class="active">Example Page 1</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=5&category=1" class="active">Example Page 1</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 1',
    'href'               => '?page=5&category=1',
    'pageDate'           => '2000-12-31',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'pageId' or 'id'     => 5,
    'categoryId'         => 1
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="?page=8&category=1">Example Page 2</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=8&category=1">Example Page 2</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 2',
    'href'               => '?page=8&category=1',
    'pageDate'           => '2000-10-10',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393465, // 'date' and 'start' is the same
                    'start' => 1325393465,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 8,
    'categoryId'         => 1
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="?page=9&category=1">Example Page 3</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=9&category=1">Example Page 3</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 3',
    'href'               => '?page=9&category=1',
    'pageDate'           => '2000-10-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393322, // 'date' and 'start' is the same
                    'start' => 1325393322,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 9,
    'categoryId'         => 1
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created sub menu in an array, ready to display in a HTML-page, or an empty array

Additional

see: createMenuFromCategory()
see: Feindura::createLink()
see: Feindura::createMenu()
access: public

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2354

array createSubMenuOfPage (

Parameters

int\|string\|array\|bool	$id	(optional) a page ID, array with page and category ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. See Additional -> $id parameter example Default false
int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div" Default false
string\|bool	$linkText	(optional) a string with a linktext which all links will use, if TRUE it uses the page titles of the pages, if FALSE no linktext will be used Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name createSubMenuOfPage()
Alias createSubMenuFromPage()

This method uses the $link..., $menu... and $thumbnail... properties.

Creates a sub menu out of the subcategory of a page. If the page has no subcategory it will return an empty array.
In case no page with the given page ID exist, or it has no subcategory it returns an empty array.

Note: The $menuTag parameter can be an "menu", "ul", "ol" or "table", it will then create the necessary child HTML-tags of this element. If its any other tag name it just enclose the links with this HTML-tag.
Note: If the $id parameter is FALSE or empty, it uses the current page (means the Feindura::$page property).
Note: It will add the Feindura::$linkActiveClass property as a CSS class to the link (and also its wrapping element, e.g. <li> or <td>), when the links page is matching the current page, or the current page is a sub page of the links page.

Example:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example uses no extra properties. To see an example using all the properties, see the createMenu() method example.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// will create a <ul> menu from the non category (ID 0)
$menu = $feindura->createMenu('category',0,'ul');
 
// displays the menu
foreach($menu as $item) {
  echo $item['startTag'].$item['link'];
  // when a page has a submenu it will create a <ul> menu inside this <li></li>,
  // which can be used as a CSS dropdown menu. e.g. see http://www.cssnewbie.com/easy-css-dropdown-menus/
  foreach($feindura->createSubMenuOfPage($item['pageId'],'ul') as $subItem) {
    echo $subItem['menuItem'];
  }
  echo $item['endTag'];
}
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<ul>
  <li>
    <a href="?category=1&page=1" title="Example Page 1">
    Example Page 1
    </a>
    
    <ul>
      <li>
        <a href="?category=2&page=4" title="Example Page in SubCategory 1">
        Example Page in SubCategory 1
        </a>
      </li>
      <li>
        <a href="?category=2&page=5" title="Example Page in SubCategory 2">
        Example Page in SubCategory 2
        </a>
      </li>
    </ul>
 
  </li>
  <li>
    <a href="?category=1&page=2" title="Example Page 2">
    Example Page 2
    </a>
  </li>
  <li>
    <a href="?category=1&page=3" title="Example Page 3">
    Example Page 3
    </a>
  </li>
</ul>
 
?>

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="?page=5&category=1" class="active">Example Page 1</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=5&category=1" class="active">Example Page 1</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 1',
    'href'               => '?page=5&category=1',
    'pageDate'           => '2000-12-31',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'pageId' or 'id'     => 5,
    'categoryId'         => 1
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="?page=8&category=1">Example Page 2</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=8&category=1">Example Page 2</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 2',
    'href'               => '?page=8&category=1',
    'pageDate'           => '2000-10-10',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393465, // 'date' and 'start' is the same
                    'start' => 1325393465,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 8,
    'categoryId'         => 1
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="?page=9&category=1">Example Page 3</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=9&category=1">Example Page 3</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 3',
    'href'               => '?page=9&category=1',
    'pageDate'           => '2000-10-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393322, // 'date' and 'start' is the same
                    'start' => 1325393322,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 9,
    'categoryId'         => 1
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created sub menu in an array, ready to display in a HTML-page, or an empty array

Additional

example: $id parameter example
see: createMenuFromCategory()
see: Feindura::createLink()
see: Feindura::createMenu()
access: public

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2459

array createSubMenuOfSubCategory (

[int|string|bool $categoryId = false],
[int|bool $menuTag = false],
[string|bool $linkText = true],
[bool $sortPages = false],
[bool $reverseList = false])

Parameters

int\|string\|bool	$categoryId	(optional) a category ID, or a string with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$category property. Default false
int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div" Default false
string\|bool	$linkText	(optional) a string with a linktext which all links will use, if TRUE it uses the page titles of the pages, if FALSE no linktext will be used Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name createSubMenuOfSubCategory()

Alias createSubMenuOfCategory()
Alias createSubMenuFromSubCategory()
Alias createSubMenuFromCategory()
Alias createMenuFromSubCategory()
Alias createMenuOfSubCategory()

This method uses the $link..., $menu... and $thumbnail... properties.

Creates a sub menu from a subcategory. If the category is not a sub category it will return an empty array.
In case no category with the given page ID exist, or it is not a subcategory it returns an empty array.

Note: The $menuTag parameter can be an "menu", "ul", "ol" or "table", it will then create the necessary child HTML-tags of this element. If its any other tag name it just enclose the links with this HTML-tag.
Note: If the $id parameter is FALSE or empty, it uses the current category (means the Feindura::$category property).
Note: It will add the Feindura::$linkActiveClass property as a CSS class to the link (and also its wrapping element, e.g. <li> or <td>), when the links page is matching the current page, or the current page is a sub page of the links page.

You can use this function in conjunction with Feindura::createSubMenuOfPage() to display the submenu, even if you're in a page of the subcategory.
Show Example

 <?php
 
 // we use "false", because we use the current page and category.
 // NOTE: we need the double (), otherwise it would use the assignment of the $subMenu variable as condition!
 if(($subMenu = $feindura->createSubMenuOfPage(false,'ul')) || // will create the menu when inside the page which has a subcategory
    ($subMenu = $feindura->createMenuOfSubCategory(false,'ul'))) { // will create the menu when inside a page within a subcategory
 
   foreach($subMenu as $item)
     echo $item['menuItem'];
 }
 
 ?>

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="?page=5&category=1" class="active">Example Page 1</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=5&category=1" class="active">Example Page 1</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 1',
    'href'               => '?page=5&category=1',
    'pageDate'           => '2000-12-31',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'pageId' or 'id'     => 5,
    'categoryId'         => 1
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="?page=8&category=1">Example Page 2</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=8&category=1">Example Page 2</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 2',
    'href'               => '?page=8&category=1',
    'pageDate'           => '2000-10-10',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393465, // 'date' and 'start' is the same
                    'start' => 1325393465,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 8,
    'categoryId'         => 1
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="?page=9&category=1">Example Page 3</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=9&category=1">Example Page 3</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 3',
    'href'               => '?page=9&category=1',
    'pageDate'           => '2000-10-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393322, // 'date' and 'start' is the same
                    'start' => 1325393322,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 9,
    'categoryId'         => 1
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created sub menu in an array, ready to display in a HTML-page, or an empty array

Additional

example: See the example of the createSubMenuOfPage() method
see: Feindura::createSubMenuOfPage()
see: Feindura::createLink()
see: Feindura::createMenu()
access: public

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2567

array createLanguageMenu (

[int|bool $menuTag = false],
[string|bool $linkText = true])

Parameters

int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div" Default false
string\|bool	$linkText	(optional) a string with a linktext which all links will use, if TRUE it uses the page titles of the pages, if FALSE no linktext will be used Default true

Description

Name createLanguageMenu()
Alias createLanguagesMenu()

This method uses the $link..., $menu... properties.

Creates a menu as language selection for the multi language website feature. In case that the multi language website feature is deactivated it returns an empty array.

Note: The $menuTag parameter can be an "menu", "ul", "ol" or "table", it will then create the necessary child HTML-tags for this element. If its any other tag name it just enclose the links with this HTML-tag.
Note: It will add the Feindura::$linkActiveClass property as CSS class to the link, which is matching the current language.

Example Usage:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example uses no extra properties. To see an example using all the properties, see the createMenu() method example.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// will create a <ul> language menu
$menu = $feindura->createLanguageMenu('ul.langMenu');
 
// displays the menu
foreach($menu as $item) {
  echo $item['item'];
}
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<ul class="langMenu">
  <li><a href="/en/page/current-page-with-english-title" title="English">
  English
  </a></li>
  <li><a href="/nl/page/current-page-with-dutch-title" title="Dutch">
  Dutch
  </a></li>
</ul>
 
?>

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="/en/page/english-page" class="active">English</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="/en/page/english-page" class="active">English</a>',
    'endTag'             => '</li>',
    'href'               => '/en/page/english-page',
    'flag'               => '/cms/library/images/icons/flags/en.png',
    'language'           => 'en'
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="/de/page/deutsche-seite">German</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="/de/page/deutsche-seite">German</a>',
    'endTag'             => '</li>',
    'href'               => '/de/page/deutsche-seite',
    'flag'               => '/cms/library/images/icons/flags/de.png',
    'language'           => 'de'
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="/fr/page/french-site">French</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="/fr/page/french-site">French</a>',
    'endTag'             => '</li>',
    'href'               => '/fr/page/french-site',
    'flag'               => '/cms/library/images/icons/flags/fr.png',
    'language'           => 'fr'
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created menu in an array, ready to display in a HTML-page, or an empty array

Additional

access: public

Uses

Feindura::$menuId
Feindura::$menuClass
Feindura::$menuAttributes
Feindura::$linkLength
Feindura::$linkId
Feindura::$linkClass
Feindura::$linkActiveClass
Feindura::$linkAttributes
Feindura::$linkBefore
Feindura::$linkAfter
Feindura::$linkBeforeText
Feindura::$linkAfterText
Feindura::$adminConfig
FeinduraBase::generateMenu() - to generate the final menu

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2698

array createBreadCrumbsMenu (

Parameters

int\|string\|array\|bool	$id	(optional) a page ID, array with page and category ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. See Additional -> $id parameter example Default false
string\|false	$separator	(optional) a string which will be used as separator or FALSE to dont use a separator string Default ' > '
int\|bool	$menuTag	(optional) the tag which is used to create the menu, can be an "ul", "ol", "array('table',<number until new row>)" or any other tag, if TRUE it uses "div" Default false

Description

Name createBreadCrumbsMenu()

Alias createBreadCrumbMenu()
Alias createBreadCrumbs()
Alias createBreadCrumb()

This method uses the $link..., $menu... and $thumbnail... properties.

Creates a breadcrumb navigation for the given page. In case no page with the given category or page ID(s) exist it returns an empty array.

Note: If the $id parameter is FALSE or empty, it uses the current page (means the Feindura::$page property).
Note: The $menuTag parameter can be an "menu", "ul", "ol" or "table", it will then create the necessary child HTML-tags for this element. If its any other tag name it just enclose the links with this HTML-tag.

Example of the returned Array:
Show Example

<?php
 
array(
  array(
    'menuItem' or 'item' => '<ul>',
    'startTag'           => '<ul>'
    ),
  array(
    'position'           => 'first',
    'active'             => true,
    'menuItem' or 'item' => '<li class="active"><a href="?page=5&category=1" class="active">Example Page 1</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=5&category=1" class="active">Example Page 1</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 1',
    'href'               => '?page=5&category=1',
    'pageDate'           => '2000-12-31',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'pageId' or 'id'     => 5,
    'categoryId'         => 1
    ),
  array(
    'position'           => 2,
    'menuItem' or 'item' => '<li><a href="?page=8&category=1">Example Page 2</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=8&category=1">Example Page 2</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 2',
    'href'               => '?page=8&category=1',
    'pageDate'           => '2000-10-10',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393465, // 'date' and 'start' is the same
                    'start' => 1325393465,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 8,
    'categoryId'         => 1
    ),
  array(
    'position'           => 'last',
    'menuItem' or 'item' => '<li><a href="?page=9&category=1">Example Page 3</a></li>',
    'startTag'           => '<li>',
    'link'               => '<a href="?page=9&category=1">Example Page 3</a>',
    'endTag'             => '</li>',
    'title'              => 'Example Page 3',
    'href'               => '?page=9&category=1',
    'pageDate'           => '2000-10-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393322, // 'date' and 'start' is the same
                    'start' => 1325393322,
                    'end'   => 0
                    ),
    'pageId' or 'id'     => 9,
    'categoryId'         => 1
    ),
  array(
    'menuItem' or 'item' => '</ul>',
    'endTag'             => '</ul>'
    )
  )
  
?>

Return Value

array - the created breadcrumb navigation, or an empty array

Additional

example: $id parameter example
access: public

Uses

Feindura::$menuId
Feindura::$menuClass
Feindura::$menuAttributes
Feindura::$linkLength
Feindura::$linkId
Feindura::$linkClass
Feindura::$linkActiveClass
Feindura::$linkAttributes
Feindura::$linkBefore
Feindura::$linkAfter
Feindura::$linkBeforeText
Feindura::$linkAfterText
Feindura::$linkShowThumbnail
Feindura::$linkShowThumbnailAfterText
Feindura::$linkShowPageDate
Feindura::$linkPageDateSeparator
Feindura::$linkShowCategory - This is set to FALSE for all links, which are in a sub category (So the sub category name doesn't appear). You can change the separator between the category and the page name by setting the Feindura::$linkCategorySeparator
Feindura::$linkCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::getIdsFromString() - to load the right page and category IDs depending on the $ids parameter
Feindura::readPage()
GeneralFunctions::getParentPages() - to get the parent pages in an array

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2828

string showTitle (

[int|string|array|bool $id = false])

Parameters

int|string|array|bool

$id

(optional) a page ID, array with page and category ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property.
See Additional -> $id parameter example
Default false

Description

Name showTitle()
Alias getPageTitle()
Alias getTitle()

This method uses the $title... properties.

Returns the title of a page. This page title will be generated using the title properties.

Note: If the $id parameter is empty or FALSE it uses the Feindura::$page property.

Example:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example uses all possible properties.
It's also works much more simple: just call createLink(1) without setting properties
and you have a simple link with the page title.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// set title properties
$feindura->titleLength =              10;
$feindura->titleAsLink =              true;
$feindura->titleShowPageDate =        true;
$feindura->titlePageDateSeparator =   ' - ';
$feindura->titleShowCategory =        true;
$feindura->titleCategorySeparator =   ' -> ';
 
 
// finally create the title from the page with ID "1" using the above set title properties
$title = $feindura->getPageTitle(1);
 
// displays the link
echo $title;
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<a href="?category=1&amp;page=3" title="Example Category 1 -> 31.12.2010 - Example Page">
Example Category -> 31.12.2010 - Example...
</a>
 
?>

Return Value

string - the generated page title, ready to display in a HTML-page, or FALSE if the page doesn't exist or is not public

Additional

example: $id parameter example
see: FeinduraBase::createTitle()
access: public

Uses

Feindura::$titleLength
Feindura::$titleAsLink
Feindura::$titleShowPageDate
Feidnura::$titlePageDateSeparator
Feindura::$titleShowCategory
Feindura::$titleCategorySeparator
FeinduraBase::getIdsFromString() - to load the right page and category IDs depending on the $ids parameter
FeinduraBase::createTitle() - to generate the page title with the right title properties
GeneralFunctions::getPageCategory() - to get the category of the page
GeneralFunctions::isPublicCategory() - to check whether the category is public

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 2936

array showPage (

Parameters

int\|string\|array\|bool	$id	(optional) a page ID, array with page and category ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. See Additional -> $id parameter example Default false
int\|array\|bool	$shortenText	(optional) number of the maximal text length displayed, adds a "more" link at the end or FALSE to not shorten. You can also pass an array: value 1: text length as int, value 2: text string for the link, or a link string. e.g. array(23,false), array(23,'read more'), or array(23,'<a href="%href%"'>read more</a>'). (the `%href%` will be replaced by the pages href) Default false
bool\|string	$useHtml	(optional) whether the content of the page has HTML-tags or not. It also accepts a string with allowed html tags. Default true

Description

Name showPage()
Alias showPages()

This method uses the $error..., $title... and $thumbnail... properties.

Returns an array which contains all elements of the page, ready for displaying in a HTML-page.

In case the page doesn't exists or is not public and the Feindura::$showErrors property is TRUE, an error will be placed in the ['content'] part of the returned array, otherwiese it returns an empty array.

Note: If the $id parameter is empty or FALSE it uses the Feindura::$page property.

Example usage:
Show Example

<?php
/*                               *** SIMPLE EXAMPLE *** 
-------------------------------------------------------------------------------- */
 
// add before any HTML Tag. (eg. before the <!doctype html>)
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// get the page, which is currently selected, if not page is selected it uses the $feindura->startPage property
$currentPage = $feindura->showPage();
 
// displays the page
echo '<h1>'.$page['title'].'</h1>';
echo $page['content'];
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<h1>Example Page 1</h1>
 
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
 
 
/*                               *** EXTENDED EXAMPLE *** 
--------------------------------------------------------------------------------
This example uses all possible properties.
It's also works much more simple: just call showPage() without setting properties
and it shows the current page given by the $_GET variable.
*/
 
// add before any HTML Tag. (eg. before the <!doctype html>)
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
// set properties
$feindura->xHtml =                  true;
 
$feindura->titleLength =            20;
$feindura->titleAsLink =            true;
$feindura->titleShowPageDate =      true;
$feindura->titlePageDateSeparator = ' - ';
$feindura->titleShowCategory =      false; // would have no effect, because page with ID "1" has no category
$feindura->titleCategorySeparator = ' -> '; // would have no effect, because $titleShowCategory = FALSE
 
$feindura->thumbnailAlign =         'left';
$feindura->thumbnailId =            'thumbId';
$feindura->thumbnailClass =         'thumbCLass';
$feindura->thumbnailAttributes =    'test="exampleAttribute1" onclick="exampleAttribute2"';
$feindura->thumbnailBefore =        false;
$feindura->thumbnailAfter =         false;
 
$feindura->showErrors =              true;
$feindura->errorTag =               'div.alertClass';
 
 
// finally, get the page, with ID "1", using the above set properties
$page = $feindura->showPage(1);
 
// displays the page (the "\n" creates a line break for a better look)
echo $page['title'];
echo $page['thumbnail'];
echo $page['content'];
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<a href="?page=1" title="2010-12-31 - Example Page">
2010-12-31 - Example...
</a>
<img src="/path/thumb_page3.png" class="feinduraThumbnail" alt="Thumbnail" title="Example Page 1" id="thumbId"
class="thumbCLass" test="exampleAttribute1" onclick="exampleAttribute2" style="float:left;">
 
<h2>Example Headline</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
<p>Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam...</p>
 
 
                          *** RESULT with error *** 
--------------------------------------------------------------------------------
 
 
<div class="alertClass">
The requested page is deactivated.
</div>
 
?>

Example of the returned array:
Show Example

<?php
 
array(
  'pageId' or 'id'    => 1,
  'category'          => 'Example Category',
  'categoryId'        => 3,
  'subCategory'       => 'Another Category',
  'subCategoryId'     => 4,
  'pageDate'          => '2000-12-31 - 2010-01-15', // depending on the date format settings in the backend
  'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
  'title'             => 'Title Example',
  'thumbnail'         => '<img src="/path/thumb_page1.png" class="feinduraThumbnail" alt="Thumbnail" title="Title Example">',
  'thumbnailPath'     => '/path/thumb_page1.png',
  'content'           => "\n".'<p>Content Text</p>'."\n",
  'description'       => 'Short description of the page',
  'tags'              => 'tag1,tag2,tag3',
  'href'              => '?category=3&page=1', // or a speaking url, if activated
  'plugins'           => array( // each activated plugin with its page specific settings
          'imageGallery' => array(
              'active'          => true,
              'galleryPath'     => '/upload/gallery/',
              'imageWidth'      => 800,
              'imageHeight'     => null,
              'thumbnailWidth'  => 160,
              'thumbnailHeight' => null,
              'tag'             => 'table',
              'breakAfter'      => 3
          ),
          'pageRating' => array(
              'active' => false,
              'value'  => 0,
              'votes'  => 0
          )
      ),
  'error'             => false // will be set to TRUE when the page doesn't exist or is deactivated
  )
 
?>

Return Value

array - with the page elements, ready to display in a HTML-page, or FALSE if the page doesn't exist or is not public

Additional

example: $id parameter example
see: getPageTitle()
see: FeinduraBase::generatePage()
access: public

Uses

Feindura::$page
Feindura::$xHtml
Feindura::$showErrors
Feindura::$errorTag
Feindura::$titleLength
Feindura::$titleAsLink
Feindura::$titleShowPageDate
Feindura::$titlePageDateSeparator
Feindura::$titleShowCategory
Feindura::$titleCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::getIdsFromString() - to load the right page and category IDs depending on the $ids parameter
FeinduraBase::generatePage() - to generate the array with the page elements
GeneralFunctions::getPageCategory() - to get the category of the page

Version

1.0.1
ChangeLog
- 1.0.1 fixed display of error, was not working anymore
- 1.0 initial release

File source:
line 2996

bool hasPlugins (

[string|array|true $plugins = true],
[int|string|bool $ids = false])

Parameters

string\|array\|true	$plugins	(optional) the plugin name or an array with plugin names or TRUE to load all plugins Default true
int\|string\|bool	$ids	a page ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. (See examples) (can also be a $pageContent array) Default false

Description

Name hasPlugins()

Alias hasPlugin()
Alias isPlugins()
Alias isPlugin()

Check whether the given plugin(s) are activated for the given page.

Note: If the $ids parameter is empty or FALSE it uses the Feindura::$page property.

Example $ids parameters:
Show Example

<?php
  // The "next","previous","first" and "last" is always relative to the current $this->page and $this->category property.
  // If there is an ID, "prev" or "next" for the page value, it will always discard the category value and load the right page.
  // Note: When using "previous","next","first" or "last" it will jump over pages/categories which are not public and return the next one.
 
  empty                  // load the current page
  false/true             // same as above
  array(false,false)     // same as above
 
  2                      // load page with ID 2
  'rand'                 // load a random page of the current category
  array('rand',false)    // same as above
 
  'next'                 // load the next page in the current category
  array('next',false)    // the same as above
  array('next','rand')   // the same as above (it would discard the category ID)
  array(2,45)            // load the page with ID 2 (it would discard the category ID)
 
  array(false,3)         // load the first page of category with ID 3
 
  array(false,'next')    // load the first page of the next category
  array(false,'prev')    // load the first page of the previous category
 
  array('last',false)    // load the last page of the current category
  array('last','next')   // load the last page of the next category
  array('first','last')  // load the first page of the last category
 
  array('rand','next')   // load a random page of the next category
  array('rand','rand')   // load a random page of a random category
  array('first','rand')  // load the first page of a random category
 
  ...
 
?>

Return Value

bool - whether the plugin(s) are activated or not

Additional

see: getPageTitle()
see: Feindura::showPlugins()
see: FeinduraBase::generatePage()
access: public

Uses

Feindura::$page
Feindura::showPlugins() - to check for the activated plugins
FeinduraBase::getIdsFromString() - to load the right page and category IDs depending on the $ids parameter
FeinduraBase::generatePage() - to generate the array with the page elements
GeneralFunctions::getPageCategory() - to get the category of the page

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3070

array|string|false showPlugins (

Parameters

string\|array\|true	$plugins	(optional) the plugin name or an array with plugin names or TRUE to load all plugins. If its a plugin name and you want the plugin number 2. etc, you need to add the plugin number like "imageGallery#2". Default true
int\|string\|array\|bool	$id	(optional) a page ID, array with page and category ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. See Additional -> $id parameter example Default false
string\|false	$divStyles	(optional) a string with styles, which will be add to the warapping div of the plugin. In the format: "witdh: 200px; height: 100px;" Default false
bool	$returnPlugin	(optional) whether the plugin is returned, or only a boolean to check if the plugin is available for that page (used by Feindura::hasPlugins()) Default true

Description

Name showPlugins()
Alias showPlugin()

Returns the plugin(s) of a page ready for displaying in a HTML page. It can return an array where each element contain the HTML of a plugin (only the activated ones), or if the $plugins parameter is a string with a plugin name (the foldername of the plugin, inside "../feindura_folder/plugins/"), it returns only a string with the HTML of this plugin.

Note: If the $id parameter is empty or FALSE it uses the Feindura::$page property.

Example usage:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example gets all plugins which are activated in the page with ID "2".
You can also request only single plugins, it will then only return a string, with the HTML of the plugin.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// get the all plugins from the page with ID "2"
$plugins = $feindura->showPlugins(true,2);
// you could also call
// $plugins = $feindura->showPlugins('imageGallery');
// it would get the imageGallery plugin of the current page
 
// displays the page (the "\n" creates a line break for a better look)
foreach($plugins as $plugin) {
  echo $plugin;
  echo '------';
}
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<p>HTML created by the Plugin</p>
<span>What it is depends on the plugin :-)</span>
-----
<h1>Another plugin which follows the first one</h1>
<p>You can also call specific plugins directly. To do that
give it the plugin name, instead of "TRUE".</p>
-----
 
?>

Example of the returned array:
Show Example

<?php
/* If you call this method and you give as $plugin parameter only a string with a pluginName,
it returns only a string with this plugin content */
 
$plugins['aPlugin']     = '<p>HTML code created by the Plugin</p>
                             <span>What it is depends on the plugin</span>';
$plugins['anotherPlugin'] = '<p>Another plugin resulting HTML code</p>';
...
 
return $plugins;
  
?>

Return Value

array|string|false - If a single plugin name is given it returns the plugins HTML-code, ready to display in a HTML-page, otherwise array with plugins, an empty array, or FALSE if the plugin(s) or page doesn't exist or the page is not public

Additional

see: getPageTitle()
see: FeinduraBase::generatePage()
example: $id parameter example
access: public

Used By

Feindura::hasPlugins() - to check for the activated plugins

Uses

Feindura::$page
FeinduraBase::getIdsFromString() - to load the right page and category IDs depending on the $ids parameter
FeinduraBase::generatePage() - to generate the array with the page elements
GeneralFunctions::getPageCategory() - to get the category of the page

Version

1.1
ChangeLog
- 1.1 add plugin numbers, to be able to add multile plugins of the same type
- 1.0 initial release

File source:
line 3203

array|false hasTags (

string|array $tags,
string $idType,
int|array|bool $ids)

Parameters

string\|array	$tags	an string (seperated by ",") or an array with tags to compare
string	$idType	the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages"
int\|array\|bool	$ids	the category or page ID(s), can be a number or an array with numbers, if TRUE it checks all pages tags

Description

Name hasTags()

Load the $pagesMetaData array of pages which have one or more tags from the given $tags parameter.
Can be used to count pages with specific tags, like in the following example.
Show Example

 <?php
 
 include('cms/feindura.include.php');
 $feindura = new Feindura();
 
 echo $feindura->hasTags('example tag', 'category', 1);
 
 // RESULT
 3 (means 3 pages in category 1 have the 'example tag')
 
 ?>

Note: the tags will be compared case insensitive.

Return Value

array|false - an array of $pageContent arrays or FALSE if no $pageContent array has any of the given tags

Additional

access: public

Uses

FeinduraBase::checkPagesForTags() - to check pages for tags

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3282

array listPages (

Parameters

string	$idType	(optional) the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages" Default 'category'
int\|array\|bool	$ids	(optional) the category or page ID(s), can be a number or an array with numbers (can also be a $pageContent array), if TRUE it loads all pages, if FALSE it uses the Feindura::$page or Feindura::$category property Default false
int\|array\|bool	$shortenText	(optional) number of the maximal text length displayed, adds a "more" link at the end or FALSE to not shorten. You can also pass an array: value 1: text length as int, value 2: text string for the link, or a link string. e.g. array(23,false), array(23,'read more'), or array(23,'<a href="%href%"'>read more</a>'). (the `%href%` will be replaced by the pages href) Default false
bool\|string	$useHtml	(optional) whether the content of the page has HTML-tags or not. It also accepts a string with allowed html tags. Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name listPages()
Alias listPage()

This method uses the $error..., $title... and $thumbnail... properties.

List pages by given category(ies) or page(s).

Returns an array with multiple pages for displaying in a HTML-page.

In case no page with the given category or page ID(s) exist it returns an empty array.

Note: If the $ids parameter is FALSE it uses the Feindura::$page or Feindura::$category property depending on the $idType parameter.

Example usage:
Show Example

<?php
/*                               *** SIMPLE EXAMPLE *** 
-------------------------------------------------------------------------------- */
 
// add before any HTML Tag. (eg. before the <!doctype html>)
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// Get the pages from the category with ID "1"
// the page content will be shorten to "200" characters
$pages = $feindura->listPages('category',1,200);
 
// displays the pages
foreach($pages as $page) {
  echo '<h1>'.$page['title'].'</h1>';
  echo $page['content'];
  echo '<br>-----------------------<br>\n';
}
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<h1>Example Page 1</h1>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
<a href="?category=1&amp;page=1">mehr</a>
 
<br>-----------------------<br>
 
<h1>Example Page 2</h1>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
<a href="?category=1&amp;page=2">mehr</a>
 
<br>-----------------------<br>
 
 
/*                               *** EXTENDED EXAMPLE *** 
--------------------------------------------------------------------------------
This example uses all possible properties.
It's also works much more simple: just call listPages() without setting properties
and list the current category given by $_GET variable.
*/
 
// add before any HTML Tag. (eg. before the <!doctype html>)
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
// set properties
$feindura->xHtml =                  true;
 
$feindura->showErrors =              true;
$feindura->errorTag =               'div.alertClass';
 
$feindura->titleLength =            20;
$feindura->titleAsLink =            true;
$feindura->titleShowPageDate =      true;
$feindura->titlePageDateSeparator = ' - ';
$feindura->titleShowCategory =      false;
$feindura->titleCategorySeparator = ' -> '; // has no effect, because $titleShowCategory = FALSE
 
$feindura->thumbnailAlign =         'left';
$feindura->thumbnailId =            'thumbId';
$feindura->thumbnailClass =         'thumbCLass';
$feindura->thumbnailAttributes =    'test="exampleAttribute1" onclick="exampleAttribute2"';
$feindura->thumbnailBefore =        false;
$feindura->thumbnailAfter =         false;
 
 
// finally get the pages from the category with ID "1" and "2" using the above set properties
// the page content will be shorten to "200" characters
$pages = $feindura->listPages('category',array(1,2),200,true,true);
 
// displays the pages
foreach($pages as $page) {
  echo $page['title'];
  echo $page['thumbnail'];
  echo $page['content'];
  echo '<br>-----------------------<br>\n';
}
 
 
                               *** RESULT ***
--------------------------------------------------------------------------------
 
 
<a href="?category=1&amp;page=2" title="2010-12-31 - Example Page 2">
2010-12-31 - Example...
</a>
<h2>Example Headline 2</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
<a href="?category=1&amp;page=2">mehr</a>
 
<br>-----------------------<br>
 
<a href="?category=1&amp;page=3" title="2010-12-31 - Example Page 2">
2010-12-31 - Example...
</a>
<h2>Another Example Headline</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.</p>
<h2>And one more Example Headline</h2>
<p>Stet clita kasd gubergren, no sea takimata sanctus est...</p>
<a href="?category=1&amp;page=3">mehr</a>
 
<br>-----------------------<br>
 
<a href="?category=2&amp;page=1" title="Example Page 1">
Example Page 1
</a>
<img src="/path/thumb_page3.png" class="feinduraThumbnail" alt="Thumbnail" title="Example Page 1" id="thumbId"
class="thumbCLass" test="exampleAttribute1" onclick="exampleAttribute2" style="float:left;">
<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor
invidunt ut labore et dolore magna aliquyam erat, ur sadipscing elitr,
Stet clita kasd...</p>
<a href="?category=2&amp;page=1">mehr</a>
 
<br>-----------------------<br>
 
?>

Example of the returned array:
Show Example

<?php
 
array(
 
  0 => array(
    'position'          => 'first', // is the first page in the returned pages list
    'pageId' or 'id'    => 1,
    'category'          => 'A Category',
    'categoryId'        => 1,
    'subCategory'       => 'Another Category',
    'subCategoryId'     => 2,
    'pageDate'          => '2010-12-31', // format depending on the administrator-settings
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 0
                    ),
    'title'             => 'Title Example 1',
    'thumbnail'         => false, // page has no thumbnail
    'thumbnailPath'     => false,
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag1,tag2,tag3',
    'href'              => '?category=1&page=1', // or a speaking url, if activated
    'plugins'           => array (
        'imageGallery' => array(
                'galleryPath'     => '',
                'imageWidth'      => 800,
                'imageHeight'     => null,
                'thumbnailWidth'  => 160,
                'thumbnailHeight' => null,
                'tag'             => 'table',
                'breakAfter'      => 3
                )
        )
    ),
   
   1 => array(
    'position'          => 2,
    'pageId' or 'id'    => 5,
    'category'          => 'A Category',
    'categoryId'        => 1,
    'subCategory'       => false,
    'subCategoryId'     => false,
    'pageDate'          => '2009-12-31 - 2010-01-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'title'             => 'Title Example 2',
    'thumbnail'         => false,
    'thumbnailPath'     => false,
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag3,tag4',
    'href'              => '?category=1&page=5',
    'plugins'           => array ()
    ),
  
   2 => array(
    'position'          => 'last', // is the last page in the returned pages list
    'pageId' or 'id'    => 8,
    'category'          => 'Another Category',
    'categoryId'        => 2,
    'subCategory'       => false,
    'subCategoryId'     => false,
    'pageDate'          => false, // page has no page date
    'pageDateTimestamp' => false,
    'title'             => 'Title Example 3',
    'thumbnail'         => '<img src="/path/thumb_page3.png" class="feinduraThumbnail" alt="Thumbnail" title="Title Example 3">',
    'thumbnailPath'     => '/path/thumb_page3.png',
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag3,tag1',
    'href'              => '?category=2&page=8', 
    'plugins'           => array ()
    )
  )
  
?>

Return Value

array - array with page arrays,containing content and title etc., ready to display in a HTML-page, or an empty array

Additional

Used By

Feindura::listSubPages() - to get the pages
Feindura::listSubCategory() - to get the pages
Feindura::listPagesByTags() - to list the pages
Feindura::listPagesByDate() - to list the pages

Uses

Feindura::$xHtml
Feindura::$showErrors
Feindura::$errorTag
Feindura::$titleLength
Feindura::$titleAsLink
Feindura::$titleShowPageDate
Feindura::$titleShowCategory
Feindura::$titleCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::getPropertyIdsByType() - if the $ids parameter is FALSE it gets the property category or page ID, depending on the $idType parameter
FeinduraBase::loadPagesByType() - to load the page $pageContent array(s) from the given ID(s)
FeinduraBase::generatePage() - to generate every page which will be listed
GeneralFunctions::sortPages() - to sort the $pageContent arrays by category

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3407

array listSubPages (

Parameters

int\|string\|array\|bool	$id	(optional) a page ID, array with page and category ID, or a string/array with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$page property. See Additional -> $id parameter example Default false
int\|array\|bool	$shortenText	(optional) number of the maximal text length displayed, adds a "more" link at the end or FALSE to not shorten. You can also pass an array: value 1: text length as int, value 2: text string for the link, or a link string. e.g. array(23,false), array(23,'read more'), or array(23,'<a href="%href%"'>read more</a>'). (the `%href%` will be replaced by the pages href) Default false
bool\|string	$useHtml	(optional) whether the content of the page has HTML-tags or not. It also accepts a string with allowed html tags. Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name listSubPages()
Alias listSubPage()

This method uses the $error..., $title... and $thumbnail... properties.

List pages of the subcategory of a given page.

Returns an array with multiple pages for displaying in a HTML-page.
In case no page with the given category or page ID(s) exist it returns an empty array.

Note: If the $id parameter is FALSE or empty, it uses the current page (means the Feindura::$page property).
b>Note</b>: It will add the Feindura::$linkActiveClass property as a CSS class to the link (and also its wrapping element, e.g. <li> or <td>), when the links page is matching the current page, or the current page is a sub page of the links page.

Example:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example uses no extra properties. To see an example using all the properties, see the createMenu() method example.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// will list the subpages of the current page. The 200 is the maximum number of characters we want to display
foreach($feindura->listSubPages(false,200) as $subPage) {
   echo '<h1>'.$subPage['title'].'</h1>';
   echo $subPage['content']."\n";
   echo "<br>-----------------------<br>\n";
}
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
<h1>Example SubPage 1</h1>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
<a href="?category=1&amp;page=2">mehr</a>
 
<br>-----------------------<br>
 
<h1>Example SubPage 2</h1>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.</p>
<h2>And one more Example Headline</h2>
<p>Stet clita kasd gubergren, no sea takimata sanctus est...</p>
<a href="?category=1&amp;page=3">mehr</a>
 
<br>-----------------------<br>
 
?>

Example of the returned Array:
Show Example

<?php
 
array(
 
  0 => array(
    'position'          => 'first', // is the first page in the returned pages list
    'pageId' or 'id'    => 1,
    'category'          => 'A Category',
    'categoryId'        => 1,
    'subCategory'       => 'Another Category',
    'subCategoryId'     => 2,
    'pageDate'          => '2010-12-31', // format depending on the administrator-settings
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 0
                    ),
    'title'             => 'Title Example 1',
    'thumbnail'         => false, // page has no thumbnail
    'thumbnailPath'     => false,
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag1,tag2,tag3',
    'href'              => '?category=1&page=1', // or a speaking url, if activated
    'plugins'           => array (
        'imageGallery' => array(
                'galleryPath'     => '',
                'imageWidth'      => 800,
                'imageHeight'     => null,
                'thumbnailWidth'  => 160,
                'thumbnailHeight' => null,
                'tag'             => 'table',
                'breakAfter'      => 3
                )
        )
    ),
   
   1 => array(
    'position'          => 2,
    'pageId' or 'id'    => 5,
    'category'          => 'A Category',
    'categoryId'        => 1,
    'subCategory'       => false,
    'subCategoryId'     => false,
    'pageDate'          => '2009-12-31 - 2010-01-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'title'             => 'Title Example 2',
    'thumbnail'         => false,
    'thumbnailPath'     => false,
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag3,tag4',
    'href'              => '?category=1&page=5',
    'plugins'           => array ()
    ),
  
   2 => array(
    'position'          => 'last', // is the last page in the returned pages list
    'pageId' or 'id'    => 8,
    'category'          => 'Another Category',
    'categoryId'        => 2,
    'subCategory'       => false,
    'subCategoryId'     => false,
    'pageDate'          => false, // page has no page date
    'pageDateTimestamp' => false,
    'title'             => 'Title Example 3',
    'thumbnail'         => '<img src="/path/thumb_page3.png" class="feinduraThumbnail" alt="Thumbnail" title="Title Example 3">',
    'thumbnailPath'     => '/path/thumb_page3.png',
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag3,tag1',
    'href'              => '?category=2&page=8', 
    'plugins'           => array ()
    )
  )
  
?>

Return Value

array - array with page arrays of the subcategory,containing content and title etc., ready to display in a HTML-page, or an empty array

Additional

example: $id parameter example
see: createMenuFromCategory()
see: Feindura::createLink()
see: Feindura::createMenu()
access: public

Uses

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3507

array listSubCategory (

Parameters

int\|string\|bool	$categoryId	(optional) a category ID, or a string with "previous","next","first","last" or "random". If FALSE it uses the Feindura::$category property. Default false
int\|array\|bool	$shortenText	(optional) number of the maximal text length displayed, adds a "more" link at the end or FALSE to not shorten. You can also pass an array: value 1: text length as int, value 2: text string for the link, or a link string. e.g. array(23,false), array(23,'read more'), or array(23,'<a href="%href%"'>read more</a>'). (the `%href%` will be replaced by the pages href) Default false
bool\|string	$useHtml	(optional) whether the content of the page has HTML-tags or not. It also accepts a string with allowed html tags. Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name listSubCategory()
Alias listPagesOfSubCategory()
Alias listPagesFromSubCategory()

This method uses the $error..., $title... and $thumbnail... properties.

List the pages of a subcategory.
In case no category with the given page ID exist, or it is not a subcategory it returns an empty array.

Note: If the $id parameter is FALSE or empty, it uses the current category (means the Feindura::$category property).

You can use this function in conjunction with Feindura::listSubPages() to list subpages, even if you're in a page of the subcategory.
Show Example

 <?php
 
 // we use "false", because we use the current page and category. The 200 is the number of maximum characters we want to display.
 // NOTE: we need the double (), otherwise it would use the assignment of the $subMenu variable as condition!
 if(($subPages = $feindura->listSubPages(false,200)) || // will list the subpages when inside the page which has a subcategory
    ($subPages = $feindura->listPagesOfSubCategory(false,200))) { // will list the subpages when inside a page within a subcategory
 
   foreach($subPages as $subPage) {
     echo '<h1>'.$subPage['title'].'</h1>';
     echo $subPage['content'];
   }
 }
 
 ?>

Example of the returned Array:
Show Example

<?php
 
array(
 
  0 => array(
    'position'          => 'first', // is the first page in the returned pages list
    'pageId' or 'id'    => 1,
    'category'          => 'A Category',
    'categoryId'        => 1,
    'subCategory'       => 'Another Category',
    'subCategoryId'     => 2,
    'pageDate'          => '2010-12-31', // format depending on the administrator-settings
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 0
                    ),
    'title'             => 'Title Example 1',
    'thumbnail'         => false, // page has no thumbnail
    'thumbnailPath'     => false,
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag1,tag2,tag3',
    'href'              => '?category=1&page=1', // or a speaking url, if activated
    'plugins'           => array (
        'imageGallery' => array(
                'galleryPath'     => '',
                'imageWidth'      => 800,
                'imageHeight'     => null,
                'thumbnailWidth'  => 160,
                'thumbnailHeight' => null,
                'tag'             => 'table',
                'breakAfter'      => 3
                )
        )
    ),
   
   1 => array(
    'position'          => 2,
    'pageId' or 'id'    => 5,
    'category'          => 'A Category',
    'categoryId'        => 1,
    'subCategory'       => false,
    'subCategoryId'     => false,
    'pageDate'          => '2009-12-31 - 2010-01-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'title'             => 'Title Example 2',
    'thumbnail'         => false,
    'thumbnailPath'     => false,
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag3,tag4',
    'href'              => '?category=1&page=5',
    'plugins'           => array ()
    ),
  
   2 => array(
    'position'          => 'last', // is the last page in the returned pages list
    'pageId' or 'id'    => 8,
    'category'          => 'Another Category',
    'categoryId'        => 2,
    'subCategory'       => false,
    'subCategoryId'     => false,
    'pageDate'          => false, // page has no page date
    'pageDateTimestamp' => false,
    'title'             => 'Title Example 3',
    'thumbnail'         => '<img src="/path/thumb_page3.png" class="feinduraThumbnail" alt="Thumbnail" title="Title Example 3">',
    'thumbnailPath'     => '/path/thumb_page3.png',
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag3,tag1',
    'href'              => '?category=2&page=8', 
    'plugins'           => array ()
    )
  )
  
?>

Return Value

array - array with page arrays of the subcategory,containing content and title etc., ready to display in a HTML-page, or an empty array

Additional

example: $id parameter example
see: createMenuFromCategory()
see: Feindura::createLink()
see: Feindura::createMenu()
access: public

Uses

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3597

array listPagesByTags (

Parameters

string\|array	$tags	a string with tags seperated by "," or ";" or an array with tags
string	$idType	(optional) the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages" Default 'category'
int\|array\|bool	$ids	(optional) the category or page ID(s), can be a number or an array with numbers (can also be a $pageContent array), if TRUE it loads all pages, if FALSE it uses the Feindura::$page or Feindura::$category property Default false
int\|array\|bool	$shortenText	(optional) number of the maximal text length displayed, adds a "more" link at the end or FALSE to not shorten. You can also pass an array: value 1: text length as int, value 2: text string for the link, or a link string. e.g. array(23,false), array(23,'read more'), or array(23,'<a href="%href%"'>read more</a>'). (the `%href%` will be replaced by the pages href) Default false
bool\|string	$useHtml	(optional) whether the content of the page has HTML-tags or not. It also accepts a string with allowed html tags. Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE they are sorted in the order of the given IDs. Can also be a sort function e.g. "sortByLastSaveDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name listPagesByTags()
Alias listPagesByTag(), listPageByTags(), listPageByTag()

This method uses the $error..., $title... and $thumbnail... properties.

List pages by given category(ies) or page(s), which have one or more of the tags from the given $tags parameter.

Returns an array with multiple pages for displaying in a HTML-page. In case no page with the given category or page ID(s) exist it returns an empty array.

Note: The tags will be compared case insensitive.
Note: If the $ids parameter is FALSE it uses the Feindura::$page or Feindura::$category property depending on the $idType parameter.

Example usage:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example shows only the usage of tags for listing pages,
for a detailed example see listPages()
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// the tags where the pages in the menu should have atleast one
$tags = 'winter summer spring';
// could also be an array like
// $tags = array(0 => 'winter', 1 => 'summer', 2 => 'spring');
 
 
// get the pages from the category with ID "1"
// the page content will be shorten to "200" characters
foreach($feindura->listPagesByTags($tags,'category',1,200) as $page) {
  echo $page['title'].'<br>
       Has the following Tags: '.$page['tags']."\n";
  echo $page['content']."\n";
  echo "<br>-----------------------<br>\n";
}
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
Example Page 1<br>
Has the following Tags: Winter antum
 
<h2>Example Headline</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
<a href="?category=1&amp;page=1">mehr</a>
 
<br>-----------------------<br>
 
Example Page 2<br>
Has the following Tags: winter spring summer
 
<h2>Another Example Headline</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.</p>
<h2>And one more Example Headline</h2>
<p>Stet clita kasd gubergren, no sea takimata sanctus est...</p>
<a href="?category=1&amp;page=2">mehr</a>
 
<br>-----------------------<br>
 
Example Page 3<br>
Has the following Tags: spring antum
 
<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor
invidunt ut labore et dolore magna aliquyam erat, ur sadipscing elitr,
Stet clita kasd...</p>
<a href="?category=1&amp;page=3">mehr</a>
 
<br>-----------------------<br>
 
?>

Return Value

array - array with page arrays,containing content and title etc., ready to display in a HTML-page, or an empty array

Additional

Uses

Feindura::$xHtml
Feindura::$showErrors
Feindura::$errorTag
Feindura::$titleLength
Feindura::$titleAsLink
Feindura::$titleShowPageDate
Feindura::$titleShowCategory
Feindura::$titleCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::getPropertyIdsByType() - if the $ids parameter is FALSE it gets the property category or page ID, depending on the $idType parameter
FeinduraBase::checkPagesForTags() - to get only the pages which have one or more tags from the given $tags parameter
Feindura::listPages() - to list the pages

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3693

array listPagesByDate (

Parameters

int\|bool\|string	$from	(optional) number of months in the past, if TRUE it show all pages in the past, if FALSE it loads only pages starting from the current date. Can also be a string with a date format (e.g. '2 weeks' or '27.06.2012'), for more details see: http://www.php.net/manual/en/datetime.formats.php Default true
int\|bool\|string	$to	(optional) number of months in the future, if TRUE it show all pages in the future, if FALSE it loads only pages until the current date. Can also be a string with a date format (e.g. '10 days' or '27.06.2012'), for more details see: http://www.php.net/manual/de/datetime.formats.php Default true
string	$idType	(optional) the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages" Default 'category'
int\|array\|bool	$ids	(optional) the category or page ID(s), can be a number or an array with numbers (can also be a $pageContent array), if TRUE it loads all pages, if FALSE it uses the Feindura::$page or Feindura::$category property Default false
int\|array\|bool	$shortenText	(optional) number of the maximal text length displayed, adds a "more" link at the end or FALSE to not shorten. You can also pass an array: value 1: text length as int, value 2: text string for the link, or a link string. e.g. array(23,false), array(23,'read more'), or array(23,'<a href="%href%"'>read more</a>'). (the `%href%` will be replaced by the pages href) Default false
bool\|string	$useHtml	(optional) whether the content of the page has HTML-tags or not. It also accepts a string with allowed html tags. Default true
bool	$sortPages	(optional) if TRUE it sorts the pages like they are sorted in the backend, if FALSE it sorts the pages by date (If date range: by start date). Can also be a sort function e.g. "sortByEndDate". See GeneralFunctions::sortPages() for more. Default false
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name listPagesByDate()
Alias listPagesByDates(), listPageByDate(), listPageByDates()

This method uses the $error..., $title... and $thumbnail... properties.

List pages by given a category(ies) or page(s) parameter. Applies for pages which have a page date (and page date is activated for that category!) and it fit in the given time period from the $from and the $to parameter (relative to the current date).

The $from and $to parameters can also be a string with a (relative or specific) date, for more information see: http://www.php.net/manual/de/datetime.formats.php.

Returns an array with multiple pages for displaying in a HTML-page. In case no page with the given category or page ID(s) exist it returns an empty array.

Note: If the $ids parameter is FALSE it uses the Feindura::$page or Feindura::$category property depending on the $idType parameter.

Example usage:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example shows only the usage of tags for listing pages,
for a detailed example see listPages()
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// the tags where the pages in the menu should have atleast one
$tags = 'winter summer spring';
// could also be an array like
// $tags = array(0 => 'winter', 1 => 'summer', 2 => 'spring');
 
 
// get the pages from the category with ID "1"
// the page content will be shorten to "200" characters
foreach($feindura->listPagesByTags($tags,'category',1,200) as $page) {
  echo $page['title'].'<br>
       Has the following Tags: '.$page['tags']."\n";
  echo $page['content']."\n";
  echo "<br>-----------------------<br>\n";
}
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
Example Page 1<br>
Has the following Tags: Winter antum
 
<h2>Example Headline</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
<a href="?category=1&amp;page=1">mehr</a>
 
<br>-----------------------<br>
 
Example Page 2<br>
Has the following Tags: winter spring summer
 
<h2>Another Example Headline</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.</p>
<h2>And one more Example Headline</h2>
<p>Stet clita kasd gubergren, no sea takimata sanctus est...</p>
<a href="?category=1&amp;page=2">mehr</a>
 
<br>-----------------------<br>
 
Example Page 3<br>
Has the following Tags: spring antum
 
<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor
invidunt ut labore et dolore magna aliquyam erat, ur sadipscing elitr,
Stet clita kasd...</p>
<a href="?category=1&amp;page=3">mehr</a>
 
<br>-----------------------<br>
 
?>

Return Value

array - array with page arrays,containing content and title etc., ready to display in a HTML-page, or an empty array

Additional

Uses

Feindura::$xHtml
Feindura::$showErrors
Feindura::$errorTag
Feindura::$titleLength
Feindura::$titleAsLink
Feindura::$titleShowPageDate
Feindura::$titleShowCategory
Feindura::$titleCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::loadPagesByDate() - to load the pages which fit in the given time period parameters, sorted by the page date
Feindura::listPages() - to list the pages

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3797

array listPagesBySortFunction (

Parameters

string	$sortCallback	the name of the callback function to sort the pages (uses usort()). For a list of predefined available functions see GeneralFunctions::sortPages()
string	$idType	(optional) the ID(s) type can be "cat", "category", "categories" or "pag", "page" or "pages" Default 'category'
int\|array\|bool	$ids	(optional) the category or page ID(s), can be a number or an array with numbers (can also be a $pageContent array), if TRUE it loads all pages, if FALSE it uses the Feindura::$page or Feindura::$category property Default false
int\|array\|bool	$shortenText	(optional) number of the maximal text length displayed, adds a "more" link at the end or FALSE to not shorten. You can also pass an array: value 1: text length as int, value 2: text string for the link, or a link string. e.g. array(23,false), array(23,'read more'), or array(23,'<a href="%href%"'>read more</a>'). (the `%href%` will be replaced by the pages href) Default false
bool\|string	$useHtml	(optional) whether the content of the page has HTML-tags or not. It also accepts a string with allowed html tags. Default true
bool	$reverseList	(optional) if TRUE the pages sorting will be reversed Default false

Description

Name listPagesBySortFunction()

Alias listPagesBySort()
Alias listPagesBySortCallback()
Alias listPagesByCallback()

This method uses the $error..., $title... and $thumbnail... properties.

List pages from category(ies) or page(s), sorted by a custom sort function, passed in the first parameter $sortCallback. The custom sort function will be executed on the plain $pageContent array returned by the FeinduraBase::loadPagesByType() method.

Returns an array with multiple pages for displaying in a HTML-page.

In case no page with the given category or page ID(s) exist it returns an empty array.

Note: If the $ids parameter is FALSE it uses the Feindura::$page or Feindura::$category property depending on the $idType parameter.

Example usage:
Show Example

<?php
/*                               *** CODE *** 
--------------------------------------------------------------------------------
This example uses all possible properties.
It's also works much more simple: just call listPages() without setting properties
and list the current category given by $_GET variable.
*/
 
// a session will be started in the "feindura.include.php",
// therefor you have to include this file before the header of the HTML page is sent,
// which means before any HTML Tag.
require('cms/feindura.include.php');
 
// creates a new Feindura instance
$feindura = new Feindura();
 
?>
<!DOCTYPE html>
<html>
...
 
<?php
 
// create the sort function, which we use with the listPagesBySortFunction() method
function sortByLastEditDate($a,$b) {
  if ($a['lastSaveDate'] == $b['lastSaveDate'])
    return 0;
  return ($a['lastSaveDate'] > $b['lastSaveDate']) ? -1 : 1;
}
 
// now we return the pages from the category with ID "1" and "2"
// the page content will be shorten to "200" characters
$pages = $feindura->listPagesBySortFunction('sortByLastEditDate','category',array(1,2),200);
 
// displays the pages (the "\n" creates a line break for a better look)
foreach($pages as $page) {
  echo $page['title']."\n\n";
  echo $page['thumbnail']."\n";
  echo $page['content']."\n";
  echo "<br>-----------------------<br>\n";
}
 
 
                               *** RESULT *** 
--------------------------------------------------------------------------------
 
Example Page 2
 
<h2>Example Headline</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus.</p>
<a href="?category=1&amp;page=2">mehr</a>
 
<br>-----------------------<br>
 
Example Page 3
 
<h2>Another Example Headline</h2>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing dolores et ea rebum.</p>
<h2>And one more Example Headline</h2>
<p>Stet clita kasd gubergren, no sea takimata sanctus est...</p>
<a href="?category=1&amp;page=3">mehr</a>
 
<br>-----------------------<br>
 
Example Page 1
 
<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor
invidunt ut labore et dolore magna aliquyam erat, ur sadipscing elitr,
Stet clita kasd...</p>
<a href="?category=2&amp;page=1">mehr</a>
 
<br>-----------------------<br>
 
?>

Example of the returned array:
Show Example

<?php
 
array(
 
  0 => array(
    'position'          => 'first', // is the first page in the returned pages list
    'pageId' or 'id'    => 1,
    'category'          => 'A Category',
    'categoryId'        => 1,
    'subCategory'       => 'Another Category',
    'subCategoryId'     => 2,
    'pageDate'          => '2010-12-31', // format depending on the administrator-settings
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 0
                    ),
    'title'             => 'Title Example 1',
    'thumbnail'         => false, // page has no thumbnail
    'thumbnailPath'     => false,
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag1,tag2,tag3',
    'href'              => '?category=1&page=1', // or a speaking url, if activated
    'plugins'           => array (
        'imageGallery' => array(
                'galleryPath'     => '',
                'imageWidth'      => 800,
                'imageHeight'     => null,
                'thumbnailWidth'  => 160,
                'thumbnailHeight' => null,
                'tag'             => 'table',
                'breakAfter'      => 3
                )
        )
    ),
   
   1 => array(
    'position'          => 2,
    'pageId' or 'id'    => 5,
    'category'          => 'A Category',
    'categoryId'        => 1,
    'subCategory'       => false,
    'subCategoryId'     => false,
    'pageDate'          => '2009-12-31 - 2010-01-15',
    'pageDateTimestamp'  => array(
                    'date'  => 1325393999, // 'date' and 'start' is the same
                    'start' => 1325393999,
                    'end'   => 1325303455 // will be 0 when its not a date range
                    ),
    'title'             => 'Title Example 2',
    'thumbnail'         => false,
    'thumbnailPath'     => false,
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag3,tag4',
    'href'              => '?category=1&page=5',
    'plugins'           => array ()
    ),
  
   2 => array(
    'position'          => 'last', // is the last page in the returned pages list
    'pageId' or 'id'    => 8,
    'category'          => 'Another Category',
    'categoryId'        => 2,
    'subCategory'       => false,
    'subCategoryId'     => false,
    'pageDate'          => false, // page has no page date
    'pageDateTimestamp' => false,
    'title'             => 'Title Example 3',
    'thumbnail'         => '<img src="/path/thumb_page3.png" class="feinduraThumbnail" alt="Thumbnail" title="Title Example 3">',
    'thumbnailPath'     => '/path/thumb_page3.png',
    'content'           => "\n".'<p>Content Text</p>'."\n",
    'description'       => 'Short description of the page',
    'tags'              => 'tag3,tag1',
    'href'              => '?category=2&page=8', 
    'plugins'           => array ()
    )
  )
  
?>

Return Value

array - array with page arrays,containing content and title etc., ready to display in a HTML-page, or an empty array

Additional

Uses

Feindura::$xHtml
Feindura::$showErrors
Feindura::$errorTag
Feindura::$titleLength
Feindura::$titleAsLink
Feindura::$titleShowPageDate
Feindura::$titleShowCategory
Feindura::$titleCategorySeparator
Feindura::$thumbnailAlign
Feindura::$thumbnailId
Feindura::$thumbnailClass
Feindura::$thumbnailAttributes
Feindura::$thumbnailBefore
Feindura::$thumbnailAfter
FeinduraBase::getPropertyIdsByType() - if the $ids parameter is FALSE it gets the property category or page ID, depending on the $idType parameter
FeinduraBase::loadPagesByType() - to load the page $pageContent array(s) from the given ID(s)
FeinduraBase::generatePage() - to generate every page which will be listed
GeneralFunctions::sortPages() - to sort the $pageContent arrays by category

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3888

bool startCache (

string $cacheId,
[float $timeout = 8])

Parameters

float	$timeout	(optional) the number of hours after whihc the cache should be reloaded
string	$cacheId	a unique id to identify the cache e.g "myScriptCache1" Default 8

Description

Name startCache()

This method can cache parts of your script, to speed up page loading time.
You need to call Feindura::endCache() to tell it were the cache part ends.
The cache will be resaved after the $timeout parameter is over. The cache will also be deleted when a page is saved in the backend.

Because of PHP scope restricions, you need to manually prevent the processing of the original script. See the example for more.

Note: This method and the Feindura::endCache() uses the ob_start() and ob_end_clean() function, if you start a output buffer inside your script which will be cached, make sure to close you output buffer beforec calling Feindura::endCache(). Note: You cannot nest multiple startCache() calls, this would overwrite the cache of the previous call of startCache().

Show Example

 // this will cache the scripts inside the brackets for two hours,
 // and then recache them again.
 if(!$feindura->startCache('myScriptCache',2)) {
 
 .. your scripts
 
 }
 $feindura->endCache();
 
 ..
 
 
 // Since PHP 5.3 you could also write it like this:
 if($feindura->startCache('myScriptCache',2))
   goto usedCache;
 
 .. your scripts
 
 usedCache:
 $feindura->endCache();
 
 ..

Return Value

bool - TRUE if the it will output the cached part, FALSE if no cache existed and it was created

Additional

see: Feindura::endCache()
access: public

Version

1.0
ChangeLog
- 1.0 initial release

File source:
line 3944

void endCache (

)

Description

Name endCache()

This method writes the cache, which was started with Feidnura::startCache(). It will save the last started cache. See the Feidnura::startCache() method for more.

Additional

see: Feindura::endCache()
access: public

Version

1.0
ChangeLog
- 1.0 initial release

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From FeinduraBase

FeinduraBase::$adminConfig
FeinduraBase::$categoryConfig
FeinduraBase::$languageFile
FeinduraBase::$languageNames
FeinduraBase::$loggedIn
FeinduraBase::$sessionId
FeinduraBase::$websiteConfig

Inherited From FeinduraBase

FeinduraBase::__construct(): Type constructor
FeinduraBase::checkPagesForTags(): Name checkPagesForTags()
FeinduraBase::createAttributes(): Name createAttributes()
FeinduraBase::createThumbnail(): Name createThumbnail()
FeinduraBase::createTitle(): Name createTitle()
FeinduraBase::generateContent(): Name generateContent()
FeinduraBase::generateMenu(): Name generateMenu()
FeinduraBase::generatePage(): Name generatePage()
FeinduraBase::getCurrentCategoryId(): Name getCurrentCategoryId()
Alias getCategoryId()
FeinduraBase::getCurrentPageId(): Name getCurrentPageId()
Alias getPageId()
FeinduraBase::getIdsFromString(): Name getIdsFromString()
FeinduraBase::getParentPages(): Name getParentPages()
FeinduraBase::getPropertyCategory(): Name getPropertyCategory()
FeinduraBase::getPropertyIdsByType(): Name getPropertyIdsByType()
FeinduraBase::getPropertyPage(): Name getPropertyPage()
FeinduraBase::loadFrontendLanguageFile(): Name loadFrontendLanguageFile()
FeinduraBase::loadPagesByDate(): Name loadPagesByDate()
FeinduraBase::loadPagesByType(): Name loadPagesByType()
FeinduraBase::loadPagesMetaDataByType(): Name loadPagesMetaDataByType()
FeinduraBase::setCurrentCategoryId(): Name setCurrentCategoryId()
Alias setCategoryId()
FeinduraBase::setCurrentPageId(): Name setCurrentPageId()
Alias setPageId()
FeinduraBase::shortenHtmlText(): Name shortenHtmlText()
FeinduraBase::shortenText(): Name shortenText()