Jelix 1.8.13

jelix

Packages

auth
controllers
core
modules
dao
db
events
forms
installer
kvdb
cache
coord
debugbar
responsehtml
profiles
jtpl
utils
datatypes
jacl2db
jauthdb
jpref
master
jacl
jacl2
jacldb
jauth
scripts
tests

Interfaces, Classes and Traits

ConfigCompilerPluginInterface
interface for plugins of jConfigCompiler.
jILogMessage
interface for log message. A component which want to log a message can use an object implementing this interface.
jILogger
interface for loggers.
jIHTMLResponsePlugin
interface for plugins for jResponseBasicHtml or jResponseHtml, which allows to make changes in the response at several step.
jIUrlSignificantHandler
jIKVPersistent
interface for KV driver which store values in a persistent manner (in a file...).
jIKVttl
interface for KV driver which support 'time to live' on values useful to use the driver as a cache storage.
jIKVSet
jIDebugbarPlugin
interface for plugins for the debugbar.
jAcl2AuthAdapterInterface
Interface for authentication adapters for jAcl2.
jAcl2AuthAdapterInterface2
Interface for authentication adapters for jAcl2.
jAuthDriverBase
base class for some jAuth drivers.
jAuthPassword
jControllerDaoCrudFilter
Implements a CRUD controller, having a filter form to filter the list.
jBasicErrorHandler
Error handlers for the framework.
jFileLogger
logger storing message into a file.
jLogErrorMessage
this class is formatting an error message for a logger.
jLogMessage
class that handles a simple message for a logger.
jLogDumpMessage
class that handles a dump of a php value, for a logger.
jMailLogger
logger sending message by email.
jStderrLogger
logger sending message to stderr.
jStdoutLogger
logger sending message to stdout.
jSyslogLogger
logger storing message into syslog.
jResponseFormJQJson
Response for jForms forms submitted with XHR (ajax).
jResponseHtml4
Response class for HTML 4 or XHTML 1.x.
Services
It allows to access to some useful components.
jDaoDbMapper
It allows to create tables corresponding to a dao file.
jSQLLogMessage
class that handles a sql query for a logger.
jDbIndex
Represents an index on some columns.
jDbConstraint
jDbUniqueKey
represents a unique key.
jDbPrimaryKey
used to declare a primary key.
jDbReference
used to declare a foreign key.
jDbColumn
jDbParameters
allow to normalize & analyse database parameters.
jDbSchema
jFormsSession
This class acts as a cache proxy during a request processing, for jForms containers. It allows to get and store jForms containers data into an external storage using jCache.
ghostInstallReporter
a reporter which reports... nothing.
Jelix17
WebAssetsUpgrader
Console
simple text reporter.
jInstaller
main class for the installation.
jInstallerEntryPoint
container for entry points properties.
textInstallReporter
reporter echoing simply the messages.
jKVDb
main class to access to key-value storage databases.
jKVDriver
mssqlDaoBuilder
driver for jDaoCompiler.
mysqlDaoBuilder
driver for jDaoCompiler.
ociDaoBuilder
driver for jDaoCompiler.
pgsqlDaoBuilder
driver for jDaoCompiler.
sqliteDaoBuilder
driver for jDaoCompiler.
sqlsrvDaoBuilder
driver for jDaoCompiler.
mssqlDbConnection
mssqlDbResultSet
Layer encapsulation resultset mssql.
sqlsrvDbConnection
sqlsrvDbResultSet
Layer encapsulation resultset mssql.
defaultlogDebugbarPlugin
plugin to show general message logs.
sessiondataDebugbarPlugin
plugin to show content of a session.
soaplogDebugbarPlugin
plugin to show soap message.
sqllogDebugbarPlugin
plugin to show all sql queries into the debug bar.
autocomplete_htmlFormWidget
Widget allowing to select a value by showing results from a search after the user starts to type a name. The search is made into a select html element filled by the datasource of the control, which should be a menulist.
autocompleteajax_htmlFormWidget
Widget allowing to select a value by showing results from a search after the user start to type a name. The search is made by doing an http request to the server. See jAutocompleteAjax jqueryui plugin, which is base on the autocomplete plugin.
password_htmlFormWidget
passwordeditor_htmlFormWidget
time_htmlFormWidget
HTML form builder.
upload2_htmlFormWidget
Widget to display the selection of a file to upload.
debugbarItemInfo
information for a component a debug bar.
debugbarHTMLResponsePlugin
plugin for jResponseHTML, it displays a debugbar.
errorsDebugbarPlugin
native plugin for the debugbar, which displays list of errors, warnings.
dbKVDriver
Driver for jKVDB, that uses an SQL table to store key/value data.
dbaKVDriver
file2KVDriver
fileServer
memcacheKVDriver
redis_extKVDriver
legacysyslogLogger
logger storing message into syslog using old api.
soapfileLogger
logger storing soap message into several xml files.
jProfilesCompiler
read and consolidate data from a profile, and store results into a cache file.
jProfilesCompilerPlugin
default plugin for jProfilesCompiler, and base plugin for other plugins.
jLogSoapMessage
class that handles a dump of a php value, for a logger.
SoapClientDebug
jSoapObject
classes that are mapped to soap types could inherits from this object in order to have some helpers and a better mapping than the default soap mapper.
defaultCtrl
controller to manage all users.
userCtrl
controller to allow a user to edit his own profile in the admin.
jauthdb_adminModuleConfigurator
Base class for classes which configure a module.
jAcl2Authentication
Makes the glue between jAcl2 and an authentication library.
jAcl2JAuthAdapter
Adapter to jAuth for jAcl2.
jacl2ModuleConfigurator
Base class for classes which configure a module.
jAcl2DbManager
This class is used to manage rights. Works only with db driver of jAcl2.
jAcl2DbUserGroup
Use this class to register or unregister users in the acl system, and to manage user groups.
jacl2dbModuleInstaller
parameters for this installer - defaultgroups add default groups admin, users, anonymous - defaultuser add a default user, admin and add default groups.
jauthModuleConfigurator
Base class for classes which configure a module.
jauthdbModuleConfigurator
Base class for classes which configure a module.
jauthdbModuleInstaller
parameters for this installer - defaultuser add a default user, admin.
fileKVDriver
driver for jKVDb which store key values in files.
jelix_TextUI_Command
Command for PHPUnit, that load tests classes from the `tests` directory of each modules.
jUnitTestCase
jUnitTestCaseDb
jInstallerReporterTrait

