classes/php5_classes/DataAccess.class.php

Properties

Description

Encoded file, used for license validation, database access, and other core-level functionality.

Constants

  IS_ROBOT = 1




Classes

DataAccess

Properties

 
 
System  
No 
No 

Description

This is the main Database access object.
This class provides database access, and core functionality used throughout the entire software. Works directly with {@link geoSession} and {@link geoPC}, and requires (like most geo classes) that the software is initialized using app_top.common.php.

Methods

Affected_Rows, Close, ErrorMsg, Execute, GetAll, GetArray, GetAssoc, GetCol, GetOne, GetRow, Insert_Id, IsConnected, MetaError, Prepare, SetFetchMode, __clone, __construct, addBrowsingWhereClause, checkBannedIp, cleanMasterValue, getDbInfo, getInstance, getLanguage, getMasters, getStats, getTableSelect, get_site_setting, get_site_settings, get_text, init, isBrowsingWhereClause, microtime_float, moduleTag, num_new_ads_in_category, preload_num_new_ads, qstr, quoteInto, sendMail, set_site_setting, tableColumnExists, tableExists,

Affected_Rows( ) : n/a

Description

Returns number of rows affected by previous query.

Return value

Type Description
n/a n/a

Close( ) : n/a

Description

Wrapper for db->Close()

Return value

Type Description
n/a n/a

ErrorMsg( ) : String

Description

Wrapper for outputing any db error messages.

Return value

Type Description
String Error message string.

Execute( String   $sql, \(Optional)Array   $inputs = null, ) : Mixed

Description

Execute function wraps the ado db execute funtion, and does additional error checking, profiling, and debugging, accessed through an error handler addon

Arguments

Name Type Description Default
$sql String
$inputs \(Optional)Array

see documentation for ADODB Execute

null

Return value

Type Description
Mixed result set for executed query

GetAll( string   $sql, mixed   $data = null, ) : array|bool

Description

Wraps ADODB::GetAll, see adodb documentation

Arguments

Name Type Description Default
$sql string
$data mixed null

Return value

Type Description
array|bool

GetArray( string   $sql, ) : Mixed

Description

Wraps ADODB::GetArray(), see adodb documentation.

Arguments

Name Type Description Default
$sql string

Return value

Type Description
Mixed

GetAssoc( string   $sql, mixed   $data = null, ) : array

Description

Wraps ADODB::GetAssoc, see adodb documentation

Arguments

Name Type Description Default
$sql string
$data mixed null

Return value

Type Description
array

GetCol( mixed   $var1, mixed   $var2 = null, ) : mixed

Description

Wraps ADODB::GetCol(), see adodb documentation.

Arguments

Name Type Description Default
$var1 mixed
$var2 mixed null

Return value

Type Description
mixed

GetOne( string   $sql, Mixed   $inputarr = false, ) : \unknown

Description

Wraps ADODB::GetOne(), see adodb documentation

Arguments

Name Type Description Default
$sql string
$inputarr Mixed false

Return value

Type Description
\unknown

GetRow( string   $sql, mixed   $data = null, ) : array|bool

Description

Wraps ADODB::GetRow(), see adodb documentation.

Arguments

Name Type Description Default
$sql string
$data mixed null

Return value

Type Description
array|bool

Insert_Id( ) : Mixed

Description

Wraps ADODB::Insert_Id(), see adodb documentation

Return value

Type Description
Mixed

IsConnected( ) : bool

Description

Function to see if we are currently connected to the database.

Return value

Type Description
bool

MetaError( ) : n/a

Description

Wraps ADODB::MetaError, see adodb documentation

Return value

Type Description
n/a n/a

Prepare( string   $sql, ) : Mixed

Description

Wraps ADODB::Prepare(), see adodb documentation.

Arguments

Name Type Description Default
$sql string

Return value

Type Description
Mixed

SetFetchMode( Mixed   $value, ) : Mixed

Description

Wraps ADODB::SetFetchMode(), see adodb documentation.

Arguments

Name Type Description Default
$value Mixed

Return value

Type Description
Mixed

__clone( ) : n/a

Description

Prevents DataAccess from being cloned.

Return value

Type Description
n/a n/a

Tags

Name Description
throws

__construct( ) : n/a

Description

Constructor for DataAccess. DataAccess should never be called using new DataAccess(); Instead, use {@link DataAccess::getInstance()}

Return value

Type Description
n/a n/a

addBrowsingWhereClause( string   $name, string   $sql, array   $data = null, string   $additionalTable = null, ) : n/a

Description

Add a where clause to filter all listings by when browsing the site. This is the method used for the different built-in filters such as zip filter, state filter, geographic navigation, etc.

Arguments

Name Type Description Default
$name string

The name, needs to be unique. Used to make sure the same filter is not applied multiple times.

$sql string

The where clause to add to SQL queries, should be something like "column='value'"

$data array

(optional)If the SQL query uses ? such as "column=?", this is the array of data that would be passed as the second param when the SQL query is executed.

null
$additionalTable string

(optional) WILL CAUSE ERROR - Using this parameter will cause it to print an error and exit.

null

Return value

Type Description
n/a n/a

Tags

Name Description
deprecated Since version 6.0.0, this will be removed. Use the geoTableSelect object returned by calling $db->getTableSelect('browse') instead.

checkBannedIp( ) : boolean

Description

Replaces the site_class check_ip. This checks to see if ip banning is turned on, if it is, it checks the current IP against the banned ip's. If the current IP matches a banned IP, it unsets all user-input data, like REQUEST, POST, GET, COOKIE, and treats the user like a robot (no session, no redirect, etc). That way, if someone is on IP ban list, the only thing they can do is view the front page, nothing will work.
Special: to test if an IP is banned or not, do ?check_ban_ip=1 in the URL, and will display a message of whether the IP is banned. This only happens if there are IPs in the banned ip table. CLIENT SIDE

Return value

Type Description
boolean true to indicate it has checked the ip successfully, false if there was an error checking the IP.

cleanMasterValue( string   $setting, string|bool   $value, ) : n/a

Description

Makes sure the "master value" is either "on" or "off". If it is bool, it will set to on for true, off for false. Or if not on/off and not bool, it will be evaluated as a bool and set to 'on' if true, 'off' if evaluates to false.

Arguments

Name Type Description Default
$setting string

The master setting

$value string|bool

Either on/off or true/false

Return value

Type Description
n/a n/a

Tags

Name Description
since Version 7.0.3

getDbInfo( ) : array

Description

Gets the current database settings. Meant to be used for api integration.

Return value

Type Description
array Array containing the db type and the database name.

getInstance( ) : \DataAccess

Description

Gets an instance of the data access class, to keep from creating multiple instances when we only need one.

Return value

Type Description
\DataAccess

getLanguage( boolean   $from_db = false, ) : int

Description

Gets the language for the session or gets the default language for the site.

Arguments

Name Type Description Default
$from_db boolean

If this is set to true, this will return the default language for the site. If left to default value, it will return the language for the current user.

false

Return value

Type Description
int the language_id of the session, or of the defualt language for the site, depending on what $from_db is set to.

getMasters( ) : array

Description

Function used to get master switches set.

Return value

Type Description
array

Tags

Name Description
since Version 7.0.3

getStats( ) : string

Description

Gets the current database usage statistics, in an HTML table.

Return value

Type Description
string Current db stats, in an html table format.

getTableSelect( string   $for = self::SELECT_BROWSE, bool   $copy = false, ) : \geoTableSelect

Description

Gets the table select object so that it can be configured by different sources, such as built-in functionality and also allow addons to modify functionality.

Arguments

Name Type Description Default
$for string

Either DataAccess::SELECT_BROWSE for the table select object used during browsing, or DataAccess::SELECT_SEARCH to affect the search query.

self::SELECT_BROWSE
$copy bool

If true, will return a copy instead of original, typically places that are using this to actually generate a query will pass in true

false

Return value

Type Description
\geoTableSelect

Tags

Name Description
since Version 6.0.0

get_site_setting(   $setting, \[Optional]String   $check_long = false, ) : mixed

Description

Gets a particular site setting, returns false if the setting is not found. Uses the new geodesic_site_settings table, and the old geodesic_classifieds_configuration table. If a setting is set in both geodesic_site_settings, and geodesic_classifieds_configuration, the setting from geodesic_site_settings takes precedence. Note that the table geodesic_classifieds_configuration will not be used any more, once all the settings have been moved over to the new table.

Arguments

Name Type Description Default
$setting n/a
$check_long \[Optional]String

Set to true if you want it to also check the long setting table.

false

Return value

Type Description
mixed The value for the setting, or false if the setting is not set.

get_site_settings( boolean   $return_table = false, ) : mixed

Description

Function to get all the site configuration settings. This uses the new site config table.

Arguments

Name Type Description Default
$return_table boolean

if set to true, will return the configuration settings.

false

Return value

Type Description
mixed

get_text( boolean   $return_text = false, int   $current_page_id = 0, ) : n/a

Description

Function to make sure the text for a certain page or pages are loaded.

Arguments

Name Type Description Default
$return_text boolean

set to true if you want the text array to be returned.

false
$current_page_id int

The page id to get the text for.

0

Return value

Type Description
n/a n/a

init( ) : n/a

Description

Private function that initializes the database, this is called internally the first time a database connection is needed.

Return value

Type Description
n/a n/a

isBrowsingWhereClause( ) : bool

Description

NO LONGER USED! We will be removing this method in a future release, for now it will always return false! If you previously used this method, most likely you are also using the method getBrowsingWhereClause() which has been totally removed. You will need to change your code to use DataAccess->getTableSelect() to build your SQL, see that method's documentation for more info.

Return value

Type Description
bool

Tags

Name Description
deprecated In version 6.0.0, Feb 28, 2011. Will be removed in a future feature release. For now, this function will always return false. The replacement is DataAccess->getTableSelect(DataAccess::SELECT_BROWSE)->hasWhere()

microtime_float( ) : n/a

Description

Utility function, gets the current microtime and returns it in float format.

Return value

Type Description
n/a n/a

moduleTag( string   $tag, array   $params, Object   $smarty, ) : string

Description

Used by the template system to load the contents of {module .
..} tags

Arguments

Name Type Description Default
$tag string
$params array
$smarty Object

Return value

Type Description
string

Tags

Name Description
since Version 6.0

num_new_ads_in_category( int   $category_id, int   $ends_limit, int   $placed_limit, ) : int

Description

Optimized version of the old site->num_new_ads_in_category function that, if {@link DataAccess::preload_num_new_ads()} is used, gets the data from cached counts, significantly speeding up page load times.

Arguments

Name Type Description Default
$category_id int
$ends_limit int
$placed_limit int

Return value

Type Description
int Number of ads in the category.

preload_num_new_ads( int   $ends_limit, int   $placed_limit, ) : n/a

Description

This preloads the count of new ads for every category

Arguments

Name Type Description Default
$ends_limit int

Ending time for new ads must be greater than this.

$placed_limit int

Time the ad is placed must be greater than this.

Return value

Type Description
n/a n/a

qstr( Mixed   $var_1, Mixed   $var_2 = null, ) : Mixed

Description

Wraps ADODB::qstr, see adodb documentation

Arguments

Name Type Description Default
$var_1 Mixed
$var_2 Mixed null

Return value

Type Description
Mixed

quoteInto( string   $query, array|string   $values, array|string   $types = null, ) : string

Description

Quote values into a string, replacing the ? found in the string with the quoted values, suitable to be used as part of a query

Arguments

Name Type Description Default
$query string

The query part to insert the quoted values into, something like "var1 = ?"

$values array|string

The value(s) to be quoted

$types array|string

The type(s) for each value, assumes DataAccess::TYPE_STRING if none is specified.

null

Return value

Type Description
string The query with quoted values inserted

Tags

Name Description
since Version 5.2.0

sendMail( string   $to, string   $subject, string   $content, \(optional)string   $from = 0, \(optional)string   $replyTo = 0, \(optional)string   $charset = 0, \(optional)string   $type = 0, ) : n/a

Description

Do not use this any more, instead use geoEmail::sendMail()

Arguments

Name Type Description Default
$to string
$subject string
$content string
$from \(optional)string

pass zero for site default

0
$replyTo \(optional)string

pass zero for site default

0
$charset \(optional)string

pass zero for site default

0
$type \(optional)string

HTML, plain text, etc, use zero for site default

