Overview

Namespaces

  • Genetsis
    • core
      • activityid
      • user
  • None

Classes

  • AccessToken
  • ClientToken
  • Encryption
  • FileCache
  • LogConfig
  • LoginStatus
  • LoginStatusType
  • OAuth
  • OAuthConfig
  • OauthTemplate
  • RefreshToken
  • Request
  • StoredToken
  • Things
  • User

Interfaces

  • iTokenTypes

Exceptions

  • InvalidGrantException
  • Overview
  • Namespace
  • Class

Class User

This class stores user data.

Namespace: Genetsis\core
Package: Genetsis
Category: Bean
Version: 1.0
Located at core/User.php
Methods summary
public mixed
# getId( )

Returns the internal CKUSID of the user.

Returns the internal CKUSID of the user.

Returns

mixed
An integer whether it is been set or NULL otherwise.
public
# setId( integer $id )

Sets the internal CKUSID of the user.

Sets the internal CKUSID of the user.

Parameters

$id
internal CKUID.
public mixed
# getNick( )

Returns the user's nick.

Returns the user's nick.

Returns

mixed
A string or NULL if not been set.
public
# setNick( string $nick )

Sets user's nick.

Sets user's nick.

Parameters

$nick
nick.
public mixed
# getEmail( )

Returns the user's email.

Returns the user's email.

Returns

mixed
A string or NULL if not been set.
public
# setEmail( string $email )

Sets user's email.

Sets user's email.

Parameters

$email
email.
public mixed
# getBirthday( )

Returns the user's birthday.

Returns the user's birthday.

Returns

mixed
A string or NULL if not been set.
public
# setBirthday( string $birthday )

Sets user's birthday.

Sets user's birthday.

Parameters

$birthday
User's birthday.
public string
# getCountry( )

Returns the user's country.

Returns the user's country.

Returns

string
public
# setCountry( string $country )

Sets user's country.

Sets user's country.

Parameters

$country
public boolean
# getArcc( )

Returns ARCC (agree to receive communications)

Returns ARCC (agree to receive communications)

Returns

boolean
TRUE whether it is agree or FALSE otherwise.
public
# setArcc( boolean $arcc )

Sets ARCC (agree to receive communications)

Sets ARCC (agree to receive communications)

Parameters

$arcc
whether it is agree or FALSE otherwise.
public array
# getUserData( )

Returns user data stored

Returns user data stored

Returns

array
A vector which contains user data.
public
# setUserData( array $userData )

Sets user data.

Sets user data.

Parameters

$userData
contains user data.
public string
# getCw( )

Returns CW (web client)

Returns CW (web client)

Returns

string
An indentifier for the web client. It could be empty.
public
# setCw( string $cw )

Sets the web client.

Sets the web client.

Parameters

$cw
identifier for the web client.
public string
# getSection( )

Returns the identifier of the section where the user was registered.

Returns the identifier of the section where the user was registered.

Returns

string
The identifier of the section. It could be empty.
public
# setSection( string $section )

The identifier of the section where the user was registered.

The identifier of the section where the user was registered.

Parameters

$section
identifier of the section.
public array
# getUserIds( )

Returns the user IDs stored

Returns the user IDs stored

Returns

array
Array with the user IDs. It could not be empty.
public
# setUserIds( mixed $userIds )

Sets the user ID.

Sets the user ID.

Parameters

$userIds
array or string with the user ID.
public boolean
# getActive( )

Returns whether the user is active

Returns whether the user is active

Returns

boolean
TRUE if is active or FALSE otherwise.
public
# setActive( boolean $active )

Sets whether the user is active.

Sets whether the user is active.

Parameters

$active
whether it is active or FALSE otherwise.
public
# setBrand( object $brand )

Parameters

$brand
public object
# getBrand( )

Returns

object
public
# setOid( string $oid )

Parameters

$oid
public string
# getOid( )

Returns

string
public
# setProvince( Genetsis\core\QueryUserData $province )

Parameters

$province
public Genetsis\core\QueryUserData
# getProvince( )

Returns

Genetsis\core\QueryUserData
public
# setSex( Genetsis\core\QueryUserData $sex )

Parameters

$sex
public Genetsis\core\QueryUserData
# getSex( )

Returns

Genetsis\core\QueryUserData
public
# setTypologies( array $typologies )

Parameters

$typologies
public array
# getTypologies( )

Returns

array
API documentation generated by ApiGen