Table of Contents

BYTECODE_CACHE_EXISTS  = \function_exists('opcache_compile_file') || \function_exists('apc_cache_info') || \function_exists('eaccelerator_info') || \function_exists('xcache_info')
JELIX_LIB_CORE_PATH  = \JELIX_LIB_PATH . 'core/'
JELIX_LIB_PATH  = __DIR__ . '/'
JELIX_LIB_UTILS_PATH  = \JELIX_LIB_PATH . 'utils/'
JELIX_NAMESPACE_BASE  = 'http://jelix.org/ns/'
JELIX_SCRIPTS_PATH  = __DIR__ . '/../'
LIB_PATH  = \dirname(\JELIX_LIB_PATH) . '/'
sha1WithSalt()  : mixed
function to use to crypt password. use the password_salt value in the config file of the plugin.
bcrypt()  : mixed
hash password with blowfish algorithm. use the password_salt value in the config file of the plugin.
jelix_read_ini()  : mixed
jelix_scan_module_sel()  : mixed
jelix_scan_action_sel()  : mixed
jelix_scan_class_sel()  : mixed
jelix_scan_locale_sel()  : mixed
jelix_autoload()  : mixed
function used by php to try to load an unknown class.
checkAppOpened()  : mixed
check if the application is opened. If not, it displays the yourapp/install/closed.html file with a http error (or lib/jelix/installer/closed.html), and exit.
checkAppNotInstalled()  : mixed
check if the application is not installed. If the app is installed, an error message appears and the scripts ends.
isAppInstalled()  : mixed
jtpl_block_common_ifuserconnected()  : string
a special if block to test easily if the current user is connected.
jtpl_block_common_ifusernotconnected()  : string
a special if block to test easily if the current user is not connected.
jtpl_cfunction_common_fetchtpl()  : string
fetch the content of a template without template variables of calling template, except private variables setted by some plugins.
jtpl_cfunction_common_fetchzone()  : string
cfunction to fetch the content of a zone into a tpl var.
jtpl_cfunction_common_zone()  : string
cfunction plugin : include the content of a zone.
jtpl_function_common_dumptolog()  : mixed
Dump a value into log files.
jtpl_function_common_tolog()  : mixed
Dump a value into log files.
jtpl_modifier_common_datetime()  : string
modifier plugin : change the format of a date.
jtpl_modifier_common_jdatetime()  : string
modifier plugin : change the format of a date.
jtpl_block_html_form()  : string
a block to display an html form, with data from a jforms.
jtpl_block_html_formcontrols()  : string
a block to loop over controls list of a form and to display them.
jtpl_block_html_formdata()  : string
a block to display only data of a form.
jtpl_block_html_formsubmits()  : string
a block to loop over submit button list of a form and to display them.
jtpl_block_html_ifctrl()  : string
a special if block to test easily the current control name TO BE USED inside a {formcontrols} block.
jtpl_block_html_ifctrl_value()  : string
a special if block to test easily the current control value TO BE USED inside a {formcontrols} block.
jtpl_block_html_ifctrlexists()  : string
a special if block to check if a ctrl exist in the form TO BE USED inside a `{form}` or `{formadata}` block.
jtpl_block_html_ifctrltype()  : string
a special if block to test easily the current control type TO BE USED inside a {formcontrols} block.
jtpl_cfunction_html_formfull()  : string
Display a full form without the use of other plugins.
jtpl_function_html_ctrl_control()  : mixed
function plugin : print the html content of a form control. You should use this plugin inside a formcontrols block.
jtpl_function_html_ctrl_label()  : mixed
function plugin : print the label of a form control. You should use this plugin inside a formcontrols block.
jtpl_function_html_ctrl_rawvalue()  : mixed
function plugin : print the raw value of a form control, without trying to display a corresponding label and without to display values of child controls. You should use this plugin inside a formcontrols block.
jtpl_function_html_ctrl_value()  : mixed
function plugin : print the value of a form control. You should use this plugin inside a formcontrols block.
jtpl_function_html_ctrl_value_assign()  : mixed
function plugin : assign the value of the current control into the given template variable
jtpl_function_html_formdatafull()  : mixed
Display all data of a form without the use of other plugins.
jtpl_function_html_formreset()  : mixed
function plugin : print the html content of a form reset button.
jtpl_function_html_formsubmit()  : mixed
function plugin : print the html content of a form submit button. You can use this plugin inside a formsubmits block.
jtpl_function_html_formurl()  : mixed
function plugin : write the url corresponding to the given jelix action.
jtpl_function_html_formurlparam()  : mixed
function plugin : write the url corresponding to the given jelix action.
jtpl_function_html_hook()  : mixed
hook plugin.
jtpl_function_html_image()  : mixed
image plugin : write the url corresponding to the image.
jtpl_function_html_jfullurl()  : mixed
function plugin : write the full url (with domain name) corresponding to the given jelix action.
jtpl_function_html_jlocale()  : mixed
function plugin : write the localized string corresponding to the given locale key.
jtpl_function_html_jmessage()  : mixed
function plugin : Display messages from jMessage.
jtpl_function_html_jrooturl()  : mixed
function plugin : write the root url corresponding to the given ressource type If this ressource type is not specified in the config file, returned value will be basePath.
jtpl_function_html_jurl()  : mixed
function plugin : write the url corresponding to the given jelix action.
jtpl_function_html_jurlpattern()  : mixed
function plugin: write the url corresponding to the given jelix action, inserting placeholder name (between two %) for some parameter, so you can generate the url dynamically in JS by replacing placeholders by javascript values.
jtpl_function_html_link_to_remote()  : mixed
function plugin : Ajax request.
jtpl_function_html_pagelinks()  : mixed
displays page links.
jtpl_function_html_resurl()  : mixed
function plugin : write the url corresponding to a resource stored in a www directory of a module.
jtpl_function_html_urljsstring()  : mixed
function plugin : write the url corresponding to the given jelix action for javascript.
jtpl_meta_html_html()  : mixed
meta plugin : modify an html response object.
jtpl_meta_html_htmlmodule()  : mixed
meta plugin : allow to add css files and js files stored into modules, in an html response object.
jtpl_modifier_html_vardump()  : string
Dump any value.
jtpl_function_ltx2pdf_jlocale()  : mixed
function plugin : write the localized string corresponding to the given locale key.
jtpl_function_ltx2pdf_jurl()  : mixed
function plugin : write the url corresponding to the given jelix action.
jtpl_function_text_formdatafull()  : mixed
Display all data of a form without the use of other plugins.
jtpl_function_text_jfullurl()  : mixed
function plugin : write the full url (with domain name) corresponding to the given jelix action.
jtpl_function_text_jlocale()  : mixed
function plugin : write the localized string corresponding to the given locale key.
jtpl_function_text_jurl()  : mixed
function plugin : write the url corresponding to the given jelix action.
jtpl_modifier_html_vardump()  : string
Dump any value.
jtpl_function_xml_jfullurl()  : mixed
function plugin : write the full url (with domain name) corresponding to the given jelix action.
jtpl_function_xml_jlocale()  : mixed
function plugin : write the localized string corresponding to the given locale key.
jtpl_function_xml_jurl()  : mixed
function plugin : write the url corresponding to the given jelix action.
jtpl_meta_xml_xml()  : mixed
meta plugin : modify an xml response object.
is_resource()  : bool
Check if the given value is a resource or not.
utf8_decode()  : mixed
utf8_encode()  : mixed
jtpl_block_common_ifacl()  : string
a special if block to test easily a right value.
jtpl_block_common_ifnotacl()  : string
a special if block to test easily a right value.
jtpl_block_common_ifacl2()  : string
a special if block to test easily a right value.
jtpl_block_common_ifacl2and()  : string
a special if block to test easily if the user has all rights of the given list.
jtpl_block_common_ifacl2or()  : string
a special if block to test easily if the user has a right among a list of rights.
jtpl_block_common_ifnotacl2()  : string
a special if block to test easily a right value.

