Functions

bcrypt

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

package

jelix

Arguments

$salt

mixed

$password

mixed

$iteration_count

mixed

« More »

checkAppNotInstalled

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

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

package

jelix

todo

migrate the code to jAppManager or jApp

« More »

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.

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

package

jelix

see \jAppManager
todo

migrate the code to jAppManager or jApp

« More »

isAppInstalled

package

jelix

todo

migrate the code to jAppManager or jApp

« More »

jelix_autoload

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

package

jelix

Arguments

$class

mixed

« More »

jelix_read_ini

package

jelix

Arguments

$fileName

$config

$ignoredSection

« More »

jelix_scan_action_sel

package

jelix

Arguments

$selStr

$selObj

$actionName

« More »

jelix_scan_class_sel

package

jelix

Arguments

$selStr

$selObj

« More »

jelix_scan_locale_sel

package

jelix

Arguments

$selStr

$selObj

« More »

jelix_scan_module_sel

package

jelix

Arguments

$selStr

$selObj

« More »

jtpl_block_common_ifuserconnected

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

{ifuserconnected} ..here generated content if the user is connected  {/ifuserconnected}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

no parameters. array should be empty

Response

string

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

« More »

jtpl_block_common_ifusernotconnected

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

{ifusernotconnected} ..here generated content if the user is NOTconnected  {/ifusernotconnected}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

no parameters. array should be empty

Response

string

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

« More »

jtpl_block_html_form

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

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"

package

jelix

see \jForms

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

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

Response

string

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

« More »

jtpl_block_html_formcontrols

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

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

package

jelix

see \jForms

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

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

Response

string

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

« More »

jtpl_block_html_formdata

a block to display only data of a form.

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

package

jelix

see \jForms
since 1.0.1

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

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

Response

string

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

« More »

jtpl_block_html_formsubmits

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

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

package

jelix

see \jForms

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$param

array

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

Response

string

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

« More »

jtpl_block_html_ifctrl

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

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

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

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

Response

string

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

« More »

jtpl_block_html_ifctrl_value

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

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

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

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

Response

string

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

« More »

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.

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

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

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

Response

string

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

« More »

jtpl_block_html_swfjs

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

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

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$begin

boolean

true if it is the begin of block, else false

$params

array

parameters for the url

Response

string

PHP generated code

« More »

jtpl_cfunction_common_fetchtpl

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

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) }
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$param

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.

Response

string

the php code corresponding to the function content

« More »

