Référence de la classe PlgUserProfile

Graphe d'héritage de PlgUserProfile:

Fonctions membres publiques
	__construct (& $subject, $config)
	onContentPrepareData ($context, $data)
	onContentPrepareForm (Form $form, $data)
	onUserBeforeSave ($user, $isnew, $data)
	onUserAfterSave ($data, $isNew, $result, $error)
	onUserAfterDelete ($user, $success, $msg)

Fonctions membres publiques statiques
static	url ($value)
static	calendar ($value)
static	dob ($value)
static	tos ($value)

Attributs protégés
	$autoloadLanguage = true

Attributs privés
	$date = ''

Description détaillée

An example custom profile plugin.

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

__construct	(	&	$subject,
			$config
	)

Constructor

Paramètres

object	&$subject	The object to observe
array	$config	An array that holds the plugin configuration

Depuis

1.5

Références $config, et $subject.

Documentation des fonctions membres

calendar()

static calendar (   $value )

static

Returns html markup showing a date picker

Paramètres

string

$value

valid date string

Renvoie

mixed

Références $value, et null.

dob()

static dob (   $value )

static

Returns the date of birth formatted and calculated using server timezone.

Paramètres

string

$value

valid date string

Renvoie

mixed

Références $value.

onContentPrepareData()

onContentPrepareData	(		$context,
			$data
	)

Runs on content preparation

Paramètres

string	$context	The context for the data
object	$data	An object containing the data for the form.

Renvoie

boolean

Depuis

1.6

Références $context, $data, $db, $results, $userId, et null.

onContentPrepareForm()

onContentPrepareForm	(	Form	$form,
			$data
	)

Adds additional fields to the user editing form

Paramètres

Form	$form	The form to be altered.
mixed	$data	The associated data for the form.

Renvoie

boolean

Depuis

1.6

Références $app, $field, $fields, $form, $name, et elseif.

onUserAfterDelete()

onUserAfterDelete	(		$user,
			$success,
			$msg
	)

Remove all user profile information for the given user ID

Method is called after user data is deleted from the database

Paramètres

array	$user	Holds the user data
boolean	$success	True if user was successfully stored in the database
string	$msg	Message

Renvoie

boolean

Références $db, $user, et $userId.

onUserAfterSave()

onUserAfterSave	(		$data,
			$isNew,
			$result,
			$error
	)

Saves user profile data

Paramètres

array	$data	entered user data
boolean	$isNew	true if this is a new user
boolean	$result	true if saving the user worked
string	$error	error message

Renvoie

boolean

Références $data, $date, $db, $key, $query, $userId, et json_encode.

onUserBeforeSave()

onUserBeforeSave	(		$user,
			$isnew,
			$data
	)

Method is called before user data is stored in the database

Paramètres

array	$user	Holds the old user data.
boolean	$isnew	True if a new user is stored.
array	$data	Holds the new user data.

Renvoie

boolean

Depuis

3.1

Exceptions

InvalidArgumentException

on invalid date.

Références $data, $date, $option, et $task.

tos()

static tos (   $value )

static

Return the translated strings yes or no depending on the value

Paramètres

boolean

$value

input value

Renvoie

string

Références $value.

url()

static url (   $value )

static

Returns an anchor tag generated from a given value

Paramètres

string

$value

URL to use

Renvoie

mixed|string

Références $value, et htmlspecialchars.

Documentation des champs

$autoloadLanguage

$autoloadLanguage = true

protected

$date

$date = ''

private

---

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

• plugins/user/profile/profile.php