Constants

BYTECODE_CACHE_EXISTS

public mixed BYTECODE_CACHE_EXISTS = \function_exists('opcache_compile_file') || \function_exists('apc_cache_info') || \function_exists('eaccelerator_info') || \function_exists('xcache_info')
Tags

JELIX_LIB_CORE_PATH

public mixed JELIX_LIB_CORE_PATH = \JELIX_LIB_PATH . 'core/'
Tags

JELIX_LIB_PATH

public mixed JELIX_LIB_PATH = __DIR__ . '/'
Tags

JELIX_LIB_UTILS_PATH

public mixed JELIX_LIB_UTILS_PATH = \JELIX_LIB_PATH . 'utils/'
Tags

JELIX_NAMESPACE_BASE

public mixed JELIX_NAMESPACE_BASE = 'http://jelix.org/ns/'
Tags

JELIX_SCRIPTS_PATH

public mixed JELIX_SCRIPTS_PATH = __DIR__ . '/../'
Tags

LIB_PATH

public mixed LIB_PATH = \dirname(\JELIX_LIB_PATH) . '/'
Tags

Functions

sha1WithSalt()

function to use to crypt password. use the password_salt value in the config file of the plugin.

sha1WithSalt(mixed $salt, mixed $password) : mixed
Parameters
$salt : mixed
$password : mixed
Tags
deprecated
Return values
mixed

bcrypt()

hash password with blowfish algorithm. use the password_salt value in the config file of the plugin.

bcrypt(mixed $salt, mixed $password[, mixed $iteration_count = 12 ]) : mixed
Parameters
$salt : mixed
$password : mixed
$iteration_count : mixed = 12
Tags
Return values
mixed

jelix_read_ini()

jelix_read_ini(mixed $fileName[, mixed $config = null ][, mixed $ignoredSection = array() ]) : mixed
Parameters
$fileName : mixed
$config : mixed = null
$ignoredSection : mixed = array()
Tags
Return values
mixed

jelix_scan_module_sel()

jelix_scan_module_sel(mixed $selStr, mixed $selObj) : mixed
Parameters
$selStr : mixed
$selObj : mixed
Tags
Return values
mixed

jelix_scan_action_sel()

jelix_scan_action_sel(mixed $selStr, mixed $selObj, mixed $actionName) : mixed
Parameters
$selStr : mixed
$selObj : mixed
$actionName : mixed
Tags
Return values
mixed

jelix_scan_class_sel()

jelix_scan_class_sel(mixed $selStr, mixed $selObj) : mixed
Parameters
$selStr : mixed
$selObj : mixed
Tags
Return values
mixed

jelix_scan_locale_sel()

jelix_scan_locale_sel(mixed $selStr, mixed $selObj) : mixed
Parameters
$selStr : mixed
$selObj : mixed
Tags
Return values
mixed

jelix_autoload()

function used by php to try to load an unknown class.

