Docs For Class ZedSeriesControllerUtils

Methods

Constructor __construct [line 29]

ZedSeriesControllerUtils __construct(
)

API Tags:

Access:

public

[ Top ]

addToUrl [line 57]

string addToUrl(
string
$strRequest, integer
1 
)

Add a request string to the current URI string

This documentation is based on TYPOlight system/libraries/System.php one

Parameters:

integer	1:
string	$strRequest:

API Tags:

Access:

public

[ Top ]

generateFrontendUrl [line 162]

string generateFrontendUrl(
array
$arrRow, [string
$strParams = ''] 
)

Generate an URL from a tl_page record depending on the current rewriteURL setting and return it

This documentation is based on TYPOlight system/libraries/Controller.php one

Parameters:

array	$arrRow:	page data containing id and alias
string	$strParams:	params to add to generated url

API Tags:

Return:	the generated frontend url
Access:	public

[ Top ]

generateFrontendUrlByAlias [line 191]

string generateFrontendUrlByAlias(

$alias, [string
$strParams = ''], string
$id 
)

Generate an URL from a tl_page's alias record depending on the current rewriteURL setting and return it

Parameters:

string	$id:	the tl_page's alias from which generate the url
string	$strParams:
	$alias:

API Tags:

Return:	the generated frontend url
Access:	public

[ Top ]

generateFrontendUrlByPageId [line 175]

string generateFrontendUrlByPageId(
integer
$id, [string
$strParams = ''] 
)

Generate an URL from a tl_page's id record depending on the current rewriteURL setting and return it

Parameters:

integer	$id:	the tl_page's id from which generate the url
string	$strParams:

API Tags:

Return:	the generated frontend url
Access:	public

[ Top ]

generateImage [line 71]

string generateImage(
string
$src, [string
$alt = ''], [string
$attributes = ''] 
)

Generate an image tag and return it as HTML string

This documentation is based on TYPOlight system/libraries/Controller.php one

Parameters:

string	$src:
string	$alt:
string	$attributes:

API Tags:

Access:

public

[ Top ]

getObj [line 42]

object an getObj(
string
$strClass 
)

import the named strClass into the ZedSeriesControllerUtils namespace and returns it

Parameters:

string

$strClass:

class name

API Tags:

Return:	instance of $strClass
Access:	public

[ Top ]

getRefererUrl [line 227]

string getRefererUrl(
[boolean
$blnEncodeAmpersands = false], [
$strTable = ''] 
)

Return the current referer URL and optionally encode ampersands

This documentation is based on TYPOlight system/libraries/System.php ones

Parameters:

boolean	$blnEncodeAmpersands:
	$strTable:

API Tags:

Access:

public

[ Top ]

getTemplate [line 86]

string getTemplate(
string
$template 
)

Find a particular template file and return its path

This documentation is based on TYPOlight system/libraries/Controller.php one

Parameters:

string

$template:

template name without extension

API Tags:

Return:	full path to template file
Access:	public

Information Tags:

Throws:

Exception

[ Top ]

loadDataContainer [line 107]

void loadDataContainer(

$strName 
)

Load a set of DCA files

This documentation is based on TYPOlight system/libraries/Controller.php one

Parameters:

$strName:

API Tags:

Access:

public

[ Top ]

loadLanguageFile [line 95]

void loadLanguageFile(
string
$strName, [boolean
$strLanguage = false] 
)

Load a set of language files

Parameters:

string	$strName:
boolean	$strLanguage:

API Tags:

Access:

public

[ Top ]

log [line 147]

void log(
string
$strText, string
$strFunction, string
$strAction 
)

Add a log entry

This documentation is based on TYPOlight system/libraries/System.php one

Parameters:

string	$strText:	message to log
string	$strFunction:	log category
string	$strAction:	log level (e.g. TL_ERROR, TL_ACCESS, TL_GENERAL etc.)

API Tags:

Access:

public

[ Top ]

prepareForWidget [line 213]

array prepareForWidget(
array
$arrData, string
$strName, [mixed
$varValue = null], [string
$strField = ''], [string
$strTable = ''] 
)

Convert a back end DCA so it can be used with the widget class

This documentation is based on TYPOlight system/libraries/Controller.php ones

Parameters:

array	$arrData:	dca section of field to which base the Widget on
string	$strName:	name to assign to the widget
mixed	$varValue:	initial value of widget
string	$strField:	table field (optional)
string	$strTable:	table name (optional)

API Tags:

Access:

public

[ Top ]

redirect [line 133]

void redirect(
string
$strLocation, [int
$intStatus = 303] 
)

Redirect to another page

This documentation is based on TYPOlight system/libraries/System.php one

Parameters:

string	$strLocation:
int	$intStatus:

API Tags:

Access:

public

[ Top ]

replaceInsertTags [line 121]

string replaceInsertTags(

$strBuffer, [
$blnCache = false], string
$str 
)

Replace insert tags with their values

This documentation is based on TYPOlight system/libraries/Controller.php one

Parameters:

string	$str:	content
	$strBuffer:
	$blnCache:

API Tags:

Return:	content with insertTags replaced
Access:	public

[ Top ]

	This site is part of zedseries.com network: Open source extensions for Contao cms \| Consultant services for Contao cms \| zedseries.com's blog \|
	api.zedseries.com

[ class tree: Controller ] [ index: Controller ] [ all elements ]

Class: ZedSeriesControllerUtils

Class ZedSeriesControllerUtils