PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of user.php

User class. Handles all application interaction with a user

Constructor activating the default information of the language

Returns a reference to the global User object, only creating it if it
doesn't already exist.

This method must be invoked as:
<pre>  $user =& JUser::getInstance($id);</pre>

param: int     $id     The user to load - Can be an integer or string - If string, it is converted to ID automatically.
return: JUser              The User object.

getParam( $key, $default = null ) X-Ref

Method to get a parameter value

param: string     $key         Parameter key
param: mixed    $default    Parameter default value
return: mixed                The value or the default if it did not exist

setParam( $key, $value ) X-Ref

Method to set a parameter

param: string     $key     Parameter key
param: mixed    $value    Parameter value
return: mixed            Set parameter value

defParam( $key, $value ) X-Ref

Method to set a default parameter if it does not exist

param: string     $key     Parameter key
param: mixed    $value    Parameter value
return: mixed            Set parameter value

authorize( $acoSection, $aco, $axoSection = null, $axo = null ) X-Ref

Method to check JUser object authorization against an access control
object and optionally an access extension object

param: string    $acoSection    The ACO section value
param: string    $aco        The ACO value
param: string    $axoSection    The AXO section value    [optional]
param: string    $axo        The AXO value            [optional]
return: boolean    True if authorized

setLastVisit($timestamp=null) X-Ref

Pass through method to the table for setting the last visit date

param: int $timestamp The timestamp, defaults to 'now'
return: boolean True on success

getParameters($loadsetupfile = false, $path = null) X-Ref

Method to get the user parameters

This function tries to load an xml file based on the users usertype. The filename of the xml
file is the same as the usertype. The functionals has a static variable to store the parameters
setup file base path. You can call this function statically to set the base path if needed.

param: boolean    If true, loads the parameters setup file. Default is false.
param: path    Set the parameters setup file base path to be used to load the user parameters.
return: object    The user parameters object

setParameters($params ) X-Ref

Method to get the user parameters

param: object The user parameters object

getTable( $type = null, $prefix = 'JTable' ) X-Ref

Method to get the user table object

This function uses a static variable to store the table name of the user table to
it instantiates. You can call this function statically to set the table name if
needed.

param: string    The user table name to be used
param: string    The user table prefix to be used
return: object    The user table object

bind(& $array) X-Ref

Method to bind an associative array of data to a user object

param: array $array The associative array to bind to the object
return: boolean True on success

save( $updateOnly = false ) X-Ref

Method to save the JUser object to the database

param: boolean $updateOnly Save the object only if not a new user
return: boolean True on success

delete( ) X-Ref

Method to delete the JUser object from the database

param: boolean $updateOnly Save the object only if not a new user
return: boolean True on success

load($id) X-Ref

Method to load a JUser object by user id number

param: mixed     $identifier The user id of the user to load
param: string     $path         Path to a parameters xml file
return: boolean             True on success

Copyright:	Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License:	GNU/GPL, see LICENSE.php
Version:	$Id: user.php 14401 2010-01-26 14:10:00Z louis $
File Size:	614 lines (15 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Joomla 1.5.26 DE

/libraries/joomla/user/ -> user.php (summary)

Defines 1 class