Graphe d'héritage de JModelForm:

Graphe de collaboration de JModelForm:

Fonctions membres publiques
	checkin ($pk=null)
	checkout ($pk=null)
	getForm ($data=array(), $loadData=true)
	validate ($form, $data, $group=null)
Fonctions membres publiques inherited from JModelLegacy
	__construct ($config=array())
	getDbo ()
	getName ()
	getState ($property=null, $default=null)
	getTable ($name= '', $prefix= 'Table', $options=array())
	loadHistory ($version_id, JTable &$table)
	setDbo ($db)
	setState ($property, $value=null)
Fonctions membres publiques inherited from JObject
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)

Fonctions membres protégées
	loadForm ($name, $source=null, $options=array(), $clear=false, $xpath=false)
	loadFormData ()
	preprocessData ($context, &$data)
	preprocessForm (JForm $form, $data, $group= 'content')
Fonctions membres protégées inherited from JModelLegacy
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix= 'Table', $config=array())
	populateState ()
	cleanCache ($group=null, $client_id=0)

Attributs protégés
	$_forms = array()
Attributs protégés inherited from JModelLegacy
	$__state_set = null
	$_db
	$name
	$option = null
	$state
	$event_clean_cache = null
Attributs protégés inherited from JObject
	$_errors = array()

Additional Inherited Members
Fonctions membres publiques statiques inherited from JModelLegacy
static	addIncludePath ($path= '', $prefix= '')
static	addTablePath ($path)
static	getInstance ($type, $prefix= '', $config=array())
Fonctions membres protégées statiques inherited from JModelLegacy
static	_createFileName ($type, $parts=array())

Description détaillée

Définition à la ligne 22 du fichier form.php.

Documentation des fonctions membres

JModelForm::checkin ( $pk = null )

Method to checkin a row.

Paramètres:

integer $pk The numeric id of the primary key.

Renvoie:: boolean False on failure or error, true otherwise.

Depuis:: 12.2

Réimplémentée dans JModelAdmin.

Définition à la ligne 41 du fichier form.php.

Références JText\_(), et JFactory\getUser().

        {
                // Only attempt to check the row in if it exists.
                if ($pk)
                {
                        $user = JFactory::getUser();
                        // Get an instance of the row to checkin.
                        $table = $this->getTable();
                        if (!$table->load($pk))
                        {
                                $this->setError($table->getError());
                                return false;
                        }
                        // Check if this is the user having previously checked out the row.
                        if ($table->checked_out > 0 && $table->checked_out != $user->get('id') && !$user->authorise('core.admin', 'com_checkin'))
                        {
                                $this->setError(JText::_('JLIB_APPLICATION_ERROR_CHECKIN_USER_MISMATCH'));
                                return false;
                        }
                        // Attempt to check the row in.
                        if (!$table->checkin($pk))
                        {
                                $this->setError($table->getError());
                                return false;
                        }
                }
                return true;
        }

Voici le graphe d'appel pour cette fonction :

JModelForm::checkout ( $pk = null )

Method to check-out a row for editing.

Paramètres:

integer $pk The numeric id of the primary key.

Renvoie:: boolean False on failure or error, true otherwise.

Depuis:: 12.2

Réimplémentée dans JModelAdmin.

Définition à la ligne 84 du fichier form.php.

Références JText\_(), et JFactory\getUser().

        {
                // Only attempt to check the row in if it exists.
                if ($pk)
                {
                        // Get an instance of the row to checkout.
                        $table = $this->getTable();
                        if (!$table->load($pk))
                        {
                                $this->setError($table->getError());
                                return false;
                        }
                        // If there is no checked_out or checked_out_time field, just return true.
                        if (!property_exists($table, 'checked_out') || !property_exists($table, 'checked_out_time'))
                        {
                                return true;
                        }
                        $user = JFactory::getUser();
                        // Check if this is the user having previously checked out the row.
                        if ($table->checked_out > 0 && $table->checked_out != $user->get('id'))
                        {
                                $this->setError(JText::_('JLIB_APPLICATION_ERROR_CHECKOUT_USER_MISMATCH'));
                                return false;
                        }
                        // Attempt to check the row out.
                        if (!$table->checkout($user->get('id'), $pk))
                        {
                                $this->setError($table->getError());
                                return false;
                        }
                }
                return true;
        }

Voici le graphe d'appel pour cette fonction :

JModelForm::getForm	(	$data = `array()`,
		$loadData = `true`
	)

abstract

Abstract method for getting the form from the model.

Paramètres:

array	$data	Data for the form.
boolean	$loadData	True if the form is to load its own data (default case), false if not.

Renvoie:: mixed A JForm object on success, false on failure

Depuis:: 12.2

JModelForm::loadForm	(	$name,
		$source = `null`,
		$options = `array()`,
		$clear = `false`,
		$xpath = `false`
	)

protected

Method to get a form object.

Paramètres:

string	$name	The name of the form.
string	$source	The form source. Can be XML string if file flag is set to false.
array	$options	Optional array of options for the form creation.
boolean	$clear	Optional argument to force load a new form.
string	$xpath	An optional xpath to search for the fields.

Renvoie:: mixed JForm object on success, False on error.

Voir également:: JForm