0

Return value

Type Description
n/a n/a

Tags

Name Description
deprecated 03/23/2009

set_site_setting( string   $setting, string   $value, bool   $use_long = false, bool   $pushToDb = true, ) : bool

Description

Sets a site config setting. Does NOT check whether we are in admin or not, so that type of check must be done before this function is called.

Arguments

Name Type Description Default
$setting string

The setting name to set

$value string

The value to set the setting to. If false, this will remove that setting from the table.

$use_long bool

Set to true to use the long database if the size is over 255 chars.

false
$pushToDb bool

Set to false and it will not make the change to the setting in the database, so it is effective only for the rest of the page-load. This param added in version 6.0.0

true

Return value

Type Description
bool true if it appears the setting was saved, false otherwise.

tableColumnExists( string   $tableName, string   $columnName, ) : bool

Description

checks to seei f the given table column exists.

Arguments

Name Type Description Default
$tableName string
$columnName string

Return value

Type Description
bool

Tags

Name Description
since Version 5.2.0

tableExists( String   $tableName, ) : Boolean

Description

Checks to see if the given table exists.

Arguments

Name Type Description Default
$tableName String

Return value

Type Description
Boolean true if table exists, false otherwise.

Properties

$geoTables, $old_config_columns,

\geoTables  public  $geoTables =

Instance of {@link geoTables}


array  private  $old_config_columns =

Array of the columns from the old configuration table


Constants

  ADODB_DEBUG = 0

Set this to 1 to use ADODB's built-in debugging, to help optimize stuff. Do NOT ship with this turned on!


  SELECT_BROWSE = 'browse'




  SELECT_FEED = 'feed'




  SELECT_SEARCH = 'search'




  TYPE_BOOL = 'bool'




  TYPE_FLOAT = 'float'




  TYPE_INT = 'int'




  TYPE_STRING = 'string'




  TYPE_STRING_TODB = 'toDB'




geoTable

Properties

 
 
System  
No 
No 

Description

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.

Methods

fetchAll, fetchRow, select,

fetchAll( \geoTableSelect   $select, ) : \geoTableRowset

Description

Get rowset for the select data specified.

Arguments

Name Type Description Default
$select \geoTableSelect

Return value

Type Description
\geoTableRowset

fetchRow( \geoTableSelect   $select, ) : n/a

Description

Not implemented!

Arguments

Name Type Description Default
$select \geoTableSelect

Return value

Type Description
n/a n/a

select( ) : \geoTableSelect

Description

Get a select object specific for this table that can be used to get a result set.

Return value

Type Description
\geoTableSelect

Properties

$_metadata, $_name,

array  protected  $_metadata =

Meta data about the table


string  protected  $_name =

The table name


geoTableRowset

Properties

 
\Iterator
 
System  
No 
No 

Description

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.

Methods

__construct, __toString, current, fetchRow, key, next, rewind, valid,

__construct( \geoTableSelect   $select, ) : n/a

Description

Constructor for geoTableRowset

Arguments

Name Type Description Default
$select \geoTableSelect

Return value

Type Description
n/a n/a

__toString( ) : string

Description

Converts to string for display or whatever

Return value

Type Description
string

current( ) : n/a

Description

(non-PHPdoc)

Return value

Type Description
n/a n/a

Tags

Name Description
see

fetchRow( ) : boolean|Object

Description

Fetch row. Not fully implemented.

Return value

Type Description
boolean|Object

key( ) : n/a

Description

(non-PHPdoc)

Return value

Type Description
n/a n/a

Tags

Name Description
see

next( ) : n/a

Description

(non-PHPdoc)

Return value

Type Description
n/a n/a

Tags

Name Description
see

rewind( ) : n/a

Description

(non-PHPdoc)

Return value

Type Description
n/a n/a

Tags

Name Description
see

valid( ) : n/a

Description

(non-PHPdoc)

Return value

Type Description
n/a n/a

Tags

Name Description
see

geoTableRow

Properties

 
 
System  
No 
No 

Description

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.

Methods

__construct, __toString, save,

__construct( \unknown   $data, ) : n/a

Description

Constructor

Arguments

Name Type Description Default
$data \unknown

Return value

Type Description
n/a n/a

__toString( ) : string

Description

Magic method

Return value

Type Description
string

save( ) : n/a

Description

Not implemented

Return value

Type Description
n/a n/a

geoTableSelect

Properties

 
 
System  
No 
No 

Description

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.

Methods

__construct, __toString, columns, from, getCountQuery, getGroup, getLimit, getOrWhere, getOrder, getTable, getWhere, group, hasGroup, hasLimit, hasOrWhere, hasOrder, hasWhere, join, limit, orWhere, order, where,

__construct( string   $table = null, ) : n/a

Description

Create a new table select object

Arguments

Name Type Description Default
$table string

The table the select is being performed on

null

Return value

Type Description
n/a n/a

__toString( ) : string

Description

Magic method, when object is used as a string, it generates an SQL query according to everything that has been set for the select object.

Return value

Type Description
string Sql query

columns( string|array   $columns, string   $table = null, bool   $reset = false, ) : \geoTableSelect

Description

Add additional columns to be selected for the given table (or main table if no table specified)

Arguments

Name Type Description Default
$columns string|array

A string or array of strings for all the columns to select, additional columns can always be added later using {@see geoTableSelect::columns}, be sure to use empty array if you plan to specify all columns later. Can specify column "AS" by putting alias in array key like array(column_alias => column_name)

$table string

The table name getting the columns for

null
$reset bool

If true, will clear any columns previously set for that table

false

Return value

Type Description
\geoTableSelect Returns itself to allow method chaining

from( string|array   $table, string|array   $columns = '*', ) : \geoTableSelect

Description

Set what table and initial columns to select from

Arguments

Name Type Description Default
$table string|array

Either the string table name, or an associative array like array ($table_alias => $table_name)

$columns string|array

A string or array of strings for all the columns to select, additional columns can always be added later using {@see geoTableSelect::columns}, be sure to use empty array if you plan to specify all columns later. Can specify column "AS" by putting alias in array key like array(column_alias => column_name)

'*'

Return value

Type Description
\geoTableSelect Returns itself to allow method chaining

getCountQuery( ) : \geoTableSelect

Description

Gets a copy of the current query, but altered specifically for getting the count of rows: limit is removed, and the only column it gets is for COUNT(*)

Return value

Type Description
\geoTableSelect

getGroup( ) : array

Description

Gets the full array of "group by" parts of the query

Return value

Type Description
array

Tags

Name Description
since Version 6.0.4

getLimit( ) : array

Description

Gets an array for what the limits are set to.

Return value

Type Description
array

Tags

Name Description
since Version 6.0.4

getOrWhere( string   $name = null, ) : bool|array

Description

Gets the requested named orWhere clause, or all orWhere clauses if no specific name is passed in, or false if requested named clause does not exist.
Useful to make "manipulation" of queries easier.

Arguments

Name Type Description Default
$name string

If specified, the name of a where clause to retrieve

null

Return value

Type Description
bool|array

Tags

Name Description
since Version 6.0.4

getOrder( ) : array

Description

Gets the full array of order by parts added to the query so far.

Return value

Type Description
array

Tags

Name Description
since Version 6.0.4

getTable( ) : string

Description

Gets the main table being used for this query, as passed into $query->from()

Return value

Type Description
string

Tags

Name Description
since Version 6.0.4

getWhere( string   $name = null, ) : bool|string|array

Description

Gets the requested named where clause, or all where clauses if no specific name is passed in, or false if requested named clause does not exist.
Useful to make "manipulation" of queries easier.

Arguments

Name Type Description Default
$name string

If specified, the name of a where clause to retrieve

null

Return value

Type Description
bool|string|array

Tags

Name Description
since Version 6.0.4

group( string   $groupBy, bool   $reset = false, ) : \geoTableSelect

Description

Add something to group by, for example "table_name.column".

Arguments

Name Type Description Default
$groupBy string
$reset bool

If true, will clear any group by's previously set.

false

Return value

Type Description
\geoTableSelect Returns itself to allow method chaining

hasGroup( ) : bool

Description

Whether or not the tableSelect has any where clauses added to it yet, useful to see if something has added a filter to browsing listings for example

Return value

Type Description
bool

Tags

