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 »

InstallConfigTrait

Trait for installer/configurator classes.

« More »

ReporterTrait

« More »

ConfiguratorInterface

Interface for classes which configure a module.

« More »

CustomUrlHandlerInterface

interface for custom url handler.

« More »

InstallerInterface

interface of classes which install a module.

« More »

ReporterInterface

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

.. This classes are responsible to show informations to the user.
« More »

UninstallerInterface

interface for classes that uninstall a module.

« More »

AppInfos

« More »

Author

« 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 »

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 »

ClearTemp

« More »

CloseApp

« More »

ConfigurationHelpers

« More »

Configurator

Base class for classes which configure a module.

« More »

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 »

DatabaseHelpers

Trait for installer/configurator classes.

« More »

EntryPoint

« 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

« More »

Exception

Installer Exception.

It handles installer messages.
« More »

FilesRights

« More »

FrameworkInfos

« More »

GlobalSetup

« More »

Html

an HTML reporter.

« More »

HtmlBuffer

an HTML reporter storing generated content into a string.

« More »

InfosAbstract

« More »

InputHelpers

« 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 »

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 »

InstallerAbstract

Base class for installers and uninstallers.

« More »

InstallHelpers

« More »

InteractiveConfigurator

« More »

ItemException

« More »

jAcl2DbAdminUIManager

« More »

jAcl2DbManager

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

« More »

jAppInstance

« More »

jFramework

« More »

jPref

« More »

jPrefItem

« More »

jPrefItemGroup

« More »

jPrefManager

« 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 »

LocalConfigurationHelpers

« More »

MapParserException

« More »

MapperConfig

« More »

Messages

Allow to access to some localized messages.

« More »

Migration

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

It is used for directory changes etc.
« More »

ModuleCommandAbstract

« More »

ModuleInfos

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

« 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 »

ModuleXmlParser

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

« More »

ModuleXmlWriter

« More »

NoOutput

a reporter which reports.

.. nothing.
« More »

OpenApp

« More »

PreConfigurationHelpers

« More »

PreInstallHelpers

« More »

ProjectXmlParser

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

« More »

ProjectXmlWriter

« More »

RedisCacheDeletionWorker

« More »

RedisKvdbDeletionWorker

« More »

Resolver

« 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 »

SimpleConsole

simple text reporter.

« More »

SingleCommandApplication

« More »

time_htmlFormWidget

HTML form builder.

« 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 »

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 »

UrlEngineUpgrader

« More »

UrlMapData

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

« More »

Utils

« 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 »

XmlParserAbstract

« More »

XmlRedefinedMapModifier

allow to modify the urls.xml file.

« More »

XmlWriterAbstract

« More »