Jelix 1.7.18

jelix

Packages

auth
controllers
core
modules
dao
db
events
forms
installer
kvdb
cache
coord
daobuilder
debugbar
responsehtml
logger
profiles
jtpl
scripts
utils
datatypes
WebAssets
acl2
acl
jacl2db

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.
CaptchaValidatorInterface: Interface for validators for the captcha widget.
ParentWidgetInterface: Interface for widgets that can have children widget: main builder, choice etc.
WidgetInterface: Interface for HTML widgets plugins.
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.
jAuthDriverBase: base class for some jAuth drivers.
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.
jResponseHtml4: Response class for HTML 4 or XHTML 1.x.
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
HtmlBuilder: Main HTML form builder.
ReCaptchaValidator
SimpleCaptchaValidator
RootWidget
WidgetBase
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.
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.
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.
file2KVDriver
fileServer
legacysyslogLogger: logger storing message into syslog using old api.
soapfileLogger: logger storing soap message into several xml files.
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.
WebAssetsCompiler
WebAssetsSelection
jInstallerReporterTrait

BYTECODE_CACHE_EXISTS = unction_exists('opcache_compile_file') || unction_exists('apc_cache_info') || unction_exists('eaccelerator_info') || unction_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/'
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_block_html_swfjs() : string: swfjs plugin : Adds html and JS code to display a swf.
jtpl_cfunction_html_formfull() : string: Display a full form without the use of other plugins.
jtpl_cfunction_html_swfbiscuit() : string: swfbiscuit plugin : Adds html code to display a swf.
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_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

BYTECODE_CACHE_EXISTS


    public
    mixed
    BYTECODE_CACHE_EXISTS
    = unction_exists('opcache_compile_file') || unction_exists('apc_cache_info') || unction_exists('eaccelerator_info') || unction_exists('xcache_info')

JELIX_LIB_CORE_PATH


    public
    mixed
    JELIX_LIB_CORE_PATH
    = JELIX_LIB_PATH . 'core/'

JELIX_LIB_PATH


    public
    mixed
    JELIX_LIB_PATH
    = __DIR__ . '/'

JELIX_LIB_UTILS_PATH


    public
    mixed
    JELIX_LIB_UTILS_PATH
    = JELIX_LIB_PATH . 'utils/'

JELIX_NAMESPACE_BASE


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

LIB_PATH


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

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

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

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()

Return values

mixed —

jelix_scan_module_sel()


    
                jelix_scan_module_sel(mixed $selStr, mixed $selObj) : mixed

Parameters

$selStr : mixed
$selObj : mixed

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

Return values

mixed —

jelix_scan_class_sel()


    
                jelix_scan_class_sel(mixed $selStr, mixed $selObj) : mixed

Parameters

$selStr : mixed
$selObj : mixed

Return values

mixed —

jelix_scan_locale_sel()


    
                jelix_scan_locale_sel(mixed $selStr, mixed $selObj) : mixed

Parameters

$selStr : mixed
$selObj : mixed

Return values

mixed —

jelix_autoload()

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


    
                jelix_autoload(mixed $class) : mixed

Parameters

$class : mixed

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.

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.

Return values

mixed —

isAppInstalled()


    
                isAppInstalled() : mixed

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

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

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.

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()

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()

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

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

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

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

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

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

an optional jFormsBase object if the {formcontrols} is outside a {form} block
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

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

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

an optional jFormsBase object if the {formsubmits} is outside a {form} block
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

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

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

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

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

Return values

string —

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

jtpl_block_html_swfjs()

swfjs plugin : Adds html and JS code to display a swf.


    
                jtpl_block_html_swfjs(jTplCompiler $compiler, bool $begin, array<string|int, mixed> $params) : string

Example : {swfjs 'promobidon.swf', array('id'=>'promo', 'width'=>150, 'height'=>90, 'detect'=>true), array('quality'=>'hight', 'wmode'=>'transparent'), array('longeur'=>150)} {image 'toupie.png'} {/swfjs}

Render after the execution of javascript file :

$params[0] url of the swf $params[1]['id'] id of <object .../> $params[1]['class'] class of <object .../> $params[1]['width'] Width final of SWF $params[1]['height'] Height final of SWF $params[1]['version'] (ex: '6.0.65') Detect specific major, minor and revision versions of the Flash plugin. $params[1]['expressinstall'] (true:Bool) Use Express Install, or show an update message if Flash isn't installed. OR $params[1]['update'] (false:Bool) Or, degrade silently and gracefully. $params[2][xx] Parameter of the Flash Player $params[3][xx] Flashvar for the Flash Player

Parameters

$compiler : jTplCompiler: the template compiler
$begin : bool: true if it is the begin of block, else false
$params : array<string|int, mixed>: parameters for the url

Return values

string —

PHP generated code

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()

Return values

string —

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

jtpl_cfunction_html_swfbiscuit()

swfbiscuit plugin : Adds html code to display a swf.


    
                jtpl_cfunction_html_swfbiscuit(jTpl $tpl, array<string|int, mixed> $params) : string

Example : {swfbiscuit 'promobidon.swf', array('id'=>'promo', 'width'=>150, 'height'=>90), array('quality'=>'hight', 'wmode'=>'transparent'), array('longeur'=>150)}

Render :

Parameters

$tpl : jTpl: template engine
$params : array<string|int, mixed>: parameters for the url

Return values

string —

PHP generated code

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)

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 = ''

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

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

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

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

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

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

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

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

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

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

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

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 = ''

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

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

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

Return values

mixed —

jtpl_function_html_link_to_remote()

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

Return values

mixed —

jtpl_function_html_pagelinks()

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

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

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()

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()

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()

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

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

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

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

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

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

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_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

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

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

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)

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

Return values

bool —

utf8_decode()


    
                utf8_decode(mixed $str) : mixed

Parameters

$str : mixed

Return values

mixed —

utf8_encode()


    
                utf8_encode(mixed $str) : mixed

Parameters

$str : mixed

Return values

mixed —

jelix

Packages

Interfaces, Classes and Traits

Table of Contents

Constants

BYTECODE_CACHE_EXISTS

JELIX_LIB_CORE_PATH

JELIX_LIB_PATH

JELIX_LIB_UTILS_PATH

JELIX_NAMESPACE_BASE

LIB_PATH

Functions

sha1WithSalt()

Parameters

Tags

Return values

bcrypt()

Parameters

Return values

jelix_read_ini()

Parameters

Return values

jelix_scan_module_sel()

Parameters

Return values

jelix_scan_action_sel()

Parameters

Return values

jelix_scan_class_sel()

Parameters

Return values

jelix_scan_locale_sel()

Parameters

Return values

jelix_autoload()

Parameters

Return values

checkAppOpened()

Tags

Return values

checkAppNotInstalled()

Tags

Return values

isAppInstalled()

Tags

Return values

jtpl_block_common_ifuserconnected()

Parameters

Return values

jtpl_block_common_ifusernotconnected()

Parameters

Return values

jtpl_cfunction_common_fetchtpl()

Parameters

Return values

jtpl_cfunction_common_fetchzone()

Parameters

Return values

jtpl_cfunction_common_zone()

Parameters

Return values

jtpl_function_common_dumptolog()

Parameters

Return values

jtpl_function_common_tolog()

Parameters

Return values

jtpl_modifier_common_datetime()

Parameters

Tags

Return values

jtpl_modifier_common_jdatetime()

Parameters

Tags

Return values

jtpl_block_html_form()

Parameters

Tags

Return values

jtpl_block_html_formcontrols()