This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_UserInfo

While the User object deals more with logging users in and relating them to core Concrete items, like Groups, the UserInfo object is made to grab auxiliary data about a user, including their user attributes. Additionally, the UserInfo object is the object responsible for adding/registering users in the system.

Concrete5_Library_Object
Extended by Object
Extended by Concrete5_Model_UserInfo

Direct known subclasses

UserInfo

Package: Users
Category: Concrete
Copyright: Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
License: MIT License
Located at core/models/userinfo.php

Methods summary

public
public
# __call( $nm, $a )
public static UserInfo
# getByID( integer $uID )

returns the UserInfo object for a give user's uID

public static UserInfo
# getByUserName( string $uName )

returns the UserInfo object for a give user's username

public static UserInfo
# getByEmail( string $uEmail )

returns the UserInfo object for a give user's email address

public UserInfo
# getByOpenID( string $uOpenID )

Returns a user object by open ID. Does not log a user in.

public static UserInfo
# getByValidationHash( string $uHash, boolean $unredeemedHashesOnly = true )
public static UserInfo
# add( array $data, array $options = false )
public
# addSuperUser( $uPasswordEncrypted, $uEmail )
public
# delete( )

Deletes a user

public
# setGroupMemberType( string $type )

Called only by the getGroupMembers function it sets the "type" of member for this group. Typically only used programmatically

public
public
public
# sendPrivateMessage( $recipient, $subject, $text, $inReplyTo = false )
public User
# getUserObject( )

gets the user object of the current UserInfo object ($this)

public
# setAttribute( $ak, $value )

Sets the attribute of a user info object to the specified value, and saves it in the database

public
# clearAttribute( $ak )
public
# reindex( )
public
# getAttribute( $ak, $displayMode = false )

Gets the value of the attribute for the user

public
public
# getAttributeValueObject( $ak, $createIfNotFound = false )
public
# update( $data )
public
# updateGroups( $groupArray )
public UserInfo
# register( array $data )
public
public
public
# changePassword( $newPassword )
public
# activate( )
public
public
public
public
public
public
public
# isActive( )
public
public
public
public
public
public
public
public
public string
# getUserDateAdded( string $type = 'system', $datemask = 'Y-m-d H:i:s' )

Gets the date a user was added to the system, if user is specified, returns in the current user's timezone

public
# canRead( )
public
public
public
# canWrite( )
public
public
public
public
public
public
public
public
# canAdmin( )
public
# canSearchFiles( )

File manager permissions at the user level

public
public
public
public
public
public
public
# getUserStartDate( $type = 'system' )
public string
# getLastOnline( string $type = 'system' )

Gets the date a user was last active on the site if user is specified, returns in the current user's timezone

public
# getUserEndDate( $type = 'system' )

Constants summary

integer ADD_OPTIONS_NOHASH
# 0
integer ADD_OPTIONS_SKIP_CALLBACK
# 1

Properties summary

Properties inherited from Concrete5_Library_Object

$error