Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de l'espace de nommage FrameworkOnFramework

Description détaillée

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

Depuis
2.1

The main class autoloader for FOF itself

autoloader

Depuis
2.1

config

Configuration parser for the dispatcher-specific settings

Depuis
2.1

The Interface of an FOFConfigDomain class. The methods are used to parse and privision sensible information to consumers. FOFConfigProvider acts as an adapter to the FOFConfigDomain classes.

Depuis
2.1

Configuration parser for the tables-specific settings

Depuis
2.1

Configuration parser for the view-specific settings

Depuis
2.1

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

Depuis
2.1

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.

Depuis
1.0

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.

Depuis
1.0

utils

encrypt

A simple implementation of AES-128, AES-192 and AES-256 encryption using the high performance mcrypt library.

Depuis
1.0

FOFEncryptBase32

Depuis
1.0

This class provides an RFC6238-compliant Time-based One Time Passwords, compatible with Google Authenticator (with PassCodeLength = 6 and TimePeriod = 30).

Depuis
1.0

form form

Form Field class for FOF Joomla! access levels

Depuis
2.0

form

Form Field class for FOF Supports a generic list of options.

Depuis
2.0

Form Field class for the FOF framework Supports a button input.

Depuis
2.0

Form Field class for FOF Joomla! cache handlers

Depuis
2.0

Form Field class for the FOF framework Supports a calendar / date field.

Depuis
2.0

Form Field class for the FOF framework Supports a captcha field.

Depuis
2.0

Form Field class for the FOF framework A single checkbox

Depuis
2.0

Form Field class for FOF Supports a list of checkbox.

Depuis
2.0

Form Field class for FOF Components installed on the site

Depuis
2.1

Form Field class for the FOF framework An editarea field for content creation and formatted HTML display

Depuis
2.0

Form Field class for the FOF framework Supports a one line text field.

Depuis
2.0

Form Field class for the FOF framework A hidden field

Depuis
2.0

Form Field class for the FOF framework Media selection field. This is an alias of the "media" field type.

Depuis
2.0

Form Field class for the FOF framework Media selection field.

Depuis
2.0

Form Field class for FOF Available site languages

Depuis
2.0

Form Field class for FOF Generic list from a model's results

Depuis
2.0

Form Field class for FOF Renders the row ordering interface checkbox in browse views

Depuis
2.0

Form Field class for FOF Plugins installed on the site

Depuis
2.0

Form Field class for FOF Radio selection list

Depuis
2.0

Form Field class for FOF Relation list

Depuis
2.0

Form Field class for FOF Joomla! ACL Rules

Depuis
2.1

Form Field class for FOF Renders the checkbox in browse views which allows you to select rows

Depuis
2.0

Form Field class for FOF Joomla! session handlers

Depuis
2.0

Form Field class for the FOF framework Spacer used between form elements

Depuis
2.0

Form Field class for FOF Radio selection listGeneric list from an SQL statement

Depuis
2.0

Form Field class for FOF Tag Fields

Depuis
2.1

Form Field class for the FOF framework Supports a URL text field.

Depuis
2.0

Form Field class for the FOF framework Supports a text area

Depuis
2.0

Form Field class for the FOF framework Supports a title field with an optional slug display below it.

Depuis
2.0

Form Field class for the FOF framework A user selection box / display field

Depuis
2.0

Form Field class for FOF Joomla! user groups

Depuis
2.0

Generic interface that a FOF form field class must implement

Depuis
2.0

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.

Depuis
2.0

Access level field header

Depuis
2.0

Generic field header, without any filters

Depuis
2.0

Generic field header, with text input (search) filter

Depuis
2.0

Generic field header, with drop down filters

Depuis
2.0

Generic field header, with drop down filters based on a SQL query

Depuis
2.0

Generic filter, text box entry with calendar button

Depuis
2.3.3

Generic filter, text box entry with optional buttons

Depuis
2.0

Generic filter, drop-down based on fixed options

Depuis
2.0

Generic filter, drop-down based on SQL query

Depuis
2.0

Language field header

Depuis
2.0

Ordering field header

Depuis
2.0

