Class BeFrontHelper

helper class for frontends

Helper

AppHelper

BeFrontHelper

Link: http://www.bedita.com
Version: $Revision$
Modifiedby: $LastChangedBy$
Lastmodified:

$LastChangedDate$

$Id$

Located at views/helpers/be_front.php

Methods summary

`public`	# `__construct( )`
`public 639-1`	# `lang( )` show 639-1 code, two letters, for html lang value should be in "frontendLangs" config array show 639-1 code, two letters, for html lang value should be in "frontendLangs" config array "eng" => array("en", "english"), "spa" => array("es", "español"), "ita" => array("it", "italiano"), ..... Returns 639-1 code if found, empty string otherwise
`public string`	# `title( string $order = 'asc' )` return title for current page if page is publication root => return (if 'contentRequested' return - ) if page is a section => return - < section title> [$order 'desc'] or < section title> - [$order 'asc' default] (if 'contentRequested' return < section title> - [$order 'desc'] or - < section title> [$order 'asc' default]) return title for current page if page is publication root => return (if 'contentRequested' return - ) if page is a section => return - < section title> [$order 'desc'] or < section title> - [$order 'asc' default] (if 'contentRequested' return < section title> - [$order 'desc'] or - < section title> [$order 'asc' default]) Parameters `$order` can be 'asc' or 'desc' Returns string
`public string`	# `metaAlternate( mixed $langs = true )` Return meta alternate tags. Return meta alternate tags. Parameters `$langs` Alternate language(s) for current resource. If omitted or `=== true`, all languages specified in `$configure->frontendLangs` will be loaded. Returns string
`public string`	# `metaDescription( )` return html meta description. try to get description from: _currentContent ('description' or 'abstract' or 'body') _section['description'] _publication['description'] return html meta description. try to get description from: _currentContent ('description' or 'abstract' or 'body') _section['description'] _publication['description'] Returns string See HtmlHelper
`public string`	# `metaDc( )` return html meta of dublin core meta data for current content (if present) or publication return html meta of dublin core meta data for current content (if present) or publication DC fields: DC.description DC.format DC.language DC.creator DC.publisher DC.date DC.modified DC.identifier DC.rights DC.license Returns string See HtmlHelper
`public string`	# `metaOg( )` return html of OG meta data (Object Graph Metadata - for facebook) return html of OG meta data (Object Graph Metadata - for facebook) Returns string
`public string`	# `metaWebApp( string $title = false, array $icons = false, string $statusBar = false, string $tileColor = '#000', string $feed = false )` return html of common web-app metadata return html of common web-app metadata Parameters `$title` $title, the application name `$icons` $icons, an array of icons to use when the application is pinned in user home screen `$statusBar` $statusBar, hex string color for status and navigation bars `$tileColor` $tileColor, hex string for application name color (Windows) `$feed` $feed, the nickname of the section to use as feed Returns string
`public string`	# `metaAll( string $docType = null )` return all html meta all meta = description, author, content, generator return all html meta all meta = description, author, content, generator Parameters `$docType` If not passed, tries to load `docType` from config. If this fails too, `xhtml-strict` is used. Returns string See HtmlHelper
`public string`	# `feeds( )` return html meta for rss feeds return html meta for rss feeds Returns string See HtmlHelper
`public string`	# `seealso( )` return currentContent seealso relation, if present. return currentContent seealso relation, if present. Returns string
`public string`	# `canonicalPath( )` build canonical path tag of content/section selected build canonical path tag of content/section selected Returns string
`private`	# `get_value_for_field( $field )`
`private`	# `get_description( )`
`public`	# `chooseTemplate( string $default = "generic_section" )` choose a view template verifying if file exists. Test follow the order: 1) filename = frontendMap currentContent nickname 2) filename = frontendMap section nickname 3) filename = currentContent nickname 4) filename = section nickname 5) filename = parent sections nickname 6) filename = object type 7) default choose a view template verifying if file exists. Test follow the order: 1) filename = frontendMap currentContent nickname 2) filename = frontendMap section nickname 3) filename = currentContent nickname 4) filename = section nickname 5) filename = parent sections nickname 6) filename = object type 7) default Parameters `$default` $default, default fallback template
`public string`	# `menu( array $tree, array $options = array() )` return an nested unordered list return an nested unordered list item 1 item 2 item 3 ... .... Parameters `$tree` section's tree (structure from FrontendController::loadSectionsTree is aspected) `$options` (defaukt values are visible in $defaultOptions array) "id" => id of main < ul> "menuClass" => css class of main < ul> "ulClass" => css class of nested < ul> "liClass" => css class of "activeClass" => css class for selected Returns string
`private string`	# `menuBranch( array $section, array $options )` return an html menu branch return an html menu branch Parameters `$section` `$options` "ulClass" => css class of nested < ul> "liClass" => css class of Returns string
`public BeFrontHelper::stats()`	# `stats( )` return publication stats code only if frontend app isn't staging site return publication stats code only if frontend app isn't staging site Returns `BeFrontHelper::stats()` code or nothing
`public string`	# `breadcrumb( array $options = array() )` return the breadcrumb trail return the breadcrumb trail Parameters `$options` possible values are: "separator" => '»' [default] text to separate crumbs "startText" => false [default] this will be the first crumb, if false it defaults to first crumb in array "classOn" => "crumbOn" [default] css class for current section "showPublication" => true [default] choose if publication is shown in breadcrumb Returns string
`public`	# `stagingToolbar( )` if frontend is a staging app then it shows a toolbar on the top of the page if frontend is a staging app then it shows a toolbar on the top of the page
`public`	# `beforeRender( )` helper beforeRender. include js that staging toolbar needs, include css (backend and eventually frontend override), override css helper beforeRender. include js that staging toolbar needs, include css (backend and eventually frontend override), override css

Methods inherited from AppHelper

getHelper(), oEmbedInfo()

Properties summary

`public array`	`$helpers`	# `array('Html', 'BeHtml')`
`private`	`$_publication`	#
`private`	`$_section`	#
`private`	`$_currentContent`	#
`private`	`$_feedNames`	#
`private`	`$_conf`	#
`private`	`$_breadcrumbs`	#
`private`	`$_viewExt`	#

Classes

Interfaces

Exceptions

Class BeFrontHelper

Methods summary

Returns

Parameters

Returns

Parameters

Returns

Returns

See

Returns

See

Returns

Parameters

Returns

Parameters

Returns

See

Returns

See

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Methods inherited from AppHelper

Properties summary