static void redirect(
string
$url
)
|
|
redirect user in the backend prepend 'contao' to the $url if version >= 2.9 prepend 'typolight' to the $url if version < 2.9
Parameters:
|
string |
$url: |
url should start with main.php |
API Tags:
static string setBackendMain(
string
$strContent, string
$mainContent
)
|
|
replace the "main" section of the backend it is intended to be used inside a parseBackendTemplate hook callback
Parameters:
|
string |
$strContent: |
the output of backend as string |
|
string |
$mainContent: |
the content to be added to the backend main section |
API Tags:
| Return: | the backend output with "main" replaced |
| Access: | public |
static void throwError(
)
|
|
redirect user to a special error page managed though the ErrorManager
API Tags:
ZedSeriesUi __construct(
[
$theme = 'zsui']
)
|
|
Parameters:
API Tags:
string beLink(
string
$text, string
$url, [string
$class = ''], [string
$id = ''], [array
$arrAttrs = array()]
)
|
|
generates a backend link
Parameters:
|
string |
$text: |
the anchor text |
|
string |
$url: |
the backend url (e.g. do=MyModule) |
|
array |
$arrAttrs: |
an array of attributes |
|
string |
$class: |
class a css class |
|
string |
$id: |
id an id class |
API Tags:
string box(
string
$text, [string
$class = ''], [string
$id = ''], [array
$arrAttrs = array()]
)
|
|
generates a box
a box is a nice show if you want to output a single line message
Parameters:
|
string |
$text: |
the text to put inside |
|
array |
$arrAttrs: |
an array of attributes |
|
string |
$class: |
class a css class |
|
string |
$id: |
id an id class |
API Tags:
void btBack(
[
$link = null], [
$label = null]
)
|
|
Parameters:
API Tags:
string buttonbar(
string
$cnt
)
|
|
it is currently in beta displays a buttonbar
Parameters:
|
string |
$cnt: |
content to show inside the button bar |
API Tags:
void generate(
$objTemplate,
$text,
$arrTemplateVars
)
|
|
Parameters:
|
|
$objTemplate: |
|
|
|
$text: |
|
|
|
$arrTemplateVars: |
|
API Tags:
string getBackendModuleTitle(
)
|
|
get the current backend Module Title
API Tags:
| Return: | the current title of the module |
| Access: | public |
void ifcMessage(
$cnt, [
$class = ''], [
$id = ''], [
$arrAttrs = array()]
)
|
|
display a message field, common usage will be in custom dca fields
i.e. fields generated through input_field_callback
Parameters:
|
|
$cnt: |
|
|
|
$class: |
|
|
|
$id: |
|
|
|
$arrAttrs: |
|
API Tags:
void initAttrs(
&$arrAttrs,
$class,
$id
)
|
|
Parameters:
API Tags:
string link(
$anchor, string
$url, [string
$class = ''], [string
$id = ''], [array
$arrAttrs = array()], string
$text
)
|
|
generates a link
Parameters:
|
string |
$text: |
the anchor text |
|
string |
$url: |
the url (absolute or relative to the TYPOlight installation) |
|
array |
$arrAttrs: |
an array of attributes |
|
string |
$class: |
class a css class |
|
string |
$id: |
id an id class |
|
|
$anchor: |
|
API Tags:
string listingContainer(
$cnt
$cnt
)
|
|
show a listing container please note that in order to obtain the best results you need to put some listingItem inside it
Parameters:
|
$cnt |
$cnt: |
the content to put inside |
API Tags:
string listingItem(
string
$left, string
$right, [string
$class = 'tl_file'], [string
$id = '']
)
|
|
show a listing item please note that in order to obtain the best results you need to put the listingItem inside a listingContainer
Parameters:
|
string |
$left: |
the content for the left column (usually title of item) |
|
string |
$right: |
the content for the right column (usually buttons and links) |
|
string |
$class: |
the class name for the listing item |
|
string |
$id: |
id to assign to the listing item content (left column) |
API Tags:
void newTemplate(
$strTemplate
)
|
|
Parameters:
API Tags:
string par(
string
$text, [string
$class = ''], [string
$id = ''], [
$arrAttrs = array()]
)
|
|
displays a paragraph
you can specifiy an (optional) css class and/or an optional id
Parameters:
|
string |
$text: |
content to show inside |
|
string |
$class: |
class a css class |
|
string |
$id: |
id an id class |
|
|
$arrAttrs: |
|
API Tags:
void setBackendModuleTitle(
$title
)
|
|
replace the default backend module title (taken from 'do' url value with a custom one)
can be useful when you have some custom keys and want to give a more detailed title
Parameters:
API Tags:
void setBackendModuleTitleFromUrl(
)
|
|
API Tags:
string title(
string
$text, [string
$class = ''], [string
$id = ''], [
$arrAttrs = array()]
)
|
|
displays a title
you can specifiy an (optional) css class and/or an optional id
Parameters:
|
string |
$text: |
content to show inside |
|
string |
$class: |
class a css class |
|
string |
$id: |
id an id class |
|
|
$arrAttrs: |
|
API Tags:
void uiBackendModuleTitle(
$strContent,
$strTemplate
)
|
|
to activate the HOOK be sure to put the following line into the config.php of your extension
$GLOBALS['TL_HOOKS']['outputBackendTemplate'][] = array('ZedSeriesUi', 'uiBackendModuleTitle');
set the backend module title with the following logic
if there is a $key url parameter the title will be taken from $GLOBALS['TL_LANG']['MOD'][$key] if there is a $table url parameter the title will be taken from $GLOBALS['TL_LANG']['MOD'][$table]
if none of the above are present the title will be taken from $GLOBALS['TL_LANG']['uiTitle']
Parameters:
|
|
$strContent: |
|
|
|
$strTemplate: |
|
API Tags:
