classes/php5_classes/User.class.php

Properties

Description

This holds the geoUser class.

Classes

geoUser

Properties

 
 
System  
No 
No 

Description

An object representative of a certain user in the system.
Uses the "magic methods" __get and __set to allow accessing user's parameters by $user->field and set by $user->field = $info. When getting or setting fields in this way, no encoding or decoding is done automatically, so certain fields will need to be encoded or decoded.

Methods

__construct, __get, __set, getData, getSalutation, getUser, getUserId, isVerified, toArray, userName,

__construct( array   $userData, ) : n/a

Description

Do not create a new user object, use geoUser::getUser().

Arguments

Name Type Description Default
$userData array

Array of user's data (passed from self::getUser() when initializing the user)

Return value

Type Description
n/a n/a

__get( string   $name, ) : mixed

Description

Used to get a specific user detail for the user, by using $user_obj->user_detail.

Arguments

Name Type Description Default
$name string

Return value

Type Description
mixed

__set( string   $name, string   $value, ) : bool

Description

Will update any value set in userdata. Does NOT update logins table or geoRegions (city/state/country).

Arguments

Name Type Description Default
$name string
$value string

Return value

Type Description
bool

getData( string|int   $user_id = 0, string   $setting = null, ) : mixed

Description

Gets data for specified user id or username.
This is about the same as calling geoUser::getUser($user_id)->$setting if $setting is set, or geoUser::getUser($user_id)->toArray() if $setting is not set.

Arguments

Name Type Description Default
$user_id string|int

Either the user id, or the username.

0
$setting string

A specific setting to get for the user. If not set, will return an array of all the user's details.

null

Return value

Type Description
mixed The setting (or settings), or null if user not valid or something went wrong.

getSalutation( ) : string

Description

Gets the salutation, for use in e-mails sent to this user.

Return value

Type Description
string The salutation (including 2 newlines) to use in an e-mail to this user.

getUser( int|string   $user, ) : \geoUser|null

Description

Standard way to get a user object, either by username or user id.

Arguments

Name Type Description Default
$user int|string

Either the user ID, or the username.

Return value

Type Description
\geoUser|null Will return null if user could not be found.

getUserId( string   $username, ) : int

Description

Convienience method, gets the userId for the specified username, or 0 if the username could not be found or is invalid. Note that using this is no more efficient than calling geoUser::getUser($username)->id

Arguments

Name Type Description Default
$username string

Return value

Type Description
int The user's ID or 0 if not found.

isVerified( int   $user_id, ) : n/a

Description

Gets whether or not the given user is verified or not, without creating extra overhead of getting "full" user info for every single user checked.
Note that this DOES check to make sure verify_accounts is turned on first.

Arguments

Name Type Description Default
$user_id int

Return value

Type Description
n/a n/a

Tags

Name Description
since Version 6.0.0

toArray( ) : array

Description

Returns an associative array representation of the user's data, great for using in templates and the like where objects are not ideal.

Return value

Type Description
array

userName( int   $user_id, ) : string

Description

Convienience method, gets the user name for the specified userId.
Using this is the about the same as calling geoUser::getUser($id)->username.

Arguments

Name Type Description Default
$user_id int

Return value

Type Description
string The username for the user id specified, or empty string if user ID not valid or not found.

Properties

$_userData, $_users,

array  private  $_userData = array()

The array of user data, formatted as it would be in the DB. Currently no encoding/decoding is done.


array  private  static $_users = array()

Array of user objects that have already been retrieved this page load.

Array of geoUser objects.




Documentation was generated by phpDocumentor 2.2.0 .

Namespaces

  • global

    Packages

    • Default
      • ExampleAddon
        • addon_example_admin
          In charge of doing stuff on the admin side, this is optional.
        • addon_example_info
          Required class for addons, this is the Addon information class, used by the addon system to determine what the addon can do. Also contains info about the addon that can be viewed in the addon management page in the admin.
        • addon_example_pages
          Addon page class, used by the addon system to display pages on the client side.
        • addon_example_setup
          This class is not required. If it, and the function for a particular routine exist, then that function will be called IN ADDITION TO the automated routines of the addon framework.
        • addon_example_tags
          Expects one function for each tag. Function name should be the same as the tag name. Can also have a constructor if anything needs to be constructed.
        • addon_example_util
          This is where to put functions that the main part of the addon will use.
        • eWidgetOrderItem
          This order item is designed to allow users on your site to purchase an eWidget.
      • System
        • DataAccess
          This is the main Database access object.
        • Singleton
          Singleton method class
        • _templateOrderItem
          Developers: use this file as a template to create a new order item.
        • _templatePaymentGateway
          This is the "developer template" payment gateway handler, a developer could use this file as a starting point for creating a new payment gateway in the system.
        • geoAPI
          The main system class for receiving and handling remote API calls, this acts as a translation layer between the communication with the "outside" and each API call.
        • geoAddon
          This is the class that handles anything and everything to do with addons.
        • geoArrayTools
          Utility functions for manipulating arrays
        • geoBrowse
          Contains functions common to browsing listings
        • geoBrowsingFilter
          System for activating, storing, and deactivating browsing filters.
        • geoCJAX
          Class that wraps the CJAX_FRAMEWORK, used to get the CJAX class.
        • geoCache
          This is the main part of the Geo cache system, it does all the "low level" stuff like writing files and escaping cache data.
        • geoCacheModule
          Part of Geo Cache system, specifically tuned to work best with cacheing module data (which will be an array).
        • geoCachePage
          Cache system specifically tuned to work best with cacheing output of pages and modules
        • geoCacheSetting
          Part of Geo Cache system, specifically tuned to work best with cacheing site-wide key=value type settings.
        • geoCacheText
          Part of Geo Cache system, this part specifically tuned to work best with cacheing language specific messages.
        • geoCalendar
          Holds utility method(s) for manipulating stuff dealing with calendar selector.
        • geoCart
          This class is behind the cart, loading all the order items and such and displaying, and processing all the different pages.
        • geoCategory
          Utility class that holds various methods to do stuff with categories in the system.
        • geoCombineResources
          This class helps to combine CSS and JS files, minify them, and optionally compress them.
        • geoCron
          This is the cron job backend, it handles all the communication and security and all that.
        • geoCrypt
          Class to use for encrypting information that needs to be able to be retrieved later.
        • geoDate
          Holds utility method(s) for manipulating stuff dealing with dates.
        • geoEmail
          Class that sends out e-mails.
        • geoFields
          Class that holds settings information for fields to use.
        • geoFieldsField
          A mini object to hold data about a specific field.
        • geoFile
          As the name implies, this is used for file-based utility methods.
        • geoFilter
          A few utility methods, good for filtering stuff.
        • geoFormatString
          Used to display a message nice and pretty, we'll probably be getting rid of this class though so don't go crazy using it.
        • geoHTML
          Class to generate chunks of HTML that are very common, used the most in the admin panel.
        • geoImage
          This class is responsible for a lot of the image processing, along with other aspects like generating the image tag for thumbnails.
        • geoInvoice
          This is the invoice object representing an invoice in the system.
        • geoLeveledField
          Class for doing common things with leveled fields.
        • geoListing
          A listing object, basically a container object for particular listing.
        • geoListingDisplay
          This is basically a container that is responsible for helping to display {listing .
        • geoListingFeed
          Class that helps to render RSS or other types of feeds based on list of listings.
        • geoMaster
          This is dedicated class for getting the value of, and setting, the various "master switches" within the software. Since this is meant as an easy way to get the values of master switches, most of the methods are static.
        • geoNumber
          Utility functions relating to number conversion/manipulation/validation ect.
        • geoOrder
          The geoOrder object, an object representation of an order in the system.
        • geoOrderItem
          The class that all order items must extend.
        • geoPC
          Used for login credential validation, password hashing, etc. along with software licensing.
        • geoPagination
          Utility functions useful for generating pagination of a results page such as when browing ads or searching
        • geoPaymentGateway
          This class should be extended by each different payment gateway, this will have some default functions that each gateway will inherit, and also has a few final static methods used by the system to affect all order items.
        • geoPlanItem
          A container to hold settings for a particular order item type, according to price plan ID, and optionally category ID for category specific settings.
        • geoRecurringBilling
          The geoRecurringBilling object, an object representation of a recurring billing in the system.
        • geoRegion
          Stuff for regions and sub-regions.
        • geoRegistry
          Handy little object, can be used to set registry type settings.
        • geoSearchUtils
          Class for search utilities.
        • geoSellerBuyer
          Handles back-end for the seller/buyer payment gateways, to allow the buyer to more easily pay the seller for a won auction. This handles the underlying system, but the actual work is done by individual seller/buyer gateways, for instance the Paypal buy-now functionality.
        • geoSession
          Manages session storage and session cookies for user sessions.
        • geoString
          Utility functions relating to languages and string manipulation.
        • geoStringData
          This class is to store accented chars, to be used by {@link geoString::removeAccents()}, mainly to keep the String.class.php file un-cluttered.
        • geoTable
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableRow
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableRowset
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableSelect
          Class used to generate a select query, useful when multiple areas want to affect a single query, for instance when generating a search query and there are addons involved.
        • geoTables
          Used to hold database table names, used throughout the code.
        • geoTemplate
          Template object that extends the Smarty class (a 3rd party library) to enable using templates to display things.
        • geoTransaction
          This is the object used for a transaction in the order and invoice system.
        • geoUser
          An object representative of a certain user in the system.
        • geoUserRating
          Store, retrieve, and display inter-user ratings
        • geoUtil
          Misc utility functions
        • geoView
          As the name implies, this is used for creating the page view. It does take a little setup (like any class), the setup is normally done in the display_page method in geoSite, or display_page in geoAdmin if displaying a page in the admin.
        • iApiTransport
          Interface for API Transports, a transport must implement this interface for the system to use it.
        • iOrderItem
          You cannot have abstract static functions, so instead need to have an interface to force the given static functions to be defined.
        • metaDbTables
          Used so that old locations that use the old name geoTables will still work.