DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
YAG ViewHelpers¶
Here is a list of viewhelpers available from within YAG:
If you want to use YAG’s viewhelpers in your templates, you have to include them with the following line of code at the beginning of your template:
{namespace yag=Tx_Yag_ViewHelpers}
ViewHelper
ViewHelper:
Parameters
Parameters:
Description
Description:
ViewHelper
BreadcrumbsViewHelper
Parameters
none
ViewHelper
ImageViewHelper
Parameters
Item: item object
resolutionName: The name of a defined resolution.
Description
Renders an image in the given resolution.
Example:
<yag:imageitem=”{image}”resolutionName=”thumb”/>
CSS¶
The followin viewhelpers are available for handling CSS related stuff:
ViewHelper
ViewHelper:
Parameters
Parameters:
Description
Description:
ViewHelper
IncludeViewHelper
Parameters
Library: library name
File: path to file
Description
Includes CSS Files to the header section. If library is given, the css files defined in the library are included (see: Typoscript/BaseConfig/HeaderInclusion/)
Example:
<yag:CSS.Includelibrary=”jQueryShadowBox”/>
Javascript¶
The followin viewhelpers are available for handling Javascript related stuff:
ViewHelper
ViewHelper:
Parameters
Parameters:
Description
Description:
ViewHelper
IncludeViewHelper
Parameters
Library: library name
File: path to file
Description
Includes JS Files to the header section. If library is given, the js files defined in the library are included (see: Typoscript/BaseConfig/HeaderInclusion/)
Example:
<yag:Javascript.Includelibrary=”jQuery”/>
In order to make this work, you have to configure your libraries in TypoScript. You find a list of predefined libraries in Configuration/TypoScript/BaseConfig/HeaderInclusion/JQuery.ts:
plugin.tx_yag.settings.frontendLib {jQuery {include = {$config.yag.addjQuery}includeJS.jQuery = EXT:yag/Resources/Public/Js/JQuery/jquery-1.5.1.min.js# includeCSS.jQuery = EXT:yag/Resources/Public/CSS/JQuery/base.css}}
ViewHelper
TemplateViewHelper
Parameters
TemplatePath: path to a jsTemplate
Arguments: the arguments to replace in the template.
Description
This viewhelper is in some way a pragmatic approach to avoid the fluid restrictions with javscript inline markup in templates. All arguments given to the viewhelper are replaced in the Javascript template in the form ###argument### with the given value.
There are some implicit defined markers:
extPath: relative path to the extensionextKey: Extension KeypluginNamespace: Plugin Namespace for GET/POST parameters
Example (usage of viewhelper):
<yag:Javascript.TemplatetemplatePath=”EXT:yag/Resources/Private/JSTemp lates/ItemAdminList.js”arguments=”{ajaxBaseURL : ‘{f:uri.action(controller:’Ajax’)}’}”/>
Example (usage of template markers in JS templates – so it’s JavaScript what you see here):
vardel_url =’###ajaxBaseURL###’+’&###pluginNamespace###[action]=deleteItem’;
Link¶
The following viewhelpers are available for rendering links:
ViewHelper
ViewHelper:
Parameters
Parameters:
Description
Description:
ViewHelper
AlbumViewHelper
Parameters
Album: album object
Description
Renders a link for an album
ViewHelper
AlbumAdminViewHelper
Parameters
Album: album object
Description
Renders a link for administrating an album
ViewHelper
GalleryViewHelper
Parameters
Gallery: gallery object
Description
Renders a link for a gallery
Namespace¶
The followin viewhelpers are available for using namespaces:
ViewHelper
ViewHelper:
Parameters
Parameters:
Description
Description:
ViewHelper
GPArrayViewHelper
Parameters
###TODO daniel###
Description
###TODO daniel###
Resource¶
The followin viewhelpers are available for getting URIs for resources:
ViewHelper
ViewHelper:
Parameters
Parameters:
Description
Description:
ViewHelper
ImageViewHelper
Parameters
Item: item object
resolutionName: The name of a defined resolution.
Description
Renders URI for an image. Used in XML view for example.
Example:
<yag:resource.imageitem=”{listRow.image.value}”resolutionName=”thumb”/ >