jelix_autoload(mixed $class) : mixed
Parameters
$class : mixed
Tags
Return values
mixed

checkAppOpened()

check if the application is opened. If not, it displays the yourapp/install/closed.html file with a http error (or lib/jelix/installer/closed.html), and exit.

checkAppOpened() : mixed

This function should be called in all entry point, before the creation of the coordinator.

Tags
see
jAppManager
todo

migrate the code to jAppManager or jApp

Return values
mixed

checkAppNotInstalled()

check if the application is not installed. If the app is installed, an error message appears and the scripts ends.

checkAppNotInstalled() : mixed

It should be called only by some scripts like an installation wizard, not by an entry point.

Tags
todo

migrate the code to jAppManager or jApp

Return values
mixed

isAppInstalled()

isAppInstalled() : mixed
Tags
todo

migrate the code to jAppManager or jApp

Return values
mixed

jtpl_block_common_ifuserconnected()

a special if block to test easily if the current user is connected.

jtpl_block_common_ifuserconnected(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $params = array() ]) : string
{ifuserconnected} ..here generated content if the user is connected  {/ifuserconnected}
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$params : array<string|int, mixed> = array()

no parameters. array should be empty

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_common_ifusernotconnected()

a special if block to test easily if the current user is not connected.

jtpl_block_common_ifusernotconnected(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $params = array() ]) : string
{ifusernotconnected} ..here generated content if the user is NOTconnected  {/ifusernotconnected}
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$params : array<string|int, mixed> = array()

no parameters. array should be empty

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_cfunction_common_fetchtpl()

fetch the content of a template without template variables of calling template, except private variables setted by some plugins.

jtpl_cfunction_common_fetchtpl(jTplCompiler $compiler[, array<string|int, mixed> $param = array() ]) : string

It allows to use a template as a recursive way, in a cleaner way than include, because it doesn't inherits of variables from the parent template

Meta content must not use template variable given to 'fetch', as they will not be available at the time of meta processing (except if they are a copy of template variable of the parent template)

{fetchtpl 'myModule~foo', array('varname'=>'value) }
Parameters
$compiler : jTplCompiler

the template compiler

$param : array<string|int, mixed> = array()

0=>string the template selector (string) 1=>array a list of template variable to inject into the template 2=>boolean : inherits (true) or not of private variables. default is true.

Tags
Return values
string

the php code corresponding to the function content

jtpl_cfunction_common_fetchzone()

cfunction to fetch the content of a zone into a tpl var.

jtpl_cfunction_common_fetchzone(jTplCompiler $compiler[, mixed $params = array() ]) : string
 {fetchzone 'myVar', 'myModule~myzone', array('foo'=>'bar)}
{if $myVar !== ''}
{$myVar}
{/if}
Parameters
$compiler : jTplCompiler

the template compiler

$params : mixed = array()
Tags
Return values
string

the php code corresponding to the function content

jtpl_cfunction_common_zone()

cfunction plugin : include the content of a zone.

jtpl_cfunction_common_zone(jTplCompiler $compiler[, mixed $params = array() ]) : string
 {zone 'myModule~myzone'}
{zone 'myModule~myzone',array('foo'=>'bar)}
Parameters
$compiler : jTplCompiler

the template compiler

$params : mixed = array()
Tags
Return values
string

the php code corresponding to the function content

jtpl_function_common_dumptolog()

Dump a value into log files.

jtpl_function_common_dumptolog(jTpl $tpl, mixed $value) : mixed
Parameters
$tpl : jTpl
$value : mixed
Tags
Return values
mixed

jtpl_function_common_tolog()

Dump a value into log files.

jtpl_function_common_tolog(jTpl $tpl, mixed $message) : mixed
Parameters
$tpl : jTpl
$message : mixed
Tags
Return values
mixed

jtpl_modifier_common_datetime()

modifier plugin : change the format of a date.

jtpl_modifier_common_datetime(string $date[, string $format_out = 'lang_datetime' ][, string $format_in = '' ]) : string

The date can be given as a string, or as a DateTime object.

It uses DateTime to convert a date. It takes two optionnal arguments. The first one is the format of the output date. It should be a format understood by DateTime, or one of this format identifier: 'lang_date', 'lang_datetime', 'lang_time', 'lang_long_datetime'. By default, it use the locale datetime format. The second one is the format of the given date, if the date format is not understood by DateTime.

examples : {$mydate|datetime} {$mydate|datetime:'dd/mm/YY'}

Parameters
$date : string

the date

$format_out : string = 'lang_datetime'

the format identifier of the output date

$format_in : string = ''

the format identifier of the given date

Tags
see
jDateTime
Return values
string

the converted date

jtpl_modifier_common_jdatetime()

modifier plugin : change the format of a date.

jtpl_modifier_common_jdatetime(string $date[, string $format_in = 'db_datetime' ][, string $format_out = 'lang_date' ]) : string

It uses jDateTime to convert a date. It takes two optionnal arguments. The first one is the format identifier of the given date (by default, it is db_datetime). The second one is the format identifier of the output date (by default, it is lang_date).

Availabled format identifiers are (with the equivalent constant of jDateTime) :

  • 'lang_date' (jDateTime::LANG_DFORMAT)
  • 'lang_datetime' => jDateTime::LANG_DTFORMAT)
  • 'lang_time' => jDateTime::LANG_TFORMAT)
  • 'db_date' => jDateTime::DB_DFORMAT)
  • 'db_datetime' => jDateTime::DB_DTFORMAT)
  • 'db_time' => jDateTime::DB_TFORMAT)
  • 'iso8601' => jDateTime::ISO8601_FORMAT)
  • 'timestamp' => jDateTime::TIMESTAMP_FORMAT)
  • 'rfc822'=> jDateTime::RFC822_FORMAT)
  • 'full_lang_date'=> jDateTime::FULL_LANG_DATE

examples : {$mydate|jdatetime} {$mydate|jdatetime:'db_time':'lang_time'}

Parameters
$date : string

the date

$format_in : string = 'db_datetime'

the format identifier of the given date

$format_out : string = 'lang_date'

the format identifier of the output date

Tags
throws
jException
see
jDateTime
Return values
string

the converted date

jtpl_block_html_form()

a block to display an html form, with data from a jforms.

jtpl_block_html_form(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $param = array() ]) : string

usage : {form $theformobject,'submit_action', $submit_action_params} here form content {/form}

You can add this others parameters :

  • string $builderName (default is 'html')
  • array $options for the builder. Example, for the 'html' builder :
    • "errorDecorator"=>"name of your javascript object for error listener"
    • "method" => "post" or "get". default is "post"
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$param : array<string|int, mixed> = array()

0=>form object 1=>selector of submit action 2=>array of parameters for submit action 3=>name of the builder : default is html 4=>array of options for the builder

Tags
see
jForms
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_html_formcontrols()

a block to loop over controls list of a form and to display them.

jtpl_block_html_formcontrols(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $param = array() ]) : string

usage : {formcontrols} here content to display one control {/formcontrols} It accept also some parameters

  1. an optional jFormsBase object if the {formcontrols} is outside a {form} block
  2. an optional array of control names : only these controls will be displayed
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$param : array<string|int, mixed> = array()

empty array or 0=>jFormsBase object or 0=>jFormsBase object, 1=>array of control names or 0=>array of control names

Tags
see
jForms
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_html_formdata()

a block to display only data of a form.

jtpl_block_html_formdata(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $param = array() ]) : string

usage : {formdata $theformobject} here the form content {/formdata}

Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$param : array<string|int, mixed> = array()

0=>form object 2=>name of the builder : default is html 3=>array of options for the builder

Tags
see
jForms
since
1.0.1
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_html_formsubmits()

a block to loop over submit button list of a form and to display them.

jtpl_block_html_formsubmits(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $param = array() ]) : string

usage : {formsubmits} here content to display one submit {/formsubmits} It accept also some parameters

  1. an optional jFormsBase object if the {formsubmits} is outside a {form} block
  2. an optional array of submit control names : only these controls will be displayed
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$param : array<string|int, mixed> = array()

empty array or 0=>jFormsBase object or 0=>jFormsBase object, 1=>array of submit names or 0=>array of submit names

Tags
see
jForms
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_html_ifctrl()

a special if block to test easily the current control name TO BE USED inside a {formcontrols} block.

jtpl_block_html_ifctrl(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $params = array() ]) : string

{ifctrl 'name1','name2',...} some tpl {else} some other tpl {/ifctrl}

Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$params : array<string|int, mixed> = array()

0=>'name',etc. to match against current control name

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_html_ifctrl_value()

a special if block to test easily the current control value TO BE USED inside a {formcontrols} block.

jtpl_block_html_ifctrl_value(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $params = array() ]) : string

{ifctrl_value 'name', 'expected-value'} some tpl {else} some other tpl {/ifctrl_value}

Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$params : array<string|int, mixed> = array()

0=>'name',etc. to match against current control name and expected value

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_html_ifctrlexists()

a special if block to check if a ctrl exist in the form TO BE USED inside a `{form}` or `{formadata}` block.

jtpl_block_html_ifctrlexists(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $params = array() ]) : string

{ifctrlexists 'name1'} some tpl {else} some other tpl {/ifctrlexists}

Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$params : array<string|int, mixed> = array()

0=>'name', to match against current control name

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_html_ifctrltype()

a special if block to test easily the current control type TO BE USED inside a {formcontrols} block.

jtpl_block_html_ifctrltype(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $params = array() ]) : string

{ifctrltype 'type1','type2',...} some tpl {else} some other tpl {/ifctrltype}

Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$params : array<string|int, mixed> = array()

0=>'type',etc. to match against current control type

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_cfunction_html_formfull()

Display a full form without the use of other plugins.

jtpl_cfunction_html_formfull(jTplCompiler $compiler[, mixed $params = array() ]) : string

usage : {formfull $theformobject,'submit_action', $submit_action_params}.

You can add this others parameters :

  • string $builderName (default is 'html')
  • array $options for the builder. Example, for the 'html' builder :
    • "errorDecorator"=>"name of your javascript object for error listener"
    • "method" => "post" or "get". default is "post"
Parameters
$compiler : jTplCompiler

the template compiler

$params : mixed = array()
Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_function_html_ctrl_control()

function plugin : print the html content of a form control. You should use this plugin inside a formcontrols block.