Field header for Published (enabled) columns

Depuis
2.0

Row selection checkbox

Depuis
2.0

An interface for FOFFormHeader fields, used to define the filters and the elements of the header row in repeatable (browse) views

Depuis
2.0

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.

Depuis
2.0

hal

Implementation of the Hypertext Application Language document in PHP. It can be used to provide hypermedia in a web service context.

Depuis
2.1

Implementation of the Hypertext Application Language link in PHP.

Depuis
2.1

Implementation of the Hypertext Application Language links in PHP. This is actually a collection of links.

Depuis
2.1

Interface for HAL document renderers

Depuis
2.1

Implements the HAL over JSON renderer

Depuis
2.1

include

Obsolète:
4.0 Deprecated without replacement include FOF by your own if required

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.

Depuis
1.0

input

FrameworkOnFramework input handling class. Extends upon the JInput class.

Depuis
2.0

platformFilesystem

platform

Part of the FOF Platform Abstraction Layer.

This implements the platform class for Joomla! 2.5 or later

Depuis
2.1

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.

Depuis
1.0

Helper to render a FOFLayout object, storing a base path

Depuis
x.y

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.nosp@m.t@gm.nosp@m.ail.c.nosp@m.om Licensed under MIT or GPLv3, see LICENSE

Depuis
2.0

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.nosp@m.t@gm.nosp@m.ail.c.nosp@m.om Licensed under MIT or GPLv3, see LICENSE

Depuis
2.1

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.nosp@m.t@gm.nosp@m.ail.c.nosp@m.om Licensed under MIT or GPLv3, see LICENSE

THIS IS THIRD PARTY CODE. Code comments are mostly useless placeholders to stop phpcs from complaining...

Depuis
2.0

model

FrameworkOnFramework model behavior class to filter front-end access to items based on the viewing access levels.

Depuis
2.1

FrameworkOnFramework model behavior class

Depuis
2.1

FrameworkOnFramework model behavior class to filter front-end access to items that are enabled.

Depuis
2.1

FrameworkOnFramework model behavior class to filter front-end access to items based on the language.

Depuis
2.1

FrameworkOnFramework model behavior class to filter front-end access to items craeted by the currently logged in user only.

Depuis
2.1

FrameworkOnFramework model behavior class. It defines the events which are called by a Model.

Depuis
2.1

FrameworkOnFramework model behavior dispatcher class

Depuis
2.1

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

Depuis
1.0

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.

Depuis
2.1

query

FrameworkOnFramework query base class; for compatibility purposes

Depuis
2.1
Obsolète:
2.1

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.

Depuis
2.0

Default Joomla! 1.5, 1.7, 2.5 view renderer class

Depuis
2.0

Joomla! 3 view renderer class

Depuis
2.0

Akeeba Strapper view renderer class.

Depuis
2.0

Helper class with utilitarian functions concerning strings

Depuis
2.0

table

FrameworkOnFramework table behavior class for assets

Depuis
2.1

FrameworkOnFramework table behavior class for content History

Depuis
2.2.0

FrameworkOnFramework table behavior class for tags

Depuis
2.1

FrameworkOnFramework table behavior class. It defines the events which are called by a Table.

Depuis
2.1

FrameworkOnFramework table behavior dispatcher class

Depuis
2.1

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.

Depuis
1.0

template

A utility class to load view templates, media files and modules.

Depuis
1.0

toolbar

The Toolbar class renders the back-end component title area and the back- and front-end toolbars.

Depuis
1.0

view

FrameworkOnFramework CSV View class. Automatically renders the data in CSV format.

Depuis
1.0

FrameworkOnFramework Form class. It preferrably renders an XML view template instead of a traditional PHP-based view template.

Depuis
2.0

FrameworkOnFramework HTML output class. Together with PHP-based view tempalates it will render your data into an HTML representation.

Depuis
2.1

FrameworkOnFramework JSON View class. Renders the data as a JSON object or array. It can optionally output HAL links as well.

Depuis
2.0

FrameworkOnFramework raw output class. It works like an HTML view, but the output is bare HTML.

Depuis
2.1

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

Depuis
1.0