Depuis:: 12.2

Définition à la ligne 150 du fichier form.php.

Références JForm\addFieldPath(), JForm\addFormPath(), JForm\getInstance(), et JArrayHelper\getValue().

        {
                // Handle the optional arguments.
                $options['control'] = JArrayHelper::getValue($options, 'control', false);
                // Create a signature hash.
                $hash = md5($source . serialize($options));
                // Check if we can use a previously loaded form.
                if (isset($this->_forms[$hash]) && !$clear)
                {
                        return $this->_forms[$hash];
                }
                // Get the form.
                JForm::addFormPath(JPATH_COMPONENT . '/models/forms');
                JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');
                JForm::addFormPath(JPATH_COMPONENT . '/model/form');
                JForm::addFieldPath(JPATH_COMPONENT . '/model/field');
                try
                {
                        $form = JForm::getInstance($name, $source, $options, false, $xpath);
                        if (isset($options['load_data']) && $options['load_data'])
                        {
                                // Get the data for the form.
                                $data = $this->loadFormData();
                        }
                        else
                        {
                                $data = array();
                        }
                        // Allow for additional modification of the form, and events to be triggered.
                        // We pass the data because plugins may require it.
                        $this->preprocessForm($form, $data);
                        // Load the data into the form after the plugins have operated.
                        $form->bind($data);
                }
                catch (Exception $e)
                {
                        $this->setError($e->getMessage());
                        return false;
                }
                // Store the form for later.
                $this->_forms[$hash] = $form;
                return $form;
        }

Voici le graphe d'appel pour cette fonction :

JModelForm::loadFormData ( )

protected

Method to get the data that should be injected in the form.

Renvoie:: array The default data is an empty array.

Depuis:: 12.2

Définition à la ligne 211 du fichier form.php.

        {
                return array();
        }

JModelForm::preprocessData	(		$context,
		&	$data
	)

protected

Method to allow derived classes to preprocess the data.

Paramètres:

string	$context	The context identifier.
mixed	&$data	The data to be processed. It gets altered directly.

Renvoie:: void

Depuis:: 3.1

Définition à la ligne 226 du fichier form.php.

Références JEventDispatcher\getInstance().

        {
                // Get the dispatcher and load the users plugins.
                $dispatcher = JEventDispatcher::getInstance();
                JPluginHelper::importPlugin('content');
                // Trigger the data preparation event.
                $results = $dispatcher->trigger('onContentPrepareData', array($context, $data));
                // Check for errors encountered while preparing the data.
                if (count($results) > 0 && in_array(false, $results, true))
                {
                        $this->setError($dispatcher->getError());
                }
        }

Voici le graphe d'appel pour cette fonction :

JModelForm::preprocessForm	(	JForm	$form,
			$data,
			$group = `'content'`
	)

protected

Method to allow derived classes to preprocess the form.

Paramètres:

JForm	$form	A JForm object.
mixed	$data	The data expected for the form.
string	$group	The name of the plugin group to import (defaults to "content").

Renvoie:: void

Voir également:: JFormField

Depuis:: 12.2

Exceptions:

Exception if there is an error in the form event.

Définition à la ligne 255 du fichier form.php.

Références JEventDispatcher\getInstance().

        {
                // Import the appropriate plugin group.
                JPluginHelper::importPlugin($group);
                // Get the dispatcher.
                $dispatcher = JEventDispatcher::getInstance();
                // Trigger the form preparation event.
                $results = $dispatcher->trigger('onContentPrepareForm', array($form, $data));
                // Check for errors encountered while preparing the form.
                if (count($results) && in_array(false, $results, true))
                {
                        // Get the last error.
                        $error = $dispatcher->getError();
                        if (!($error instanceof Exception))
                        {
                                throw new Exception($error);
                        }
                }
        }

Voici le graphe d'appel pour cette fonction :

JModelForm::validate	(	$form,
		$data,
		$group = `null`
	)

Method to validate the form data.

Paramètres:

JForm	$form	The form to validate against.
array	$data	The data to validate.
string	$group	The name of the field group to validate.

Renvoie:: mixed Array of filtered data if valid, false otherwise.

Voir également:: JFormRule; JFilterInput

Depuis:: 12.2

Définition à la ligne 292 du fichier form.php.

        {
                // Filter and validate the form data.
                $data = $form->filter($data);
                $return = $form->validate($data, $group);
                // Check for an error.
                if ($return instanceof Exception)
                {
                        $this->setError($return->getMessage());
                        return false;
                }
                // Check the validation results.
                if ($return === false)
                {
                        // Get the validation messages from the form.
                        foreach ($form->getErrors() as $message)
                        {
                                $this->setError($message);
                        }
                        return false;
                }
                // Tags B/C break at 3.1.2
                if (isset($data['metadata']['tags']) && !isset($data['tags']))
                {
                        $data['tags'] = $data['metadata']['tags'];
                }
                return $data;
        }

Documentation des données membres

JModelForm::$_forms = array()

protected

Définition à la ligne 30 du fichier form.php.

La documentation de cette classe a été générée à partir du fichier suivant :

jplatform-13.1/legacy/model/form.php

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Additional Inherited Members

Description détaillée

Documentation des fonctions membres

Documentation des données membres