jtpl_cfunction_common_fetchzone

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

 {fetchzone 'myVar', 'myModule~myzone', array('foo'=>'bar)}
{if $myVar !== ''}
{$myVar}
{/if}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$params

Response

string

the php code corresponding to the function content

« More »

jtpl_cfunction_common_zone

cfunction plugin : include the content of a zone.

 {zone 'myModule~myzone'}
{zone 'myModule~myzone',array('foo'=>'bar)}
package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$params

Response

string

the php code corresponding to the function content

« More »

jtpl_cfunction_html_formfull

Display a full form without the use of other plugins.

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"

package

jelix

Arguments

$compiler

\jTplCompiler

the template compiler

$params

Response

string

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

« More »

jtpl_cfunction_html_swfbiscuit

swfbiscuit plugin : Adds html code to display a swf.

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

Render :

<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,29,0" width="150" height="90">

<param name="quality" value="hight" />
<param name="wmode" value="transparent" />
<embed src="/data/fichiers/promobidon.swf?longeur=150"
       quality="high" wmode="transparent" pluginspage="http://www.macromedia.com/go/getflashplayer"
       type="application/x-shockwave-flash" width="150" height="90"/>

$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

package

jelix

Arguments

$tpl

\jTpl

template engine

$params

array

parameters for the url

Response

string

PHP generated code

« More »

jtpl_function_common_dumptolog

Dump a value into log files.

package

jelix

Arguments

$tpl

\jTpl

$value

mixed

« More »

jtpl_function_common_tolog

Dump a value into log files.

package

jelix

Arguments

$tpl

\jTpl

$message

mixed

« More »

jtpl_function_html_breadcrumb

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$nb

array

the number of items displayed by the plugin

$separator

string

Symbol separating items

« More »

jtpl_function_html_ctrl_control

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

package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

template engine

$ctrlname

string

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

$attributes

array

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

« More »

jtpl_function_html_ctrl_label

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

package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

template engine

$ctrlname

string

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

$format

string

« More »

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.

package

jelix

Throws
\jException

Arguments

$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

« More »

jtpl_function_html_ctrl_value

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

package

jelix

Throws
\jException

Arguments

$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

« More »

jtpl_function_html_formdatafull

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$form

\jFormsBase

the form to display

$builder

string

the builder type to use

$options

array

options for the builder

« More »

jtpl_function_html_formreset

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

package

jelix

Arguments

$tpl

\jTpl

template engine

« More »

jtpl_function_html_formsubmit

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

package

jelix

Throws
\jException

Arguments

$tpl

\jTpl

template engine

$ctrlname

string

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

$attributes

array

attributes for the generated html element

« More »

jtpl_function_html_formurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

« More »

jtpl_function_html_formurlparam

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

« More »

jtpl_function_html_hook

hook plugin.

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$event

string

the event name to call

$params

array

parameters to give to the listener

« More »

jtpl_function_html_image

image plugin : write the url corresponding to the image.

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$src

string

the url of image relative to the www path

$params

array

parameters for the transformation and img element

« More »

jtpl_function_html_jfullurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$domain

string

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

$escape

boolean

if true, then escape the string for html

« More »

jtpl_function_html_jlocale

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$locale

string

the locale key

« More »

jtpl_function_html_jmessage

function plugin : Display messages from jMessage.

package

jelix

Arguments

$tpl

$type

« More »

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.

package

jelix

Arguments

$tpl

\jTpl

template engine

$ressourceType

string

the name of the ressource type

« More »

jtpl_function_html_jurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$escape

boolean

if true, then escape the string for html

« More »

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.

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

static parameters for the url

$placeholders

array

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

« More »

jtpl_function_html_resurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$module

string

the module name

$file

array

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

$intheme

$escape

boolean

if true, then escape the string for html

« More »

jtpl_function_html_urljsstring

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$jsparams

« More »

jtpl_function_ltx2pdf_jlocale

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$locale

string

the locale key

« More »

jtpl_function_ltx2pdf_jurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

« More »

jtpl_function_text_formdatafull

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$form

\jFormsBase

the form to display

« More »

jtpl_function_text_jfullurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$domain

string

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

« More »

jtpl_function_text_jlocale

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$locale

string

the locale key

« More »

jtpl_function_text_jurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

« More »

jtpl_function_xml_jfullurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$domain

string

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

$escape

boolean

if true, then escape the string for html

« More »

jtpl_function_xml_jlocale

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

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$locale

string

the locale key

« More »

jtpl_function_xml_jurl

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

package

jelix

Arguments

$tpl

\jTpl

template engine

$selector

string

selector action

$params

array

parameters for the url

$escape

boolean

if true, then escape the string for xml

« More »

jtpl_meta_html_html

meta plugin : modify an html response object.

package

jelix

see \jResponseHtml
params

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

Arguments

$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

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

$params

« More »

jtpl_meta_html_htmlmodule

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

package

jelix

see \jResponseHtml
params

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

Arguments

$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

« More »

jtpl_meta_xml_xml

meta plugin : modify an xml response object.

package

jelix

see \jResponseXml

Arguments

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

« More »

jtpl_modifier_common_datetime

modifier plugin : change the format of a date.

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

package

jelix

see \jDateTime

Arguments

$date

string

the date

$format_out

string

the format identifier of the output date

$format_in

string

the format identifier of the given date

Response

string

the converted date

« More »

jtpl_modifier_common_jdatetime

modifier plugin : change the format of a date.

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

package

jelix

see \jDateTime
Throws
\jException

Arguments

$date

string

the date

$format_in

string

the format identifier of the given date

$format_out

string

the format identifier of the output date

Response

string

the converted date

« More »

jtpl_modifier_html_vardump

Dump any value.

package

jelix

Arguments

$value

Response

string

« More »

jtpl_modifier_html_vardump

Dump any value.

package

jelix

Arguments

$value

Response

string

« More »

sha1WithSalt

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

package

jelix

deprecated

Arguments

$salt

mixed

$password

mixed

« More »

Constants

JELIX_VERSION

Version number of Jelix.

« More »

JELIX_NAMESPACE_BASE

« More »

JELIX_LIB_PATH

« More »

JELIX_LIB_CORE_PATH

« More »

JELIX_LIB_UTILS_PATH

« More »

LIB_PATH

« More »

BYTECODE_CACHE_EXISTS

« More »

Classes, interfaces and traits

jInstallerReporterTrait

« More »

jAcl2AuthAdapterInterface

Interface for authentication adapters for jAcl2.

« More »

jIAcl2Driver

interface for jAcl2 drivers.

« More »

jIAcl2Driver2

interface for jAcl2 drivers.

« More »

jIAuthDriver

interface for auth drivers.

« More »

jIAuthDriver2

interface for auth drivers.

« More »

jIAuthDriverClass

interface for classes used with the jAuthDriverClass.

« More »

jICacheDriver

Interface for cache drivers.

« More »

jICoordPlugin

interface that should implement all coordinator plugins.

« More »

jIDebugbarPlugin

interface for plugins for the debugbar.

« More »

jIFilteredDatatype

interface for datatypes which can filter value.

« More »

jIFormsDatasource

Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.

..

« More »

jIFormsDatasource2

Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.

..

« More »

jIFormsDynamicDatasource

Interface for objects which provides a source of data to fill some controls in a form, like menulist, listbox etc.

..

« More »

jIHTMLResponsePlugin

interface for plugins for jResponseBasicHtml or jResponseHtml, which allows to make changes in the response at several step.

« More »

jIInstallerComponent

« More »

jIInstallReporter

interface for classes used as reporter for installation or check etc.

.. This classes are responsible to show informations to the user.

« More »

jIKVPersistent

interface for KV driver which store values in a persistent manner (in a file.

..).

« More »

jIKVSet

« More »

jIKVttl

interface for KV driver which support 'time to live' on values useful to use the driver as a cache storage.

« More »

jILogger

interface for loggers.

« More »

jILogMessage

interface for log message. A component which want to log a message can use an object implementing this interface.

Classes that implements it are responsible to format the message. Formatting a message depends on its type.

« More »

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.

« More »

jIRestController

interface for controllers used for RESTFull request/response.

« More »

jISelector

interface of selector classes.

« More »

jISimpleCompiler

interface for compiler which needs only one source file.

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.

« More »

jIUrlSignificantHandler

« More »

AuthCoordPlugin

« More »

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.

See jAutocomplete jqueryui plugin, which is base on the autocomplete plugin.

If the select box may contain hundred values, prefer to use the autocompleteajax_html widget.

The widget accepts a specific attribute, 'attr-autocomplete', an array which should contains at least an item 'source' indicating the url of the search engine. The array may contains other attributes for the input element used to type the search term (class, style..).

example of use:

In the form file:

    <menulist ref="mylist"> <label>test</label>
    <datasource dao="mymodule~mydao"/>
    </menulist>

In a template:

{form $form, $submitAction, $submitParam, 'html', array('plugins'=>array(
     'mylist'=>'autocomplete_html'))}

{formcontrols}
   ... {ifctrl 'mylist'}{ctrl_control '', array(
         'attr-autocomplete'=>array('style'=>'width:40em;')}
       {else}{ctrl_control}{/ifctrl}
{/formcontrols}
« More »

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.

You should use a menulist control, and a datasource, inheriting from jFormsDaoDatasource or jFormsDynamicDatasource, and having a getData() method returning an empty list.

The widget accepts a specific attribute, 'attr-autocomplete', an array which should contains at least an item 'source' indicating the url of the search engine. The array may contains other attributes for the input element used to type the search term (class, style..).

example of use:

In the form file:

    <menulist ref="mylist"> <label>test</label>
    <datasource class="mymodule~mydatasource"/>
    </menulist>

The datasource:

class mydatasource extends jFormsDaoDatasource {
   function __construct($formId) {
      parent::__construct ("mymodule~myDao" , "findAll" , "label", 'id');
   }
   public function getData($form) { return array(); }
 }

In a template:

{form $form, $submitAction, $submitParam, 'html', array('plugins'=>array(
     'mylist'=>'autocompleteajax_html'))}

{formcontrols}
   ... {ifctrl 'mylist'}{ctrl_control '', array(
         'attr-autocomplete'=>array('style'=>'width:40em;',
             'source'=>$searchUrl))}
       {else}{ctrl_control}{/ifctrl}
{/formcontrols}
« More »

AutoLocaleCoordPlugin

plugin for language auto detection.

« More »

button_htmlFormWidget

HTML form builder.

« More »

captcha_htmlFormWidget

HTML form builder.

« More »

check_installZone

a zone to display a default start page with results of the installation check.

A user zone should inherits from jZone. jZone provide a cache mecanism.

« More »

checkbox_htmlFormWidget

HTML form builder.

« More »

checkboxes_htmlFormWidget

HTML form builder.

« More »

checkZoneInstallReporter

an HTML reporter for jInstallChecker.

« More »

choice_htmlFormWidget

HTML form builder.

« More »

classAuthDriver

Driver for a class which implement an authentification.

« More »

color_htmlFormWidget

HTML form builder.

« More »

date_htmlFormWidget

HTML form builder.

« More »

datetime_htmlFormWidget

HTML form builder.

« More »

dbaKVDriver

« More »

dbAuthDriver

authentification driver for authentification information stored in a database.

« More »

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

« More »

dbKVDriver

Driver for jKVDB, that uses an SQL table to store key/value data.

« More »

debugbarConfigCompilerPlugin

« More »

debugbarHTMLResponsePlugin

plugin for jResponseHTML, it displays a debugbar.

« More »

debugbarItemInfo

information for a component a debug bar.

« More »

defaultlogDebugbarPlugin

plugin to show general message logs.

« More »

errorCtrl

class base for controllers.

A controller is used to implement one or many actions, one method for each action.

« More »

errorCtrl

class base for controllers.

A controller is used to implement one or many actions, one method for each action.

« More »

errorCtrl

class base for controllers.

A controller is used to implement one or many actions, one method for each action.

« More »

errorsDebugbarPlugin

native plugin for the debugbar, which displays list of errors, warnings.

..

« More »

file2KVDriver

« More »

fileServer

« More »

firebugLogger

« More »

ghostInstallReporter

a reporter which reports.

.. nothing.

« More »

group_htmlFormWidget

HTML form builder.

« More »

helpCtrl

a base class for controllers used in command line application.

A controller is used to implement one or many actions, one method for each action.

« More »

historyCoordPlugin

« More »

htmleditor_htmlFormWidget

HTML form builder.

« More »

htmlFormBuilder

HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)

« More »

htmlFormWidget

« More »

htmlJformsBuilder

HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)

« More »

htmllightJformsBuilder

HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)

« More »

imageupload_htmlFormWidget

HTML form builder.

For images upload, some attributes can be set to indicate the url of the image. The url can be forged from a selector or from a base URI. From a selector : action, parameters, and the parameter name that will contain the filename, should be given in attributes uriAction, uriActionParameters, uriActionFileParameter From a base URI : a baseURI attribute should be given, with the URL on which the filename will be append.

« More »

input_htmlFormWidget

HTML form builder.

« More »

jAcl2

Main class to query the acl system, and to know value of a right.

you should call this class (all method are static) when you want to know if the current user have a right

« More »

jAcl2Authentication

Makes the glue between jAcl2 and an authentication library.

« More »

jAcl2Db

Utility class for all classes used for the db driver of jAcl2.

« More »

jAcl2DbAdminCheckAuthorizations

Allow to verify admin rights when a change occurs in the authorizations.

« More »

jAcl2DbAdminUIException

« More »

jAcl2DbAdminUIManager

« More »

jacl2dbListener

base class for event listeners.

« More »

jAcl2DbManager

This class is used to manage rights. Works only with db driver of jAcl2.

« More »

jAcl2DbUserGroup

Use this class to register or unregister users in the acl system, and to manage user groups.

Works only with db driver of jAcl2.

« More »

jAcl2JAuthAdapter

Adapter to jAuth for jAcl2.

« More »

jAppInstance

« More »

jAppManager

utilities to manage a jelix application.

« More »

jAuth

This is the main class for authentification process.

« More »

jAuthDriverBase

base class for some jAuth drivers.

« More »

jAuthDummyUser

internal use.

this is only a data container. In fact, auth drivers can provide other object to embed user data.

« More »

jAuthUser

default object to represent a user.

this is only a data container. In fact, auth drivers can provide other object to embed user data.

« More »

jAuthUserLDAP

object which represent a user for LDAP driver.

this is only a data container. In fact, auth drivers can provide other object to embed user data.

« More »

jAutoloader

« More »

jBasicErrorHandler

Error handlers for the framework.

Replace the default PHP error handler.

« More »

jBinaryData

« More »

jBundle

a bundle contains all readed properties in a given language, and for all charsets.

« More »

jCache

Global caching data provided from whatever sources.

« More »

jClassBinding

Services binding for jelix.

« More »

jClasses

This object is responsible to include and instancy some classes stored in the classes directory of modules.

« More »

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.

..

« More »

jCmdlineCoordinator

The command line version of jCoordinator.

This allows us to handle exit code of commands properly

« More »

jCmdLineRequest

a request object for scripts used in a command line.

.).

« More »

jCmdUtils

utilities functions for command line.

« More »

jConfig

static class which loads the configuration.

« More »

jConfigAutoloader

« More »

jConfigCompiler

jConfigCompiler merge two ini file in a single array and store it in a temporary file This is a static class.

« More »

jController

class base for controllers.

A controller is used to implement one or many actions, one method for each action.

« More »

jControllerCmdLine

a base class for controllers used in command line application.

A controller is used to implement one or many actions, one method for each action.

« More »

jControllerDaoCrud

a base class for crud controllers.

A controller is used to implement one or many actions, one method for each action.

« More »

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

A controller is used to implement one or many actions, one method for each action.

« More »

jCoordinator

the main class of the jelix core.

this is the "chief orchestra" of the framework. Its goal is to load the configuration, to get the request parameters used to instancie the correspondant controllers and to run the right method.

« More »

jCoordinatorDebug

the main class of the jelix core.

this is the "chief orchestra" of the framework. Its goal is to load the configuration, to get the request parameters used to instancie the correspondant controllers and to run the right method.

« More »

jCssRequest

handle classical request but only to control and produce css content.

.).

« More »

jDao

Factory to create DAO objects.

« More »

jDaoCompiler

The compiler for the DAO xml files. it is used by jIncluder It produces some php classes.

« More »

jDaoCondition

content a sub group of conditions.

« More »

jDaoConditions

container for all criteria of a query.

« More »

jDaoDbMapper

It allows to create tables corresponding to a dao file.

« More »

jDaoFactoryBase

base class for all factory classes generated by the dao compiler.

« More »

jDaoGenerator

This is a generator which creates php class from dao xml file.

It is called by jDaoCompiler

« More »

jDaoMethod

containers for properties of dao method.

« More »

jDaoParser

extract data from a dao xml content.

« More »

jDaoProperty

Container for properties of a dao property.

« More »

jDaoRecordBase

Base class for all record classes generated by the dao compiler.

« More »

jDaoXmlException

Exception for Dao compiler.

It handles locale messages. Message property contains the locale key, and a new property contains the localized message.

« More »

jDatatype

« More »

jDatatypeBoolean

Datatype Booléen.

« More »

jDatatypeColor

Datatype Color.

« More »

jDatatypeDate

Datatype date.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeDateTime

Datatype datetime.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeDecimal

Datatype Decimal.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeEmail

Datatype mail.

« More »

jDatatypeHexadecimal

Datatype Hexa.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeHtml

Datatype HTML String.

Possible facets are: 'length','minLength','maxLength'

« More »

jDatatypeInteger

Datatype Integer.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeIPv4

Datatype ipv4.

« More »

jDatatypeIPv6

Datatype ipv6.

« More »

jDatatypeLocaleDate

Datatype localedate.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeLocaleDateTime

Datatype localedatetime.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeLocaleTime

Datatype localetime.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeLocaleTimeShort

Datatype localetime.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeString

Datatype String.

Possible facets are: 'length','minLength','maxLength', 'pattern'

« More »

jDatatypeTime

Datatype time.

Possible facets are: 'maxValue', 'minValue'

« More »

jDatatypeUrl

Datatype url.

Possible facets are: 'schemeRequired','hostRequired','pathRequired', 'queryRequired'. all are booleans.

« More »

jDateTime

Utility to manipulate dates and convert date format.

« More »

jDb

factory for database connector and other db utilities.

« More »

jDbColumn

« More »

jDbConnection

« More »

jDbConstraint

« More »

jDbFieldProperties

Description of a field of a table.

« More »

jDbIndex

Represents an index on some columns.

« More »

jDbMysqlTools

Provides utilities methods for a mysql database.

« More »

jDbOciTools

Provides utilities methods for a database.

« More »

jDbParameters

allow to normalize & analyse database parameters.

supported parameters in a profile:

  • driver: the jdb driver name, or "pdo" to use dbo ("pdo" value is deprecated, use usepdo instead)
  • database: the name of the database (for sqlite: path to the sqlite file)
  • host: the host of the database
  • port: the port of the database
  • user & password: credentials to connect to the database
  • force_encoding: force the encoding at the connection, using the default encoding of the application
  • dsn: dsn (pdo, odbc... optional)
  • usepdo: true if pdo should be used
  • pdodriver: name of the pdodriver to use. Guessed from dsn
  • pdoext: name of the pdo extension to use. Guessed from dsn
  • dbtype: type of the database (so it determines the SQL language)
  • phpext: name of the php extension to use
  • persistent: if true, the connection should be persistent
  • extensions: some informations about extensions to load (For sqlite for example. optional)
  • single_transaction: indicate to execute all queries into a single transaction (pgsql, optional)
  • busytimeout: timeout for the connection (sqlite, optional)
  • timeout: timeout for the connection (pgsql, optional)
  • search_path: schema for pgsql (optional)
  • table_prefix: prefix to add to database table. Used by jDao (optional)
« More »

jDbPDOConnection

A connection object based on PDO.

« More »

jDbPDOConnectionDebug

A connection object based on PDO, for debugging.

« More »

jDbPDOResultSet

a resultset based on PDOStatement for PHP >= 8.0

« More »

jDbPDOResultSet7

a resultset based on PDOStatement, for PHP < 8.0

« More »

jDbPgsqlTools

Provides utilities methods for a database.

« More »

jDbPrimaryKey

used to declare a primary key.

« More »

jdbProfilesCompiler

default plugin for jProfilesCompiler, and base plugin for other plugins.

« More »

jDbReference

used to declare a foreign key.

« More »

jDbResultSet

represent a statement result set or a prepared statement result set.

« More »

jDbSchema

« More »

jDbSqliteTools

tools to manage a sqlite database.

« More »

jDbSqlsrvTools

Provides utilities methods for a database.

« More »

jDbTable

« More »

jDbTools

Provides utilities methods for a database.

« More »

jDbUniqueKey

represents a unique key.

« More »

jDbUtils

« More »

jDbWidget

« More »

jDuration

Utility to manipulate durations between two instants.

« More »

jEvent

Class which represents an event in the event system.

« More »

jEventCompiler

« More »

jEventListener

base class for event listeners.

« More »

jException

Jelix Exception.

It handles locale messages. Message property contains the locale key, and a new property contains the localized message.

« More »

jExceptionForms

exception for jforms.

It handles locale messages. Message property contains the locale key, and a new property contains the localized message.

« More »

jExceptionSelector

Exception for selector errors.

It handles locale messages. Message property contains the locale key, and a new property contains the localized message.

« More »

jFile

A class helper to read or create files.

« More »

jFileLogger

logger storing message into a file.

« More »

jFilter

utility class to check values.

« More »

jForms

static class to manage and call a form.

A form is identified by a selector, and each instance of a form have a unique id (formId). This id can be the id of a record for example. If it is not given, the id is set to 0.

« More »

jFormsBase

base class of all form classes generated by the jform compiler.

« More »

jFormsBuilderBase

base class of all builder form classes generated by the jform compiler.

a builder form class is a class which help to generate a form for the output (html form for example)

« More »

jFormsBuilderHtml

HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)

« More »

jFormsCompiler

Generates form class from an xml file describing the form.

« More »

jFormsCompiler_jf_1_0

generates form class from an xml file describing the form.

« More »

jFormsCompiler_jf_1_1

generates form class from an xml file describing the form.

« More »

jFormsControl

base class for all jforms control.

« More »

jFormsControlButton

base class for all jforms control.

« More »

jFormsControlCaptcha

captcha control.

« More »

jFormsControlCheckbox

base class for all jforms control.

« More »

jFormsControlCheckboxes

Checkboxes control (contains several checkboxes).

« More »

jFormsControlChoice

choice control.

It has a list of choices, called choice items. Each item has a value and a list of child controls. The value of the choice control is the value of the selected item.

$this->container->privateData contain the list of items that are deactivated. A deactivated item is not displayed.

« More »

jFormsControlColor

base class for all jforms control.

« More »

jFormsControlDatasource

base class for controls which uses a datasource to fill their contents.

« More »

jFormsControlDate

base class for all jforms control.

« More »

jFormsControlDatetime

base class for all jforms control.

« More »

jFormsControlGroup

group control.

Contains a list of controls. If it has a checkbox, child controls can be disabled by the user. The "value" of the group is then the status of the checkbox "on" or "". if the group is in readonly mode or is deactivated, every children are readonly or deactivated

« More »

jFormsControlGroups

abstract classes for controls which contain other controls.

« More »

jFormsControlHidden

base class for all jforms control.

« More »

jFormsControlHtmlEditor

base class for all jforms control.

« More »

jFormsControlImageUpload

base class for all jforms control.

« More »

jFormsControlInput

base class for all jforms control.

« More »

jFormsControlListbox

listbox.

« More »

jFormsControlMenulist

menulist/combobox.

« More »

jFormsControlOutput

base class for all jforms control.

« More »

jFormsControlRadiobuttons

control which contains several radio buttons.

« More »

jFormsControlRepeat

abstract classes for controls which contain other controls.

« More »

jFormsControlReset

base class for all jforms control.

« More »

jFormsControlSecret

base class for all jforms control.

« More »

jFormsControlSecretConfirm

base class for all jforms control.

« More »

jFormsControlSubmit

base class for controls which uses a datasource to fill their contents.

« More »

jFormsControlSwitch

switch.

It has a list of choices, called choice items. Each item has a value and a list of child controls. The value of the choice control is the value of the selected item.

$this->container->privateData contain the list of items that are deactivated. A deactivated item is not displayed.

« More »

jFormsControlTextarea

base class for all jforms control.

« More »

jFormsControlTime

base class for all jforms control.

« More »

jFormsControlUpload

base class for all jforms control.

« More »

jFormsControlUpload2

base class for all jforms control.

« More »

jFormsControlWikiEditor

base class for all jforms control.

« More »

jformsCtrl

class base for controllers.

A controller is used to implement one or many actions, one method for each action.

« More »

jFormsDaoDatasource

A datasource which is based on a dao.

« More »

jFormsDataContainer

this object is a container for form data.

« More »

jFormsDynamicDatasource

Base class for a datasource which is based on a class and can be used for dynamic listboxes or menulists.

« More »

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.

jFormsSession instances can be stored temporarly in session, in order to have the opportunity, at the end of the request processing, so when the session is saved, to store automatically jForms containers data that have been readed, created or modified.

A profile for jCache, named 'jforms', may be declared in profiles.ini.php, so you can choose where jforms data are stored. A virtual profile is used if no one is defined, and use files for the cache.

« More »

jFormsStaticDatasource

A datasource which is based on static values.

« More »

jFramework

« More »

jHttp401UnauthorizedException

Jelix Exception to generate an HTTP 401 error.

Unauthorized. The user must be authenticated to access to the resource.

« More »

jHttp403ForbiddenException

Jelix Exception to generate an HTTP 403 error.

Forbidden. The user must have the right to access to the resource.

« More »

jHttp404NotFoundException

Jelix Exception to generate an HTTP 404 error.

Resource not found. There is nothing at the current url.

« More »

jHttpErrorException

Jelix Exception to generate an HTTP error.

« More »

jHttpResponseException

Jelix Exception to generate an HTTP error. Deprecated class.

« More »

jImageModifier

Utility class to manipulate image.

« More »

jIncluder

This object is responsible to load cache files.

Some jelix files needs to be compiled in PHP (templates, daos etc..) and their correspondant php content are stored in a cache file. jIncluder verify that cache file exists, and if not, it calls the correspondant compiler. Finally, it includes the cache.

« More »

jIniFile

utility class to read and write an ini file.

« More »

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.

« More »

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.

« More »

jInstallCheck

check an installation of a jelix application.

« More »

jInstaller

main class for the installation.

It loads all entry points configurations and all informations about activated modules. jInstaller then constructs a tree dependencies for these activated modules, and launch their installation and the installation of their dependencies. An installation can be an initial installation, or just an upgrade if the module is already installed.

« More »

jInstallerApplication

Application configuration reader and manager.

« More »

jInstallerEntryPoint

container for entry points properties.

Object for legacy installers

« More »

jInstallerException

Installer Exception.

It handles installer messages.

« More »

jInstallerMessageProvider

message provider for jInstallCheck and jInstaller.

« More »

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.

« More »

jJsonRpc

object which encode and decode a jsonrpc request and response.

« More »

jJsonRpcRequest

handle a JSON-rpc call. The response has to be a json rpc response.

.).

« More »

jKVDb

main class to access to key-value storage databases.

« More »

jKVDriver

« More »

jLocale

static class to get a localized string.

« More »

jLog

utility class to log some message into a file into yourapp/var/log.

« More »

jLogDumpMessage

class that handles a dump of a php value, for a logger.

« More »

jLogErrorMessage

this class is formatting an error message for a logger.

« More »

jLogMessage

class that handles a simple message for a logger.

« More »

jLogSoapMessage

class that handles a dump of a php value, for a logger.

« More »

jMailer

jMailer based on PHPMailer - PHP email transport class.

« More »

jMailLogger

logger sending message by email.

« More »

jMessage

Utility class to log some message in session in order to be displayed in a template.

« More »

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

« More »

jPref

« More »

jPrefItem

« More »

jPrefItemGroup

« More »

jPrefManager

« More »

jProfiles

class to read profiles from the profiles.ini.php.

« More »

jProfilesCompiler

read and consolidate data from a profile, and store results into a cache file.

« More »

jProfilesCompilerPlugin

default plugin for jProfilesCompiler, and base plugin for other plugins.

« More »

jRedis

extends the class Redis from the phpredis extension.

« More »

jRequest

base class for object which retrieve all parameters of an http request. The process depends on the type of request (ex: xmlrpc.

.).

« More »

jResponse

base class for response object A response object is responsible to generate a content in a specific format.

« More »

jResponseBasicHtml

Basic HTML response. the HTML content should be provided by a simple php file.

« More »

jResponseBinary

Response use to send a binary file to the browser.

« More »

jResponseCmdline

Command line response.

« More »

jResponseCss

Send CSS content.

« More »

jResponseHtml

HTML5 response.

« More »

jResponseHtml4

Response class for HTML 4 or XHTML 1.x.

« More »

jResponseHtmlError

HTML5 response to display HTTP errors.

« More »

jResponseHtmlFragment

Send Html part.

« More »

jResponseJson

Json response.

« More »

jResponseJsonRpc

Response for jsonrpc protocol.

« More »

jResponseRedirect

Response To redirect to an action.

« More »

jResponseRedirectUrl

Response To redirect to an URL.

« More »

jResponseText

plain Text response.

« More »

jResponseXml

XML response generator.

« More »

jResponseXmlRpc

xmlrpc response.

« More »

jResponseZip

generate a zip content and send it to the browser.

« More »

jSelectorAct

Generic Action selector.

main syntax: "module~action@requestType". module should be a valid module name or # (#=says to get the module of the current request). action should be an action name (controller:method or controller_method). all part are optional, but it should have one part at least.

« More »

jSelectorActFast

Special Action selector for jcoordinator Don't use it ! Only for internal purpose.

General syntax for them : "module~resource". Syntax of resource depend on the selector type. module is optional.

« More »

jSelectorAppCfg

Selector for files stored in the app/system directory.

« More »

jSelectorCfg

Selector for files stored in the var/config directory.

« More »

jSelectorClass

selector for business class.

business class is a class stored in classname.class.php file in the classes/ module directory or one of its subdirectory. syntax : "module~classname" or "module~classname.

« More »

jSelectorDao

Selector for dao file syntax : "module~daoName".

file : daos/daoName.dao.xml.

« More »

jSelectorDaoDb

see jISelector.iface.php for documentation about selectors.

file : daos/daoName.dao.xml.

« More »

jSelectorDaoRecord

Selector for dao file syntax : "module~daoRecordName".

file : daos/daoRecordName.daorecord.php.

« More »

jSelectorFactory

Create instance of selectors object.

« More »

jSelectorForm

Form selector.

syntax : "module~formName". file : forms/formName.form.xml .

« More »

jSelectorIface

selector for interface.

interface is stored in interfacename.iface.php file in the classes/ module directory or one of its subdirectory. syntax : "iface:module~ifacename" or "module~ifacename.

« More »

jSelectorLib

Selector for files stored in the lib directory.

« More »

jSelectorLoc

selector for localisation string.

localisation string are stored in file properties. syntax : "module~prefixFile.keyString". Corresponding file : locales/xx_XX/prefixFile.CCC.properties. xx_XX and CCC are lang and charset set in the configuration

« More »

jSelectorLog

Selector for files stored in the log directory.

« More »

jSelectorModule

base class for all selector concerning module files.

General syntax for them : "module~resource". Syntax of resource depend on the selector type. module is optional.

« More »

jSelectorSimpleFile

base class for simple file selector.

« More »

jSelectorTmp

Selector for files stored in the temp directory.

« More »

jSelectorTpl

Template selector.

syntax : "module~tplName". file : templates/tplName.tpl .

« More »

jSelectorVar

Selector for files stored in the var directory.

« More »

jSelectorZone

Zone selector.

syntax : "module~zoneName". file : zones/zoneName.zone.php .

« More »

jServer

Static class providing some utilities to retrieve informations about the server.

« More »

jSession

session management class of the jelix core.

« More »

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.

This class is just a simple wrapper around SMTP.

« More »

jSoapClient

provide a soap client where configuration information are stored in the profile file.

« More »

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.

« More »

jSQLLogMessage

class that handles a sql query for a logger.

« More »

jStderrLogger

logger sending message to stderr.

« More »

jStdoutLogger

logger sending message to stdout.

« More »

jSyslogLogger

logger storing message into syslog.

« More »

jTpl

template engine.

« More »

jTplCompiler

This is the compiler of templates: it converts a template into a php file.

« More »

jUrl

Object that contains url data, and which provides static method helpers.

« More »

jUrlAction

A container to store url data for an action.

« More »

jUrlBase

base class for jUrl and jUrlAction.

« More »

jXmlRpc

object to encode decode some XMl-RPC request and XMl-RPC response.

« More »

jXmlRpcRequest

handle XML-rpc call. The response has to be a xml-rpc response.

.).

« More »

jZipCreator

Class to create a zip file.

« More »

jZone

jZone is a representation of a zone in an response content, in a html page.

A user zone should inherits from jZone. jZone provide a cache mecanism.

« More »

ldapAuthDriver

LDAP authentification driver for authentification information stored in LDAP server.

« More »

legacysyslogLogger

logger storing message into syslog using old api.

« More »

listbox_htmlFormWidget

HTML form builder.

« More »

localesConfigCompilerPlugin

« More »

memcacheCacheDriver

cache driver for data stored in Memcached. Use the memcache extension of PHP.

This plugin should be used with version 3.0.1 or more of the memcache extension.

« More »

memcacheKVDriver

« More »

menulist_htmlFormWidget

HTML form builder.

« More »

mssqlDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler

« More »

mssqlDbConnection

« More »

mssqlDbResultSet

Layer encapsulation resultset mssql.

« More »

mssqlDbSchema

« More »

mssqlDbTable

« More »

mysqlDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler

« More »

mysqliDbConnection

« More »

mysqliDbResultSet

Object to fetch result, wrapping the underlaying result object of mysqli.

« More »

mysqliDbSchema

« More »

mysqliDbTable

« More »

nsautoloaderConfigCompilerPlugin

« More »

ociDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler

« More »

ociDbConnection

« More »

ociDbResultSet

represent a statement result set or a prepared statement result set.

« More »

ociDbSchema

« More »

ociDbTable

« More »

output_htmlFormWidget

HTML form builder.

« More »

pgsqlDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler

« More »

pgsqlDbConnection

« More »

pgsqlDbResultSet

represent a statement result set or a prepared statement result set.

« More »

pgsqlDbSchema

« More »

pgsqlDbTable

« More »

radiobuttons_htmlFormWidget

HTML form builder.

« More »

recaptcha_htmlFormWidget

jForms widget that shows reCaptcha.

in the configuration, sets:

[forms]
captcha.recaptcha.validator = \jelix\forms\Captcha\ReCaptchaValidator
captcha.recaptcha.widgettype = recaptcha

[recaptcha]
;see https://developers.google.com/recaptcha/docs/display to know the meaning
; of these configuration parameters.
theme=..
type=..
size=..
tabindex=..

in the localconfig.ini.php, set the site key and the secret (see your google recpatcha account to retrieve them)

[recaptcha]
sitekey= your recaptcha key
secret= your secret value

then indicate to use recaptcha, in the element or in the configuration

<captcha validator="recaptcha"/>
[forms]
captcha=recpatcha
« More »

redis_extCacheDriver

« More »

redis_extKVDriver

« More »

reset_htmlFormWidget

HTML form builder.

« More »

responsesConfigCompilerPlugin

« More »

secret_htmlFormWidget

HTML form builder.

« More »

secretconfirm_htmlFormWidget

HTML form builder.

« More »

sessionConfigCompilerPlugin

« More »

sessiondataDebugbarPlugin

plugin to show content of a session.

« More »

SoapClientDebug

« More »

soapfileLogger

logger storing soap message into several xml files.

« More »

soaplogDebugbarPlugin

plugin to show soap message.

« More »

sqlite3DbConnection

« More »

sqlite3DbResultSet

Couche d'encapsulation des resultset sqlite.

« More »

sqlite3DbSchema

« More »

sqlite3DbTable

« More »

sqliteDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler

« More »

sqllogDebugbarPlugin

plugin to show all sql queries into the debug bar.

« More »

sqlsrvDaoBuilder

driver for jDaoCompiler.

It is called by jDaoCompiler

« More »

sqlsrvDbConnection

« More »

sqlsrvDbResultSet

Layer encapsulation resultset mssql.

« More »

sqlsrvDbSchema

« More »

sqlsrvDbTable

« More »

submit_htmlFormWidget

HTML form builder.

« More »

textarea_htmlFormWidget

HTML form builder.

« More »

textInstallReporter

reporter echoing simply the messages.

« More »

time_htmlFormWidget

HTML form builder.

« More »

traceexecCoordPlugin

« More »

upload2_htmlFormWidget

Widget to display the selection of a file to upload.

For images upload, some attributes can be set to indicate the url of the image. The url can be forged from a selector or from a base URI. From a selector : action, parameters, and the parameter name that will contain the filename, should be given in attributes uriAction, uriActionParameters, uriActionFileParameter From a base URI : a baseURI attribute should be given, with the URL on which the filename will be append.

« More »

upload_htmlFormWidget

HTML form builder.

« More »

webassetsConfigCompilerPlugin

« More »

wikieditor_htmlFormWidget

HTML form builder.

« More »

wwwCtrl

class base for controllers.

A controller is used to implement one or many actions, one method for each action.

« More »

Classes, interfaces and traits

Configurator

main class to configure modules.

It loads all entry points configurations and all informations about activated modules. Configurator then constructs a tree dependencies for these activated modules, and launch configuration of given module

« More »

EntryPoint

container for entry points properties, for installers.

« More »

EntryPointConfigurator

entry points properties for configurators.

« More »

EntryPointPreConfigurator

entry points properties for configurators.

« More »

Exception

Installer Exception.

It handles installer messages.

« More »

GlobalSetup

« More »

Installer

main class for the installation.

