Jelix 1.7.11

API Documentation

Namespaces

Jelix

Interfaces, Classes and Traits

jIAuthDriver
interface for auth drivers.
jIAuthDriver2
interface for auth drivers.
jIAuthDriver3
interface for auth drivers
jIRestController
interface for controllers used for RESTFull request/response.
jICoordPlugin
interface that should implement all coordinator plugins.
jISimpleCompiler
interface for compiler which needs only one source file.
jIMultiFileCompiler
interface for compiler which needs many source files The PHP file generated by the compiler should check itself if it is still valid. The file should have a "return" statement with a boolean : true if it is ok, false if it should be recompiled.
jISelector
interface of selector classes.
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.
jIFormsDatasource
Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.
jIFormsDatasource2
Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.
jIFormsDynamicDatasource
Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.
jIUrlSignificantHandler
jIInstallerComponent
jIInstallReporter
interface for classes used as reporter for installation or check etc... This classes are responsible to show informations to the user.
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
jIAuthDriverClass
interface for classes used with the jAuthDriverClass.
jIDebugbarPlugin
interface for plugins for the debugbar.
jICacheDriver
Interface for cache drivers.
jIFilteredDatatype
interface for datatypes which can filter value.
jAcl2AuthAdapterInterface
Interface for authentication adapters for jAcl2.
jIAcl2Driver
interface for jAcl2 drivers.
jIAcl2Driver2
interface for jAcl2 drivers.
jAuth
This is the main class for authentification process.
jAuthDriverBase
base class for some jAuth drivers.
jAuthDummyUser
internal use.
jAuthUser
default object to represent a user.
jAuthUserLDAP
object which represent a user for LDAP driver.
jControllerCmdLine
a base class for controllers used in command line application.
jControllerDaoCrud
a base class for crud controllers.
jControllerDaoCrudDfk
a base class for crud controllers, for DAO which have a primary key based on two fields, a "static" field (a field that we know the value and which is a criteria to to select all viewed record), and a "dynamic" field (the value of the field is created by the user or autoincremented).
jControllerDaoCrudFilter
a base class for crud controllers.
jApp
jAppInstance
jAutoloader
jBasicErrorHandler
Error handlers for the framework.
jBundle
a bundle contains all readed properties in a given language, and for all charsets.
jCmdlineCoordinator
The command line version of jCoordinator.
jConfig
static class which loads the configuration.
jConfigAutoloader
jConfigCompiler
jConfigCompiler merge two ini file in a single array and store it in a temporary file This is a static class.
jController
class base for controllers.
jCoordinator
the main class of the jelix core.
jCoordinatorDebug
the main class of the jelix core.
jException
Jelix Exception.
jFramework
jHttpErrorException
Jelix Exception to generate an HTTP error.
jHttp404NotFoundException
Jelix Exception to generate an HTTP 404 error.
jHttp401UnauthorizedException
Jelix Exception to generate an HTTP 401 error.
jHttp403ForbiddenException
Jelix Exception to generate an HTTP 403 error.
jHttpResponseException
Jelix Exception to generate an HTTP error. Deprecated class.
jIncluder
This object is responsible to load cache files.
jLocale
static class to get a localized string.
jLog
utility class to log some message into a file into yourapp/var/log.
jRequest
base class for object which retrieve all parameters of an http request. The process depends on the type of request (ex: xmlrpc..).
jResponse
base class for response object A response object is responsible to generate a content in a specific format.
jExceptionSelector
Exception for selector errors.
jSelectorFactory
Create instance of selectors object.
jServer
Static class providing some utilities to retrieve informations about the server.
jSession
session management class of the jelix core.
jUrl
Object that contains url data, and which provides static method helpers.
jUrlAction
A container to store url data for an action.
jUrlBase
base class for jUrl and jUrlAction.
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.
jClassicRequest
handle "classical" request it just gets parameters from the url query and the post content. And responses can be in many format : text, html, xml.
jCmdLineRequest
a request object for scripts used in a command line.
jCssRequest
handle classical request but only to control and produce css content.
jJsonRpcRequest
handle a JSON-rpc call. The response has to be a json rpc response.
jXmlRpcRequest
handle XML-rpc call. The response has to be a xml-rpc response.
jResponseBasicHtml
Basic HTML response. the HTML content should be provided by a simple php file.
jResponseBinary
Response use to send a binary file to the browser.
jResponseCmdline
Command line response.
jResponseCss
Send CSS content.
jResponseHtml
HTML5 response.
jResponseHtml4
Response class for HTML 4 or XHTML 1.x.
jResponseHtmlError
HTML5 response to display HTTP errors.
jResponseHtmlFragment
Send Html part.
jResponseJson
Json response.
jResponseJsonRpc
Response for jsonrpc protocol.
jResponseRedirect
Response To redirect to an action.
jResponseRedirectUrl
Response To redirect to an URL.
jResponseText
plain Text response.
jResponseXml
XML response generator.
jResponseXmlRpc
xmlrpc response.
jResponseZip
generate a zip content and send it to the browser.
jSelectorAct
Generic Action selector.
jSelectorAppCfg
Selector for files stored in the app/system directory.
jSelectorCfg
Selector for files stored in the var/config directory.
jSelectorClass
selector for business class.
jSelectorDao
Selector for dao file syntax : "module~daoName".
jSelectorDaoDb
see jISelector.iface.php for documentation about selectors.
jSelectorDaoRecord
Selector for dao file syntax : "module~daoRecordName".
jSelectorForm
Form selector.
jSelectorIface
selector for interface.
jSelectorLib
Selector for files stored in the lib directory.
jSelectorLoc
selector for localisation string.
jSelectorLog
Selector for files stored in the log directory.
jSelectorModule
base class for all selector concerning module files.
jSelectorSimpleFile
base class for simple file selector.
jSelectorTmp
Selector for files stored in the temp directory.
jSelectorTpl
Template selector.
jSelectorVar
Selector for files stored in the var directory.
jSelectorZone
Zone selector.
errorCtrl
class base for controllers.
errorCtrl
class base for controllers.
errorCtrl
class base for controllers.
helpCtrl
a base class for controllers used in command line application.
jformsCtrl
class base for controllers.
wwwCtrl
class base for controllers.
jelixModuleConfigurator
Base class for classes which configure a module.
jelixModuleInstaller
Bas class for classes that does processing to install a module into an instance of the application. A module should have a class that inherits from it in order to setup itself into the application.
jelixModuleUpgrader
Bas class for classes that does processing to install a module into an instance of the application. A module should have a class that inherits from it in order to setup itself into the application.
jelixModuleUpgrader_01_notfoundact
Bas class for classes that does processing to install a module into an instance of the application. A module should have a class that inherits from it in order to setup itself into the application.
checkZoneInstallReporter
an HTML reporter for jInstallChecker.
check_installZone
a zone to display a default start page with results of the installation check.
jDao
Factory to create DAO objects.
jDaoCompiler
The compiler for the DAO xml files. it is used by jIncluder It produces some php classes.
jDaoCondition
content a sub group of conditions.
jDaoConditions
container for all criteria of a query.
jDaoDbMapper
It allows to create tables corresponding to a dao file.
jDaoFactoryBase
base class for all factory classes generated by the dao compiler.
jDaoGenerator
This is a generator which creates php class from dao xml file.
jDaoMethod
containers for properties of dao method.
jDaoParser
extract data from a dao xml content.
jDaoProperty
Container for properties of a dao property.
jDaoRecordBase
Base class for all record classes generated by the dao compiler.
jDaoXmlException
Exception for Dao compiler.
jSQLLogMessage
class that handles a sql query for a logger.
jDb
factory for database connector and other db utilities.
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
jDbConnection
jDbParameters
allow to normalize & analyse database parameters.
jDbPDOConnection
A connection object based on PDO.
jDbPDOConnectionDebug
A connection object based on PDO, for debugging.
jDbPDOResultSet
a resultset based on PDOStatement for PHP >= 8.0.
jDbPDOResultSet7
a resultset based on PDOStatement, for PHP < 8.0.
jDbResultSet
represent a statement result set or a prepared statement result set.
jDbSchema
jDbTable
jDbFieldProperties
Description of a field of a table.
jDbTools
Provides utilities methods for a database.
jDbUtils
jDbWidget
jDbMysqlTools
Provides utilities methods for a mysql database.
jDbOciTools
Provides utilities methods for a database.
jDbPgsqlTools
Provides utilities methods for a database.
jDbSqliteTools
tools to manage a sqlite database.
jDbSqlsrvTools
Provides utilities methods for a database.
jEvent
Class which represents an event in the event system.
jEventCompiler
jEventListener
base class for event listeners.
jFormsControlButton
base class for all jforms control.
jFormsControlCaptcha
captcha control.
jFormsControlCheckbox
base class for all jforms control.
jFormsControlCheckboxes
Checkboxes control (contains several checkboxes).
jFormsControlChoice
choice control.
jFormsControlColor
base class for all jforms control.
jFormsControlDatasource
base class for controls which uses a datasource to fill their contents.
jFormsControlDate
base class for all jforms control.
jFormsControlDatetime
base class for all jforms control.
jFormsControlGroup
group control.
jFormsControlGroups
abstract classes for controls which contain other controls.
jFormsControlHidden
base class for all jforms control.
jFormsControlHtmlEditor
base class for all jforms control.
jFormsControlImageUpload
base class for all jforms control.
jFormsControlInput
base class for all jforms control.
jFormsControlListbox
listbox.
jFormsControlMenulist
menulist/combobox.
jFormsControlOutput
base class for all jforms control.
jFormsControlRadiobuttons
control which contains several radio buttons.
jFormsControlRepeat
abstract classes for controls which contain other controls.
jFormsControlReset
base class for all jforms control.
jFormsControlSecret
base class for all jforms control.
jFormsControlSecretConfirm
base class for all jforms control.
jFormsControlSubmit
base class for controls which uses a datasource to fill their contents.
jFormsControlSwitch
switch.
jFormsControlTextarea
base class for all jforms control.
jFormsControlTime
base class for all jforms control.
jFormsControlUpload
base class for all jforms control.
jFormsControlUpload2
base class for all jforms control.
jFormsControlWikiEditor
base class for all jforms control.
jForms
static class to manage and call a form.
jExceptionForms
exception for jforms.
jFormsBase
base class of all form classes generated by the jform compiler.
jFormsCompiler
Generates form class from an xml file describing the form.
jFormsCompiler_jf_1_0
generates form class from an xml file describing the form.
jFormsCompiler_jf_1_1
generates form class from an xml file describing the form.
jFormsControl
base class for all jforms control.
jFormsDataContainer
this object is a container for form data.
jFormsStaticDatasource
A datasource which is based on static values.
jFormsDynamicDatasource
Base class for a datasource which is based on a class and can be used for dynamic listboxes or menulists.
jFormsDaoDatasource
A datasource which is based on a dao.
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.
jFormsBuilderBase
base class of all builder form classes generated by the jform compiler.
jFormsBuilderHtml
HTML form builder.
ghostInstallReporter
a reporter which reports... nothing.
jInstallCheck
check an installation of a jelix application.
jInstaller
main class for the installation.
jInstallerApplication
Application configuration reader and manager.
jInstallerEntryPoint
container for entry points properties.
jInstallerException
Installer Exception.
jInstallerMessageProvider
message provider for jInstallCheck and jInstaller.
jInstallerModule
A class that does processing to configure and install a module into an application. A module should have a class that inherits from it in order to configure itself into the application.
textInstallReporter
reporter echoing simply the messages.
jKVDb
main class to access to key-value storage databases.
jKVDriver
classAuthDriver
Driver for a class which implement an authentification.
dbAuthDriver
authentification driver for authentification information stored in a database.
ldapAuthDriver
LDAP authentification driver for authentification information stored in LDAP server.
dbCacheDriver
cache driver for data stored in a database Warning : Beware about the time returned by the DBMS of the server and the server PHP client : possible asynchronous time (particulary in case of use of multiple servers, incoherent data can be involved).
memcacheCacheDriver
cache driver for data stored in Memcached. Use the memcache extension of PHP.
redis_extCacheDriver
assetsrevisionConfigCompilerPlugin
debugbarConfigCompilerPlugin
localesConfigCompilerPlugin
nsautoloaderConfigCompilerPlugin
responsesConfigCompilerPlugin
sessionConfigCompilerPlugin
webassetsConfigCompilerPlugin
AuthCoordPlugin
AutoLocaleCoordPlugin
plugin for language auto detection.
historyCoordPlugin
traceexecCoordPlugin
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.
mssqlDbTable
mssqlDbSchema
mysqliDbConnection
mysqliDbResultSet
Object to fetch result, wrapping the underlaying result object of mysqli.
mysqliDbTable
mysqliDbSchema
ociDbConnection
ociDbResultSet
represent a statement result set or a prepared statement result set.
ociDbTable
ociDbSchema
pgsqlDbConnection
pgsqlDbResultSet
represent a statement result set or a prepared statement result set.
pgsqlDbTable
pgsqlDbSchema
sqlite3DbConnection
sqlite3DbResultSet
Couche d'encapsulation des resultset sqlite.
sqlite3DbTable
sqlite3DbSchema
sqlsrvDbConnection
sqlsrvDbResultSet
Layer encapsulation resultset mssql.
sqlsrvDbTable
sqlsrvDbSchema
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.
htmlFormBuilder
HTML form builder.
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.
button_htmlFormWidget
HTML form builder.
captcha_htmlFormWidget
HTML form builder.
checkbox_htmlFormWidget
HTML form builder.
checkboxes_htmlFormWidget
HTML form builder.
choice_htmlFormWidget
HTML form builder.
color_htmlFormWidget
HTML form builder.
date_htmlFormWidget
HTML form builder.
datetime_htmlFormWidget
HTML form builder.
group_htmlFormWidget
HTML form builder.
htmlFormWidget
htmleditor_htmlFormWidget
HTML form builder.
imageupload_htmlFormWidget
Widget to display an image selector/editor.
input_htmlFormWidget
HTML form builder.
listbox_htmlFormWidget
HTML form builder.
menulist_htmlFormWidget
HTML form builder.
output_htmlFormWidget
HTML form builder.
radiobuttons_htmlFormWidget
HTML form builder.
recaptcha_htmlFormWidget
jForms widget that shows reCaptcha.
reset_htmlFormWidget
HTML form builder.
secret_htmlFormWidget
HTML form builder.
secretconfirm_htmlFormWidget
HTML form builder.
submit_htmlFormWidget
HTML form builder.
textarea_htmlFormWidget
HTML form builder.
time_htmlFormWidget
HTML form builder.
upload2_htmlFormWidget
Widget to display the selection of a file to upload.
upload_htmlFormWidget
HTML form builder.
wikieditor_htmlFormWidget
HTML form builder.
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.
htmlJformsBuilder
HTML form builder.
htmllightJformsBuilder
HTML form builder.
dbKVDriver
Driver for jKVDB, that uses an SQL table to store key/value data.
dbaKVDriver
file2KVDriver
fileServer
memcacheKVDriver
redis_extKVDriver
firebugLogger
legacysyslogLogger
logger storing message into syslog using old api.
soapfileLogger
logger storing soap message into several xml files.
jdbProfilesCompiler
default plugin for jProfilesCompiler, and base plugin for other plugins.
jTpl
template engine.
jTplCompiler
This is the compiler of templates: it converts a template into a php file.
jAppManager
utilities to manage a jelix application.
jCache
Global caching data provided from whatever sources.
jClassBinding
Services binding for jelix.
jClasses
This object is responsible to include and instancy some classes stored in the classes directory of modules.
jCmdUtils
utilities functions for command line.
jDatatype
jDatatypeString
Datatype String.
jDatatypeHtml
Datatype HTML String.
jDatatypeBoolean
Datatype Booléen.
jDatatypeDecimal
Datatype Decimal.
jDatatypeInteger
Datatype Integer.
jDatatypeHexadecimal
Datatype Hexa.
jDatatypeDateTime
Datatype datetime.
jDatatypeTime
Datatype time.
jDatatypeDate
Datatype date.
jDatatypeLocaleDateTime
Datatype localedatetime.
jDatatypeLocaleDate
Datatype localedate.
jDatatypeLocaleTime
Datatype localetime.
jDatatypeLocaleTimeShort
Datatype localetime.
jDatatypeUrl
Datatype url.
jDatatypeIPv4
Datatype ipv4.
jDatatypeIPv6
Datatype ipv6.
jDatatypeEmail
Datatype mail.
jDatatypeColor
Datatype Color.
jDateTime
Utility to manipulate dates and convert date format.
jDuration
Utility to manipulate durations between two instants.
jFile
A class helper to read or create files.
jFilter
utility class to check values.
jImageModifier
Utility class to manipulate image.
jIniFile
utility class to read and write an ini file.
jIniFileModifier
utility class to modify an ini file by preserving comments, whitespace.. It follows same behaviors of parse_ini_file, except when there are quotes inside values. it doesn't support quotes inside values, because parse_ini_file is totally bugged, depending cases.
jIniMultiFilesModifier
utility class to read and modify two ini files at the same time : one master file, and one file which overrides values of the master file, like we have in jelix with mainconfig.ini.php and config.ini.php of an entry point.
jJsonRpc
object which encode and decode a jsonrpc request and response.
jMailer
jMailer based on PHPMailer - PHP email transport class.
jMessage
Utility class to log some message in session in order to be displayed in a template.
jMethodSniffer
Utility class to "sniff" method calls to a class instance so that those calls may be repeated later on. The sniffed method should not use any of the magic methods used here (namely __get, __set, __call and __toString).
jProfiles
class to read profiles from the profiles.ini.php.
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.
jRedis
extends the class Redis from the phpredis extension.
jSmtp
SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.
jLogSoapMessage
class that handles a dump of a php value, for a logger.
SoapClientDebug
jSoapClient
provide a soap client where configuration information are stored in the profile file.
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.
jXmlRpc
object to encode decode some XMl-RPC request and XMl-RPC response.
jBinaryData
jZipCreator
Class to create a zip file.
jZone
jZone is a representation of a zone in an response content, in a html page.
jAcl2
Main class to query the acl system, and to know value of a right.
jAcl2Authentication
Makes the glue between jAcl2 and an authentication library.
jAcl2JAuthAdapter
Adapter to jAuth for jAcl2.
jAcl2Db
Utility class for all classes used for the db driver of jAcl2.
jacl2dbListener
base class for event listeners.
jAcl2DbAdminCheckAuthorizations
Allow to verify admin rights when a change occurs in the authorizations.
jAcl2DbAdminUIException
jAcl2DbAdminUIManager
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.
jPref
jPrefItem
jPrefItemGroup
jPrefManager
jInstallerReporterTrait