Name Description
since Version 6.0.4

hasLimit( ) : boolean

Description

Whether or not there is a limit currently set on the query.

Return value

Type Description
boolean

Tags

Name Description
since Version 6.0.4

hasOrWhere( ) : bool

Description

Whether or not the tableSelect has any orWhere clauses added to it yet, useful to see if something has added a filter to browsing listings for example

Return value

Type Description
bool

Tags

Name Description
since Version 6.0.4

hasOrder( ) : bool

Description

Whether this table select has any order by's added to it yet.

Return value

Type Description
bool

hasWhere( ) : bool

Description

Whether or not the tableSelect has any where clauses added to it yet, useful to see if something has added a filter to browsing listings for example

Return value

Type Description
bool

join( string|array   $table, string|array   $on, string|array   $columns = array(), string   $joinType = self::JOIN_INNER, bool   $remove = false, ) : \geoTableSelect

Description

Add or replace a table join to the select. If it finds another "join" previously added, using the same table, it will replace that join with the parameters.
This will not have an effect on the "primary" table and will not work to add a join that has a table matching the primary table. Note that "replace" behavior added in version 6.0.6, previously it would add duplicate joined tables and result in database query error.

Arguments

Name Type Description Default
$table string|array

Either the string table name, or an associative array like array ($table_alias => $table_name)

$on string|array

What to use for the ON clause, can be simple string or an array of strings (that will be stuck together using AND)

$columns string|array

A string or array of strings for all the columns to select, additional columns can always be added later using {@see geoTableSelect::columns}, be sure to use empty array if you plan to specify all columns later. Can specify column "AS" by putting alias in array key like array(column_alias => column_name)

array()
$joinType string

The type, use one of geoTableSelect::JOIN_* constants.

self::JOIN_INNER
$remove bool

If true, will remove the joined table (does NOT work on "main" table). Param first working in version 7.1.0

false

Return value

Type Description
\geoTableSelect Returns itself to allow method chaining

limit( int   $var1, int   $var2 = 0, ) : \geoTableSelect

Description

Add limit to select, by specifying the number of rows to return and optionally the row offset. To "remove" a previously added limit, just specify 0 for the count.
If only the first var is passed in and not 0, it is used as the row count limit. If both vars are specified (and not 0), the first is used as the offset and the second is used as the number of rows to return.

Arguments

Name Type Description Default
$var1 int

The count

$var2 int

The offset

0

Return value

Type Description
\geoTableSelect Returns itself to allow method chaining

orWhere( string   $expression, string   $named, bool   $reset = false, ) : n/a

Description

Way to add several things that should be put together using "OR".
.. For instance, could make this call: $query->orWhere('featured_ad=1','featured')->orWhere('featured_ad_2=1','featured'); The above would put all the same "named" OR's together like so: ... AND ((featured_ad=1) OR (featured_ad_2=1)) AND ...

Arguments

Name Type Description Default
$expression string
$named string

Unlike the normal where(), this one is required, in order to tell which "expressions" go together.

$reset bool

(optional) If set to true, will remove any previously added OR statements that use the same named value before adding this new one

false

Return value

Type Description
n/a n/a

order( string   $orderBy, bool   $reset = false, ) : \geoTableSelect

Description

Add something to order by, for example "column ASC".

Arguments

Name Type Description Default
$orderBy string
$reset bool

If true, will clear any orders previously set.

false

Return value

Type Description
\geoTableSelect Returns itself to allow method chaining

where( string   $expression, string   $named = null, ) : \geoTableSelect

Description

Add another check to the WHERE on the table select, something like "var='value'".
This can be called multiple times, each one will be joined together by AND. Note: This does NOT quote the values for you, you must have everything quoted.

Arguments

Name Type Description Default
$expression string
$named string

(Optional) If specified, will use the name given to keep track of the particular where clause, so that it can be changed later, or even removed if needed.

null

Return value

Type Description
\geoTableSelect Returns itself to allow method chaining

Constants

  JOIN_INNER = 'inner'

Use INNER JOIN when joining a table, this is most common type. Pass this in for appropriate var in join() method.


  JOIN_LEFT = 'left'

Use LEFT JOIN when joining a table. Pass this in for appropriate var in join() method.


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.