Joomla CMS
3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
|
autoloader
An autoloader for FOF-powered components. It allows the autoloading of various classes related to the operation of a component, from Controllers and Models to Helpers and Fields. If a class doesn't exist, it will be created on the fly.
autoloader
autoloader
The main class autoloader for FOF itself
autoloader
config
Configuration parser for the dispatcher-specific settings
config
The Interface of an FOFConfigDomain class. The methods are used to parse and provision sensible information to consumers. FOFConfigProvider acts as an adapter to the FOFConfigDomain classes.
Configuration parser for the tables-specific settings
Configuration parser for the view-specific settings
Reads and parses the fof.xml file in the back-end of a FOF-powered component, provisioning the data to the rest of the FOF framework
controller
FrameworkOnFramework controller class. FOF is based on the thin controller paradigm, where the controller is mainly used to set up the model state and spawn the view.
database
This file is adapted from the Joomla! Platform. It is used to iterate a database cursor returning FOFTable objects instead of plain stdClass objects
database
This file is adapted from the Joomla! Platform. It is used to iterate a database cursor returning FOFTable objects instead of plain stdClass objects
dispatcher
FrameworkOnFramework dispatcher class
FrameworkOnFramework is a set of classes which extend Joomla! 1.5 and later's MVC framework with features making maintaining complex software much easier, without tedious repetitive copying of the same code over and over again.
dispatcher
utils
encrypt
A simple implementation of AES-128, AES-192 and AES-256 encryption using the high performance mcrypt library.
encrypt
utils
This class provides an RFC6238-compliant Time-based One Time Passwords, compatible with Google Authenticator (with PassCodeLength = 6 and TimePeriod = 30).
form form
Form Field class for FOF Joomla! access levels
form
Form Field class for FOF Supports a generic list of options.
form
Form Field class for the FOF framework Supports a button input.
Form Field class for FOF Joomla! cache handlers
Form Field class for the FOF framework Supports a calendar / date field.
Form Field class for the FOF framework Supports a captcha field.
Form Field class for the FOF framework A single checkbox
Form Field class for FOF Supports a list of checkbox.
Form Field class for FOF Components installed on the site
Form Field class for the FOF framework An editarea field for content creation and formatted HTML display
Form Field class for the FOF framework Supports a one line text field.
Form Field class for the FOF framework A hidden field
Form Field class for the FOF framework Media selection field. This is an alias of the "media" field type.
Form Field class for the FOF framework Media selection field.
Form Field class for FOF Available site languages
Form Field class for FOF Generic list from a model's results
Form Field class for FOF Renders the row ordering interface checkbox in browse views
Form Field class for FOF Plugins installed on the site
Form Field class for FOF Radio selection list
Form Field class for FOF Relation list
Form Field class for FOF Joomla! ACL Rules
Form Field class for FOF Renders the checkbox in browse views which allows you to select rows
Form Field class for FOF Joomla! session handlers
Form Field class for the FOF framework Spacer used between form elements
Form Field class for FOF Radio selection listGeneric list from an SQL statement
Form Field class for FOF Tag Fields
Form Field class for the FOF framework Supports a URL text field.
Form Field class for the FOF framework Supports a text area
Form Field class for the FOF framework Supports a title field with an optional slug display below it.
Form Field class for the FOF framework A user selection box / display field
Form Field class for FOF Joomla! user groups
Generic interface that a FOF form field class must implement
FOFForm is an extension to JForm which support not only edit views but also browse (record list) and read (single record display) views based on XML forms.
Access level field header
Generic field header, without any filters
Generic field header, with text input (search) filter
Generic field header, with drop down filters
Generic field header, with drop down filters based on a SQL query
Generic filter, text box entry with calendar button
Generic filter, text box entry with optional buttons
Generic filter, drop-down based on fixed options
Generic filter, drop-down based on SQL query
Language field header
Ordering field header
Field header for Published (enabled) columns
Row selection checkbox
An interface for FOFFormHeader fields, used to define the filters and the elements of the header row in repeatable (browse) views
FOFForm's helper class. Provides a storage for filesystem's paths where FOFForm's entities reside and methods for creating those entities. Also stores objects with entities' prototypes for further reusing.
hal
Implementation of the Hypertext Application Language document in PHP. It can be used to provide hypermedia in a web service context.
Implementation of the Hypertext Application Language link in PHP.
Implementation of the Hypertext Application Language links in PHP. This is actually a collection of links.
Interface for HAL document renderers
Implements the HAL over JSON renderer
include
Initializes FOF
inflector
The FOFInflector is an adaptation of the Akelos PHP Inflector which is a PHP port from a Ruby on Rails project. FOFInflector to pluralize and singularize English nouns.
input
FrameworkOnFramework input handling class. Extends upon the JInput class.
platformFilesystem
platform
Part of the FOF Platform Abstraction Layer.
This implements the platform class for Joomla! 2.5 or later
layout
Base class for rendering a display layout loaded from from a layout file
This class searches for Joomla! version override Layouts. For example, if you have run this under Joomla! 3.0 and you try to load mylayout.default it will automatically search for the layout files default.j30.php, default.j3.php and default.php, in this order.
layout
Helper to render a FOFLayout object, storing a base path
less
This class is taken verbatim from:
lessphp v0.3.9 http://leafo.net/lessphp
LESS css compiler, adapted from http://lesscss.org
Copyright 2012, Leaf Corcoran leafo Licensed under MIT or GPLv3, see LICENSE t@gm ail.c om
less
This class is taken verbatim from:
lessphp v0.3.9 http://leafo.net/lessphp
LESS css compiler, adapted from http://lesscss.org
Copyright 2012, Leaf Corcoran leafo Licensed under MIT or GPLv3, see LICENSE t@gm ail.c om
This class is taken near verbatim (changes marked with FOF comment markers) from:
lessphp v0.3.9 http://leafo.net/lessphp
LESS css compiler, adapted from http://lesscss.org
Copyright 2012, Leaf Corcoran leafo Licensed under MIT or GPLv3, see LICENSE t@gm ail.c om
THIS IS THIRD PARTY CODE. Code comments are mostly useless placeholders to stop phpcs from complaining...
model
FrameworkOnFramework model behavior class to filter front-end access to items based on the viewing access levels.
model
FrameworkOnFramework model behavior class
FrameworkOnFramework model behavior class to filter front-end access to items that are enabled.
FrameworkOnFramework model behavior class to filter front-end access to items based on the language.
FrameworkOnFramework model behavior class to filter front-end access to items created by the currently logged in user only.
FrameworkOnFramework model behavior class. It defines the events which are called by a Model.
FrameworkOnFramework model behavior dispatcher class
FrameworkOnFramework Model class. The Model is the workhorse. It performs all of the business logic based on its state and then returns the raw (processed) data to the caller, or modifies its own state. It's important to note that the model doesn't get data directly from the request (this is the Controller's business) and that it doesn't output anything (that the View's business).
platform
Part of the FOF Platform Abstraction Layer. It implements everything that depends on the platform FOF is running under, e.g. the Joomla! CMS front-end, the Joomla! CMS back-end, a CLI Joomla! Platform app, a bespoke Joomla! Platform / Framework web application and so on.
This is the abstract class implementing some basic housekeeping functionality and provides the static interface to get the appropriate Platform object for use in the rest of the framework.
query
FrameworkOnFramework query base class; for compatibility purposes
render
Abstract view renderer class. The renderer is what turns XML view templates into actual HTML code, renders the submenu links and potentially wraps the HTML output in a div with a component-specific ID.
render
Default Joomla! 1.5, 1.7, 2.5 view renderer class
Joomla! 3 view renderer class
Akeeba Strapper view renderer class.
Helper class with utilitarian functions concerning strings
table
FrameworkOnFramework table behavior class for assets
table
FrameworkOnFramework table behavior class for content History
FrameworkOnFramework table behavior class for tags
FrameworkOnFramework table behavior class. It defines the events which are called by a Table.
FrameworkOnFramework table behavior dispatcher class
Normally this shouldn't be required. Some PHP versions, however, seem to require this. Why? No idea whatsoever. If I remove it, FOF crashes on some hosts. Same PHP version on another host and no problem occurs. Any takers? FrameworkOnFramework Table class. The Table is one part controller, one part model and one part data adapter. It's supposed to handle operations for single records.
template
A utility class to load view templates, media files and modules.
toolbar
The Toolbar class renders the back-end component title area and the back- and front-end toolbars.
view
FrameworkOnFramework CSV View class. Automatically renders the data in CSV format.
view
FrameworkOnFramework Form class. It preferably renders an XML view template instead of a traditional PHP-based view template.
FrameworkOnFramework HTML output class. Together with PHP-based view templates it will render your data into an HTML representation.
FrameworkOnFramework JSON View class. Renders the data as a JSON object or array. It can optionally output HAL links as well.
FrameworkOnFramework raw output class. It works like an HTML view, but the output is bare HTML.
FrameworkOnFramework View class. The View is the MVC component which gets the raw data from a Model and renders it in a way that makes sense. The usual rendering is HTML, but you can also output JSON, CSV, XML, or even media (images, videos, ...) and documents (Word, PDF, Excel...).