It loads all entry points configurations and all informations about activated modules. jInstaller then constructs a tree dependencies for these activated modules, and launch their installation and the installation of their dependencies. An installation can be an initial installation, or just an upgrade if the module is already installed.

« More »

Migration

do changes in the application before the installation of modules can be done.

It is used for directory changes etc.

« More »

ModuleInstallerLauncher

Manage status of a module and its installer/updaters.

« More »

ModuleStatus

container for module properties, according to a specific entry point configuration.

It represents the state of the module, as known by the application: installation status, the module version known during the last installer launch etc.

« More »

Classes, interfaces and traits

InstallConfigTrait

Trait for installer/configurator classes.

« More »

ConfiguratorInterface

Interface for classes which configure a module.

« More »

InstallerInterface

interface of classes which install a module.

« More »

UninstallerInterface

interface for classes that uninstall a module.

« More »

Configurator

Base class for classes which configure a module.

« More »

Installer

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.

« More »

InstallerAbstract

Base class for installers and uninstallers.

« More »

InteractiveConfigurator

« More »

Uninstaller

A class that does processing to uninstall a module from an instance of the application. A module should have a class that inherits from it in order to remove things from the application.

« More »

Classes, interfaces and traits

DbProfileHelpersTrait

Trait for installer/configurator classes.

« More »

FileHelpersTrait

Trait for installer/configurator classes.

For methods having a target path as parameter, the path may content these Jelix shortcuts parts: 'www:', 'config:', 'var:', 'temp:', 'log:'.

« More »

ConfigurationHelpers

« More »

DatabaseHelpers

Trait for installer/configurator classes.

« More »

InstallHelpers

« More »

LocalConfigurationHelpers

« More »

PreConfigurationHelpers

« More »

PreInstallHelpers

« More »

Classes, interfaces and traits

ReporterTrait

« More »

ReporterInterface

interface for classes used as reporter for installation or check etc.

.. This classes are responsible to show informations to the user.

« More »

Console

simple text reporter.

« More »

Html

an HTML reporter.

« More »

HtmlBuffer

an HTML reporter storing generated content into a string.

« More »

NoOutput

a reporter which reports.

.. nothing.

« More »

SimpleConsole

simple text reporter.

« More »

Classes, interfaces and traits

Jelix17

« More »

UrlEngineUpgrader

« More »

WebAssetsUpgrader

« More »

Classes, interfaces and traits

Checker

check an installation of a jelix application.

« More »

CheckerBase

base class for a jelix installation checker.

« More »

CheckerPage

show a page with results of jelix environment checking.

« More »

Messages

Allow to access to some localized messages.

« More »

Classes, interfaces and traits

AppInfos

« More »

Author

« More »

EntryPoint

« More »

FrameworkInfos

« More »

InfosAbstract

« More »

ModuleInfos

Informations about the module, retrieved from its module.xml file.

« More »

ModuleXmlParser

Class to parse the module.xml file of a module.

« More »

ModuleXmlWriter

« More »

ProjectXmlParser

Class to parse the project.xml file of an application.

« More »

ProjectXmlWriter

« More »

XmlParserAbstract

« More »

XmlWriterAbstract

« More »

Classes, interfaces and traits

Configure

Launch commands from modules.

« More »

ConfigureCommand

Command for a user to configure an application before installing it.

« More »

InputHelpers

« More »

Installer

Launch commands from modules.

« More »

InstallerCommand

« More »

ModuleCommandAbstract

« More »

ModulesCommands

Launch commands from modules.

« More »

SingleCommandApplication

« More »

Utils

« More »

Classes, interfaces and traits

CustomUrlHandlerInterface

interface for custom url handler.

« More »

MapParserException

« More »

MapperConfig

« More »

SelectorUrlHandler

a specific selector for user url handler.

business class is a class stored in classname.class.php file in the classes/ module directory or one of its subdirectory. syntax : "module~classname" or "module~classname.

« More »

SelectorUrlXmlMap

a specific selector for the xml files which contains the configuration of the UrlMapper.

« More »

UrlActionMapper

an url engine to parse,analyse and create significant url it needs an urls.xml file in the app/system directory (see documentation).

« More »

UrlMapData

Contain informations of an url, readed from the map file.

« More »

XmlEntryPoint

« More »

XmlMapModifier

allow to modify the urls.xml file.

« More »

XmlMapParser

Compiler for the url engine. It can parse urls.xml files.

« More »

XmlRedefinedMapModifier

allow to modify the urls.xml file.

« More »

Classes, interfaces and traits

ClearTemp

« More »

CloseApp

« More »

FilesRights

« More »

MailerTest

controller to test email configuration.

« More »

OpenApp

« More »

RedisCacheDeletionWorker

« More »

RedisKvdbDeletionWorker

« More »

Classes, interfaces and traits

Exception

« More »

ItemException

« More »

Resolver

« More »

Classes, interfaces and traits

WebAssetsCompiler

« More »

WebAssetsSelection

« More »

Functions

is_resource

Check if the given value is a resource or not.

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

package

jelix

Arguments

$value

mixed

Response

boolean

« More »

Classes, interfaces and traits

ParentWidgetInterface

Interface for widgets that can have children widget: main builder, choice etc.

« More »

WidgetInterface

Interface for HTML widgets plugins.

« More »

RootWidget

« More »

WidgetBase

« More »

Classes, interfaces and traits

CaptchaValidatorInterface

Interface for validators for the captcha widget.

« More »

ReCaptchaValidator

« More »

SimpleCaptchaValidator

« More »

Classes, interfaces and traits

BuilderBase

base class of all builder form classes generated by the jform compiler.

a builder form class is a class which help to generate a form for the output (html form for example)

« More »

HtmlBuilder

Main HTML form builder.

a builder form class is a class which help to generate a form for the output (html form for example)

« More »

Classes, interfaces and traits

ConfigCompilerPluginInterface

interface for plugins of jConfigCompiler.

« More »