Table of Contents

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/'
JELIX_VERSION  = '1.7.0-beta.2'
Initialize all defines and includes necessary files.
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_breadcrumb()  : mixed
breadcrumb plugin : display breadcrumb trails, ie. user navigation tracking.
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.

Constants

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

JELIX_VERSION

Initialize all defines and includes necessary files.

public mixed JELIX_VERSION = '1.7.0-beta.2'
Tags
subpackage

core

author

Laurent Jouanneau

contributor

Loic Mathaud, Julien Issler

copyright

2005-2020 Laurent Jouanneau

copyright

2007 Julien Issler

see
http://www.jelix.org
licence

GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html

LIB_PATH

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

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

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

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

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

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 :

$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[2][xx] Parameter of the Flash Player $params[3][xx] Flashvar for the Flash Player

Parameters
$tpl : jTpl

template engine

$params : array<string|int, mixed>

parameters for the url

Return values
string

PHP generated code

jtpl_function_html_breadcrumb()

breadcrumb plugin : display breadcrumb trails, ie. user navigation tracking.

jtpl_function_html_breadcrumb(jTpl $tpl[, array<string|int, mixed> $nb = null ][, string $separator = '' ]) : mixed
Parameters
$tpl : jTpl

template engine

$nb : array<string|int, mixed> = null

the number of items displayed by the plugin

$separator : string = ''

Symbol separating items

Return values
mixed

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

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

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

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

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

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)

Tags
see
jResponseXml
Return values
mixed

Search results