jtpl_function_html_ctrl_control(jTpl $tpl[, string $ctrlname = '' ][, array<string|int, mixed> $attributes = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$ctrlname : string = ''

the name of the control to display (required if it is outside a formcontrols)

$attributes : array<string|int, mixed> = array()

attribute to add on the generated code (html attributes for example)

Tags
throws
jException
Return values
mixed

jtpl_function_html_ctrl_label()

function plugin : print the label of a form control. You should use this plugin inside a formcontrols block.

jtpl_function_html_ctrl_label(jTpl $tpl[, string $ctrlname = '' ][, string $format = '' ]) : mixed
Parameters
$tpl : jTpl

template engine

$ctrlname : string = ''

the name of the control to display (required if it is outside a formcontrols)

$format : string = ''
Tags
throws
jException
Return values
mixed

jtpl_function_html_ctrl_rawvalue()

function plugin : print the raw value of a form control, without trying to display a corresponding label and without to display values of child controls. You should use this plugin inside a formcontrols block.

jtpl_function_html_ctrl_rawvalue(jTpl $tpl[, string $ctrlname = '' ][, string $sep = ', ' ]) : mixed
Parameters
$tpl : jTpl

template engine

$ctrlname : string = ''

the name of the control to display (required if it is outside a formcontrols)

$sep : string = ', '

separator to display values of a multi-value control

Tags
throws
jException
Return values
mixed

jtpl_function_html_ctrl_value()

function plugin : print the value of a form control. You should use this plugin inside a formcontrols block.

jtpl_function_html_ctrl_value(jTpl $tpl[, string $ctrlname = '' ][, string $sep = ', ' ]) : mixed
Parameters
$tpl : jTpl

template engine

$ctrlname : string = ''

the name of the control to display (required if it is outside a formcontrols)

$sep : string = ', '

separator to display values of a multi-value control

Tags
throws
jException
Return values
mixed

jtpl_function_html_ctrl_value_assign()

function plugin : assign the value of the current control into the given template variable

jtpl_function_html_ctrl_value_assign(jTpl $tpl, string $varname[, string $ctrlname = '' ][, mixed $insteadOfDisplay = null ]) : mixed
Parameters
$tpl : jTpl

template engine

$varname : string

name of the template variable

$ctrlname : string = ''

the name of the control from which we retrieve the value. Empty if current control of a loop.

$insteadOfDisplay : mixed = null
Tags
throws
jException
Return values
mixed

jtpl_function_html_formdatafull()

Display all data of a form without the use of other plugins.

jtpl_function_html_formdatafull(jTpl $tpl, jFormsBase $form[, string $builder = '' ][, array<string|int, mixed> $options = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$form : jFormsBase

the form to display

$builder : string = ''

the builder type to use

$options : array<string|int, mixed> = array()

options for the builder

Tags
Return values
mixed

jtpl_function_html_formreset()

function plugin : print the html content of a form reset button.

jtpl_function_html_formreset(jTpl $tpl) : mixed
Parameters
$tpl : jTpl

template engine

Tags
Return values
mixed

jtpl_function_html_formsubmit()

function plugin : print the html content of a form submit button. You can use this plugin inside a formsubmits block.

jtpl_function_html_formsubmit(jTpl $tpl[, string $ctrlname = '' ][, array<string|int, mixed> $attributes = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$ctrlname : string = ''

the name of the submit to display (required if it is outside a formsubmits)

$attributes : array<string|int, mixed> = array()

attributes for the generated html element

Tags
throws
jException
Return values
mixed

jtpl_function_html_formurl()

function plugin : write the url corresponding to the given jelix action.

jtpl_function_html_formurl(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

Tags
Return values
mixed

jtpl_function_html_formurlparam()

function plugin : write the url corresponding to the given jelix action.

jtpl_function_html_formurlparam(jTpl $tpl[, string $selector = null ][, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string = null

selector action

$params : array<string|int, mixed> = array()

parameters for the url

Tags
Return values
mixed

jtpl_function_html_hook()

hook plugin.

jtpl_function_html_hook(jTpl $tpl, string $event[, array<string|int, mixed> $params = array() ]) : mixed

It allows to retrieve HTML content, coming from responses of an event, and inserting at the place of the hook tag.

Example:

{hook 'myevent'}

In a Jelix Event listener:

function onmyevent($event) { $event->add('
html content
'); }

Result:

html content
Parameters
$tpl : jTpl

template engine

$event : string

the event name to call

$params : array<string|int, mixed> = array()

parameters to give to the listener

Tags
Return values
mixed

jtpl_function_html_image()

image plugin : write the url corresponding to the image.

jtpl_function_html_image(jTpl $tpl, string $src[, array<string|int, mixed> $params = array() ]) : mixed

Add a link to the image, The image is resized, and cached

class :string id :string alt :string width :uint height :uint maxwidth :uint only with maxheight maxheight :uint only with maxwidth zoom 1-100 omo :boolean alignh [left|center|right|:int] alignv [top|center|bottom|:int] ext [png|jpg|gif] quality 0-100 if ext = jpg shadow :boolean soffset :uint sangle :uint sblur :uint sopacity :uint scolor #000000 :string background #000000 :string

gif -> image/gif jpeg -> image/jpeg jpg -> image/jpeg jpe -> image/jpeg xpm -> image/x-xpixmap xbm -> image/x-xbitmap wbmp -> image/vnd.wap.wbmp png -> image/png other -> image/png

Parameters
$tpl : jTpl

template engine

$src : string

the url of image relative to the www path

$params : array<string|int, mixed> = array()

parameters for the transformation and img element

Tags
Return values
mixed

jtpl_function_html_jfullurl()

function plugin : write the full url (with domain name) corresponding to the given jelix action.

jtpl_function_html_jfullurl(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ][, string $domain = null ][, bool $escape = true ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

$domain : string = null

domain name, false if you want to use the config domain name or the server name

$escape : bool = true

if true, then escape the string for html

Tags
Return values
mixed

jtpl_function_html_jlocale()

function plugin : write the localized string corresponding to the given locale key.

jtpl_function_html_jlocale(jTpl $tpl, string $locale) : mixed

example : {jlocale 'myModule~my.locale.key'}

Parameters
$tpl : jTpl

template engine

$locale : string

the locale key

Tags
Return values
mixed

jtpl_function_html_jmessage()

function plugin : Display messages from jMessage.

jtpl_function_html_jmessage(mixed $tpl[, mixed $type = '' ]) : mixed
Parameters
$tpl : mixed
$type : mixed = ''
Tags
Return values
mixed

jtpl_function_html_jrooturl()

function plugin : write the root url corresponding to the given ressource type If this ressource type is not specified in the config file, returned value will be basePath.

jtpl_function_html_jrooturl(jTpl $tpl, string $ressourceType) : mixed
Parameters
$tpl : jTpl

template engine

$ressourceType : string

the name of the ressource type

Tags
Return values
mixed

jtpl_function_html_jurl()

function plugin : write the url corresponding to the given jelix action.

jtpl_function_html_jurl(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ][, bool $escape = true ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

$escape : bool = true

if true, then escape the string for html

Tags
Return values
mixed

jtpl_function_html_jurlpattern()

function plugin: write the url corresponding to the given jelix action, inserting placeholder name (between two %) for some parameter, so you can generate the url dynamically in JS by replacing placeholders by javascript values.

jtpl_function_html_jurlpattern(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ][, array<string|int, mixed> $placeholders = array() ]) : mixed

example :

it may produce something like that (depending how the url is configured for the 'jxacl~admin_rightslist' action): index.php/acl/rightslist/%idgroup%/bar?acl=%acl%

Then you can replace placeholders

var urlpattern = document.getElementById("baz").dataset.url; var id_group = 45, acl = 'hello'; var url = urlpattern.replace("%idgroup%", id_group); url = url.replace("%acl%", acl);

Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

static parameters for the url

$placeholders : array<string|int, mixed> = array()

list of placeholders: key=name of an url parameter, value=a placeholder name you choose

Tags
Return values
mixed

function plugin : Ajax request.

jtpl_function_html_link_to_remote(mixed $tpl, mixed $label, mixed $element_id, mixed $action_selector, mixed $action_parameters, mixed $option) : mixed

it creates a javascript ajax function example :

{link_to_remote
 'Link',    
 'result',    
 'test~default:ajax', array('id'=>'34'),    
 array(
   'position'=>'html',    
   'method'=>'GET',    
   'beforeSend'=>'alert("beforeSend")',    
   'complete'=>'alert("complete")',    
   'error'=>'alert("error")',    
)}
Parameters
$tpl : mixed
$label : mixed
$element_id : mixed
$action_selector : mixed
$action_parameters : mixed
$option : mixed
Tags
Return values
mixed

displays page links.

jtpl_function_html_pagelinks(jTpl $tpl, string $action, array<string|int, mixed> $actionParams, int $itemsTotal, int $offset[, int $pageSize = 15 ][, string $paramName = 'offset' ][, array<string|int, mixed> $displayProperties = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$action : string

selector of the action

$actionParams : array<string|int, mixed>

parameters for the action

$itemsTotal : int

number of items

$offset : int

index of the first item to display

$pageSize : int = 15

items number in a page

$paramName : string = 'offset'

name of the parameter in the actionParams which will content a page offset

$displayProperties : array<string|int, mixed> = array()

properties for the links display

Tags
Return values
mixed

jtpl_function_html_resurl()

function plugin : write the url corresponding to a resource stored in a www directory of a module.

jtpl_function_html_resurl(jTpl $tpl, string $module, array<string|int, mixed> $file[, mixed $intheme = false ][, bool $escape = true ]) : mixed
Parameters
$tpl : jTpl

template engine

$module : string

the module name

$file : array<string|int, mixed>

the relative path of the wanted file to the www directory of the module

$intheme : mixed = false
$escape : bool = true

if true, then escape the string for html

Tags
Return values
mixed

jtpl_function_html_urljsstring()

function plugin : write the url corresponding to the given jelix action for javascript.

jtpl_function_html_urljsstring(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ][, mixed $jsparams = array() ]) : mixed

it creates a javascript string, that contains the url, with dynamic javasript parameters
example : {urljsstring 'jxacl~admin_rightslist',array(),array('grpid'=>'idgroup','__rnd'=>'Math.random()')};
it will produce: "index.php?module=acl&action=admin_rightslist&grpid="+idgroup+"&__rnd="+ Math.random();

Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

$jsparams : mixed = array()
Tags
Return values
mixed

jtpl_meta_html_html()

meta plugin : modify an html response object.

jtpl_meta_html_html(jTpl $tpl, string $method[, mixed $param = null ][, mixed $params = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$method : string

indicates what you want to specify (possible values : js, css, jsie, jsie7, jsltie7, cssie, cssie7, cssltie7, csstheme, cssthemeie, cssthemeie7, cssthemeltie7, bodyattr, keywords, description, others)

$param : mixed = null

parameter (a css style sheet for "css" for example)

$params : mixed = array()
Tags
see
jResponseHtml
params

array $params additionnal parameters (a media attribute for stylesheet for example)

Return values
mixed

jtpl_meta_html_htmlmodule()

meta plugin : allow to add css files and js files stored into modules, in an html response object.

jtpl_meta_html_htmlmodule(jTpl $tpl, string $method, string $module, mixed $path[, mixed $params = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$method : string

indicates what you want to specify (possible values : js, css, jsie, cssie, cssie7, cssltie7, csstheme, cssthemeie, cssthemeie7, cssthemeltie7)

$module : string

the module where file is stored

$path : mixed

the relative path inside the {module}/www/ directory, or inside the {module}/www/themes/{currenttheme}/ directory

$params : mixed = array()
Tags
see
jResponseHtml
params

array $params additionnal parameters for the generated tag (a media attribute for stylesheet for example)

Return values
mixed

jtpl_modifier_html_vardump()

Dump any value.

jtpl_modifier_html_vardump(mixed $value) : string
Parameters
$value : mixed
Return values
string

jtpl_function_ltx2pdf_jlocale()

function plugin : write the localized string corresponding to the given locale key.

jtpl_function_ltx2pdf_jlocale(jTpl $tpl, string $locale) : mixed

example : {jlocale 'myModule~my.locale.key'}

Parameters
$tpl : jTpl

template engine

$locale : string

the locale key

Tags
Return values
mixed

jtpl_function_ltx2pdf_jurl()

function plugin : write the url corresponding to the given jelix action.

jtpl_function_ltx2pdf_jurl(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

Tags
Return values
mixed

jtpl_function_text_formdatafull()

Display all data of a form without the use of other plugins.

jtpl_function_text_formdatafull(jTpl $tpl, jFormsBase $form) : mixed
Parameters
$tpl : jTpl

template engine

$form : jFormsBase

the form to display

Tags
Return values
mixed

jtpl_function_text_jfullurl()

function plugin : write the full url (with domain name) corresponding to the given jelix action.

jtpl_function_text_jfullurl(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ][, string $domain = false ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

$domain : string = false

domain name, false if you want to use the config domain name or the server name

Tags
Return values
mixed

jtpl_function_text_jlocale()

function plugin : write the localized string corresponding to the given locale key.

jtpl_function_text_jlocale(jTpl $tpl, string $locale) : mixed

example : {jlocale 'myModule~my.locale.key'}

Parameters
$tpl : jTpl

template engine

$locale : string

the locale key

Tags
Return values
mixed

jtpl_function_text_jurl()

function plugin : write the url corresponding to the given jelix action.

jtpl_function_text_jurl(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

Tags
Return values
mixed

jtpl_modifier_html_vardump()

Dump any value.

jtpl_modifier_html_vardump(mixed $value) : string
Parameters
$value : mixed
Tags
Return values
string

jtpl_function_xml_jfullurl()

function plugin : write the full url (with domain name) corresponding to the given jelix action.

jtpl_function_xml_jfullurl(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ][, string $domain = null ][, bool $escape = true ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

$domain : string = null

domain name, false if you want to use the config domain name or the server name

$escape : bool = true

if true, then escape the string for html

Tags
Return values
mixed

jtpl_function_xml_jlocale()

function plugin : write the localized string corresponding to the given locale key.

jtpl_function_xml_jlocale(jTpl $tpl, string $locale) : mixed

example : {jlocale 'myModule~my.locale.key'}

Parameters
$tpl : jTpl

template engine

$locale : string

the locale key

Tags
Return values
mixed

jtpl_function_xml_jurl()

function plugin : write the url corresponding to the given jelix action.

jtpl_function_xml_jurl(jTpl $tpl, string $selector[, array<string|int, mixed> $params = array() ][, bool $escape = true ]) : mixed
Parameters
$tpl : jTpl

template engine

$selector : string

selector action

$params : array<string|int, mixed> = array()

parameters for the url

$escape : bool = true

if true, then escape the string for xml

Tags
Return values
mixed

jtpl_meta_xml_xml()

meta plugin : modify an xml response object.

jtpl_meta_xml_xml(jTpl $tpl, string $method, mixed $param) : mixed
Parameters
$tpl : jTpl

template engine

$method : string

indicates what you want to specify (possible values : xsl,css,csstheme)

$param : mixed

parameter (a css style sheet url for "css" for example)

Tags
see
jResponseXml
Return values
mixed

is_resource()

Check if the given value is a resource or not.

is_resource(mixed $value) : bool

It take care about internal classes that replaced resources into PHP 8.0, like GdImage, CurlHandle etc..

Parameters
$value : mixed
Tags
Return values
bool

utf8_decode()

utf8_decode(mixed $str) : mixed
Parameters
$str : mixed
Tags
Return values
mixed

utf8_encode()

utf8_encode(mixed $str) : mixed
Parameters
$str : mixed
Tags
Return values
mixed

jtpl_block_common_ifacl()

a special if block to test easily a right value.

jtpl_block_common_ifacl(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $param = array() ]) : string
{ifacl 'subject','value', 54} ..here generated content if the user has the right  {/ifacl}
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$param : array<string|int, mixed> = array()

0=>subject 1=>right value 2=>optional resource

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_common_ifnotacl()

a special if block to test easily a right value.

jtpl_block_common_ifnotacl(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $params = array() ]) : string
{ifnotacl 'subject','value',54} ..here generated content if the user has NOT the right  {/ifnotacl}
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$params : array<string|int, mixed> = array()

0=>subject 1=>right value 2=>optional resource

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_common_ifacl2()

a special if block to test easily a right value.

jtpl_block_common_ifacl2(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $param = array() ]) : string
{ifacl2 'right',54} ..here generated content if the user has the right  {/ifacl2}
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$param : array<string|int, mixed> = array()

0=>subject 1=>optional resource

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_common_ifacl2and()

a special if block to test easily if the user has all rights of the given list.

jtpl_block_common_ifacl2and(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $param = array() ]) : string
{ifacl2and 'right1', 'right2', 'right3'} ..here generated content if the user has all given rights {/ifacl2and}
{ifacl2and array('right1', 'right2', 'right3')} ..here generated content if the user has all given rights {/ifacl2and}
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$param : array<string|int, mixed> = array()

0=>subject 1=>optional resource

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_common_ifacl2or()

a special if block to test easily if the user has a right among a list of rights.

jtpl_block_common_ifacl2or(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $param = array() ]) : string
{ifacl2or 'right1', 'right2', 'right3'} ..here generated content if the user has one of given rights  {/ifacl2or}
{ifacl2or array('right1', 'right2', 'right3')} ..here generated content if the user has one of given rights  {/ifacl2or}
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$param : array<string|int, mixed> = array()

0=>subject 1=>optional resource

Tags
Return values
string

the php code corresponding to the begin or end of the block

jtpl_block_common_ifnotacl2()

a special if block to test easily a right value.

jtpl_block_common_ifnotacl2(jTplCompiler $compiler, bool $begin[, array<string|int, mixed> $params = array() ]) : string
{ifnotacl2 'right',54} ..here generated content if the user has NOT the right  {/ifnotacl2}
Parameters
$compiler : jTplCompiler

the template compiler

$begin : bool

true if it is the begin of block, else false

$params : array<string|int, mixed> = array()

0=>subject 1=>optional resource

Tags
Return values
string

the php code corresponding to the begin or end of the block

Search results