addons/example/util.php

Properties

Description

Optional file. Used for core events. Also a good place to put custom functions that are used by your addon but not used by the addon system directly.

Remember to rename the class name, replacing "example" with the folder name for your addon.

Classes

addon_example_util

Properties

 
 
No 
No 

Description

This is where to put functions that the main part of the addon will use.
Also, if this is attached to any "core events", as defined in info.php, a function for each core event is needed. The requirements of each core event are different, as described by the function specific to that core event. Note that if the core event is not "registered" in {@link addon_example_info::$core_events}, the functions for that core event will not ever get used. We've made it extend the info class so we can get information easily.

Methods

auth_md5_Simple, core_Admin_Group_Management_edit_group_display, core_Admin_Group_Management_edit_group_update, core_Admin_site_display_user_data, core_Admin_user_management_update_users_view, core_Browse_ads_display_browse_result_addHeader, core_Browse_ads_display_browse_result_addRow, core_Browse_ads_generate_query, core_Browse_featured_pic_generate_query, core_Browse_module_display_browse_result_addHeader, core_Browse_module_display_browse_result_addRow, core_Browse_newest_ads_generate_query, core_Browse_tag_display_browse_result_addHeader, core_Browse_tag_display_browse_result_addRow, core_Browse_tag_generate_query, core_Search_classifieds_BuildResults_addHeader, core_Search_classifieds_BuildResults_addRow, core_Search_classifieds_generate_query, core_Search_classifieds_search_form, core_User_management_information_display_user_data, core_User_management_information_display_user_data_plan_information, core_add_listing_icons, core_admin_category_list_specific_icons, core_admin_category_manage_add_links, core_admin_display_page_attachments_edit_end, core_admin_home_display_news, core_admin_update_insert_group, core_auth_admin_display_page, core_auth_admin_login, core_auth_admin_update_page, core_auth_admin_user_login, core_auth_listing_delete, core_auth_listing_edit, core_check_listing_alert, core_cron_close_listings_skip_listing, core_current_listings_add_action_button, core_current_listings_end, core_delete_listing_alert, core_display_add_listing_alert_field, core_display_login_bottom, core_display_registration_code_form_top, core_display_registration_form_top, core_email, core_errorhandle, core_filter_display_image, core_filter_display_page, core_filter_display_page_nocache, core_filter_email, core_filter_geoFilter_listingDescription, core_filter_geoFilter_listingShortenDescription, core_filter_geoFilter_replaceDisallowedHtml, core_filter_listing_placement_category_query, core_filter_ssl_url_checks, core_geoCategory_getListingCount, core_geoFields_getDefaultFields, core_geoFields_getDefaultLocations, core_module_search_box_add_search_fields, core_module_title_add_text, core_module_title_prepend_text, core_my_account_home_add_box, core_my_account_links_add_link, core_notify_Display_ad_display_classified_after_vars_set, core_notify_ListingFeed_generateSql, core_notify_display_page, core_notify_geoListing_remove, core_notify_geoPC_get_hash_types, core_notify_geoTemplate_loadTemplateSets, core_notify_image_insert, core_notify_image_remove, core_notify_modules_preload, core_notify_new_bid_success, core_notify_sold_sign_status_changed, core_notify_user, core_notify_user_remove, core_overload_Browse_ads_display_browse_result, core_overload_Browse_tag_display_browse_result, core_overload_Notify_friend_notify_friend_, core_overload_Notify_friend_notify_friend_sendMail, core_overload_Notify_seller_notify_seller_, core_overload_Notify_seller_notify_seller_sendMail, core_overload_Search_classifieds_BuildResults, core_overload_Site_display_image, core_overload_geoFilter_listingDescription, core_overload_geoFilter_listingShortenDescription, core_overload_geoFilter_replaceDisallowedHtml, core_overload_imagesOrderItem_processImages, core_prevent_new_listing, core_registration_add_field_display, core_registration_add_field_update, core_registration_add_variable, core_registration_check_info, core_rewrite_single_url, core_session_create, core_session_login, core_session_logout, core_session_touch, core_show_listing_alert_filter_data, core_show_listing_alerts_table_body, core_show_listing_alerts_table_headers, core_update_add_listing_alert_field, core_use_listing_icons, core_user_edit, core_user_information_edit_form_check_info, core_user_information_edit_form_display, core_user_information_edit_form_update, core_user_register, getPageId, useAddonRegistryExample,

auth_md5_Simple( string   $username, string   $plaintext_pass, string   $salt, ) : array|string

Description

This method will be called to generate hashed password since we registered a hash type of "md5_Simple" in the function core_notify_geoPC_get_hash_types()
This method is called automatically by the system in order to generate a hashed password. The method name matches what is passed into geoPC::register_hash_type() for the $type (second parameter), pre-fixed with "auth_". In this case it gave type of "md5_Simple" so the method name is auth_md5_Simple

Arguments

Name Type Description Default
$username string

The username, passed since some hash methods use the username to further salt the hash

$plaintext_pass string

The plain-text password

$salt string

The salt, if this hash type uses a salt. If this is passed in empty, you are expected to generate the salt yourself. Otherwise you are expected to use the salt value as-is to generate the password

Return value

Type Description
array|string If using salt, required to return array ('password'=>'hashed value','salt'=>'salt value'), But if salt is not used for this hash, can simply return the hashed value as a string.

Tags

Name Description
Since Geo version 7.1.0

core_Admin_Group_Management_edit_group_display( array   $vars, ) : string

Description

Allows adding more settings on group edit page in the "user group details" section. This is normal string return type, just return the text to add, using normal leftColumn rightColumn classes.

Arguments

Name Type Description Default
$vars array

see source for docs on this.

Return value

Type Description
string

Tags

Name Description
since Geo Version 6.0.0

core_Admin_Group_Management_edit_group_update( array   $vars, ) : n/a

Description

Allows updating settings on group edit page in the "user group details" section. This is called as "notify" type so return value is ignored.

Arguments

Name Type Description Default
$vars array

see source for docs on this.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_Admin_site_display_user_data( int   $user_id, ) : n/a

Description

Way to add stuff to admin panel user account info page.

Arguments

Name Type Description Default
$user_id int

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_Admin_user_management_update_users_view( int   $user_id, ) : n/a

Description

Way to update user info in admin panel for user info page.

Arguments

Name Type Description Default
$user_id int

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_Browse_ads_display_browse_result_addHeader( array   $vars, ) : array

Description

This is return array type of core event. Expected to return an array that will be used to display a header in browsing results. See this method's source for more documentation.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array An array of arrays, See method's source for more documentation.

Tags

Name Description
since Geo Version 4.0.4

core_Browse_ads_display_browse_result_addRow( array   $vars, ) : array

Description

This is return array type of core event. Expected to return array of strings, each string will be inserted into it's own table column. See this method's source for more documentation.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array an array of stuff to display, or false.

Tags

Name Description
since Geo Version 4.0.4

core_Browse_ads_generate_query( array   $vars, ) : n/a

Description

This allows you to get the geoTableSelect query being used for the browse query, and make any changes or additions to it before it is used to get the browse results.
This is an update core event, so the return value is ignored.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.3

core_Browse_featured_pic_generate_query( array   $vars, ) : n/a

Description

This allows you to get the geoTableSelect query being used for the browse query, and make any changes or additions to it before it is used to get the browse results.
This is an update core event, so the return value is ignored.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.3

core_Browse_module_display_browse_result_addHeader( array   $vars, ) : array

Description

This is return array type of core event. Expected to return an array that will be used to display a header in module header. On "featured pic" modules, the text is used as the "label" for the info. See this method's source for more documentation.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array An array of arrays, See method's source for more documentation.

Tags

Name Description
since Geo Version 6.0.0

core_Browse_module_display_browse_result_addRow( array   $vars, ) : array

Description

This is return array type of core event. Expected to return array of strings, each string will be inserted into it's own table column (or line on "featured pic" modules). See this method's source for more documentation.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array an array of stuff to display, or false.

Tags

Name Description
since Geo Version 6.0.0

core_Browse_newest_ads_generate_query( array   $vars, ) : n/a

Description

This allows you to get the geoTableSelect query being used for the browse query, and make any changes or additions to it before it is used to get the browse results.
This is an update core event, so the return value is ignored.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.3

core_Browse_tag_display_browse_result_addHeader( array   $vars, ) : array

Description

This is return array type of core event. Expected to return an array that will be used to display a header in browsing results. See this method's source for more documentation.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array An array of arrays, See method's source for more documentation.

Tags

Name Description
since Geo Version 5.1.0

core_Browse_tag_display_browse_result_addRow( array   $vars, ) : array

Description

This is return array type of core event. Expected to return array of strings, each string will be inserted into it's own table column. See this method's source for more documentation.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array an array of stuff to display, or false.

Tags

Name Description
since Geo Version 5.1.0

core_Browse_tag_generate_query( array   $vars, ) : n/a

Description

This allows you to get the geoTableSelect query being used for the browse query, and make any changes or additions to it before it is used to get the browse results.
This is an update core event, so the return value is ignored.

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.3

core_Search_classifieds_BuildResults_addHeader( array   $vars, ) : array

Description

This is return array type of core event. Expected to return an array that will be used to display a header in search results. See this method's source for more documentation.
Note that an addon can add it's own "search criteria" into the built-in searches, by using this core event along with the core events: - Search_classifieds_search_form - Search_classifieds_generate_query - Search_classifieds_BuildResults_addRow

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array An array of arrays, See method's source for more documentation.

Tags

Name Description
since Geo Version 4.0.4

core_Search_classifieds_BuildResults_addRow( array   $vars, ) : array

Description

This is return array type of core event. Expected to return array of strings, each string will be inserted into it's own table column. See this method's source for more documentation.
Note that an addon can add it's own "search criteria" into the built-in searches, by using this core event along with the core events: - Search_classifieds_search_form - Search_classifieds_generate_query - Search_classifieds_BuildResults_addHeader

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array an array of stuff to display, or false.

Tags

Name Description
since Geo Version 4.0.4

core_Search_classifieds_generate_query( array   $vars, ) : n/a

Description

This allows you to get the geoTableSelect query being used for the search query, and make any changes or additions to it before it is used to get the search results.
This is an update core event, so the return value is ignored. Note that an addon can add it's own "search criteria" into the built-in searches, by using this core event along with the core events: - Search_classifieds_search_form - Search_classifieds_BuildResults_addHeader - Search_classifieds_BuildResults_addRow

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_Search_classifieds_search_form( array   $vars, ) : array

Description

This is return array type of core event. Expected to return array of arrays as documented in this method's source. See this method's source for more documentation.
Note that an addon can add it's own "search criteria" into the built-in searches, by using this core event along with the core events: - Search_classifieds_generate_query - Search_classifieds_BuildResults_addHeader - Search_classifieds_BuildResults_addRow

Arguments

Name Type Description Default
$vars array

Associative array of stuff.

Return value

Type Description
array

Tags

Name Description
since Geo Version 4.0.4

core_User_management_information_display_user_data( ) : array

Description

Used to display info on the "client side" on "my account information" page in the section that displays "my personal information" (rather than at the bottom of the page as core_User_management_information_display_user_data_plan_information does).
Expected to return an associative array with key of 'label' and 'value', with values for the left (label) and right (info) columns respectively.

Return value

Type Description
array See PHP source for working example for this function.

Tags

Name Description
since Geo Version 6.0.0

core_User_management_information_display_user_data_plan_information(   $vars, ) : string

Description

Used to display info on the "client side" on "my account information" page.
This is a "return string" type core event, so will need to return the text to be inserted into the page. It will be displayed somewhere below the price plan info (near the bottom somewhere). See the template for the page at system/user_management/information/user_data.tpl The contents of this will be iserted in that template where you see {$addonPlanInfo} so design the contents to match.

Arguments

Name Type Description Default
$vars n/a

Associative array, see method's source for documentation

Return value

Type Description
string What is to be inserted into the user info page.

Tags

Name Description
since Geo Version 4.0.4

core_add_listing_icons( Array   $data, ) : string

Description

Used to add "listing icons" to a specific listing. Listing icons are the "sold," "reserve met," etc image badges that appear on listings.
See also {@link addon_example_util::core_use_listing_icons()}

Arguments

Name Type Description Default
$data Array

raw listing data for the listing in question

Return value

Type Description
string

core_admin_category_list_specific_icons( array   $category_row, ) : \This

Description

Called for each category being displayed in the admin, to allow adding additional icons showing what is "attached" to the category. Note that even if the category does not have things attached, it should still return each icon that is "possible", with the "active" array key used to signify if the icon should be displayed for the category.
This is so that all the icons will line up, the categories that the icon is not active for it will still show the image but "hidden" so that it is just a blank spot for that category, that way each type of icon lines up vertically in the list of categories.

Arguments

Name Type Description Default
$category_row array

Database row for the category in array format

Return value

Type Description
\This is ARRAY_ARRAY type, expects an array of links, each entry with format of array('title'=>'icon hover title','src'=>'icon/image/url.jpg','active'=>bool), see source of method for further info

Tags

Name Description
since Geo version 7.4.0

core_admin_category_manage_add_links( int   $category_id, ) : \This

Description

Called for the "manage" lightbox in category editing, to allow addons to add their own "category specific" links. For instance, core addon uses this to add browsing filters link.

Arguments

Name Type Description Default
$category_id int

The category ID to create the links for

Return value

Type Description
\This is ARRAY_ARRAY type, expects an array of links, each entry with format of array('href'=>'url','label'=>'link text label')

Tags

Name Description
since Geo version 7.4.0

core_admin_display_page_attachments_edit_end( array   $tpl_vars, ) : n/a

Description

Called at end of designManage::admin_display_page_attachments_edit() This is handy to change the template used when editing attached templates for a specific addon page. The storefront addon uses this since it uses the attachments in a non-traditional way for the "home" page.
This is a notify type of event, the return value is ignored.

Arguments

Name Type Description Default
$tpl_vars array

The template vars that have already been assigned to the view body vars.

Return value

Type Description
n/a n/a

core_admin_home_display_news( ) : string

Description

Used in admin panel home page, to add additional news feeds to the news section. Just return the text to add to the news section.
Note that this is called in an AJAX call.

Return value

Type Description
string Text to add to the news section on the admin home page

Tags

Name Description
since Geo Version 5.1.2

core_admin_update_insert_group( mixed   $vars, ) : n/a

Description

This one is called when a new group is created in the admin.

Arguments

Name Type Description Default
$vars mixed

Associative array of vars passed from original function

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 4.0.4

core_auth_admin_display_page( string   $page_index, ) : Bool|null

Description

Function to determine if given page in the admin can be displayed.
Is also used to determine if a page should be in the menu. This is only called if the user id is NOT 1. If the user_id is 1, all pages can be displayed, and this core event is not called. This is a "return not null" type core event, anything returned that is not null will cause it to not process any other addons and return that as the value.

Arguments

Name Type Description Default
$page_index string

The page's "index", as specified by page=_ in the URL.

Return value

Type Description
Bool|null True, False, or NULL: NULL: Neither allow nor deny access. TRUE: Grant access and do not process any other addons that also use this core event. FALSE: Deny access and do not process any other addons that also use this core event.

core_auth_admin_login( array   $login_data, ) : bool|null

Description

Function to determine if admin can log in. This is used after the user and pass have already been validated, and the user id is NOT 1. If the user_id is 1, it is automatically validated, and this core event is not called.

Arguments

Name Type Description Default
$login_data array

See function contents for details

Return value

Type Description
bool|null should return true, false, or NULL: NULL: Neither allow nor deny access. TRUE: Grant access and do not process any other addons that also use this core event. FALSE: Deny access and do not process any other addons that also use this core event.

core_auth_admin_update_page( string   $page_index, ) : bool|null

Description

Function to determine if given page in the admin can be updated, using the built-in page loading backend that automatically calls update functions.
This is only called if the user id is NOT 1. If the user_id is 1, all pages can be updated, and this core event is not called. NOTE: As of 3.0.1, not all functionality that makes changes in the database use the built-in page loading to call the update function. Such instances will bypass this. In 3.1, all functionality that makes changes in the database should be moved over to use the page loading back end, but until then this core event should not be relied upon solely for making sure no changes can be made to the database.

Arguments

Name Type Description Default
$page_index string

The page's "index", as specified by page=_ in the URL.

Return value

Type Description
bool|null True, False, or NULL: NULL: Neither allow nor deny access. TRUE: Grand access and do not process any other addons that also use this core event. FALSE: Deny access and do not process any other addons that also use this core event.

core_auth_admin_user_login(   $vars, ) : bool|null

Description

Method to determine if the user with specified userId is allowed to use her password to log in as another user on the "client" side, after he has first logged into the admin panel with her "normal" user/pass login.
As with most(all) other auth core events, this is only called if the user is NOT the main admin user with user ID of 1. This is a feature added in 4.1.0 Enterprise editions, if not on 4.1 or not an Enterprise edition this core event will simply not ever get called.

Arguments

Name Type Description Default
$vars n/a

Return value

Type Description
bool|null true, false, or NULL: NULL: Neither allow nor deny access. TRUE: Grant access and do not process any other addons that also use this core event. FALSE: Deny access and do not process any other addons that also use this core event.

Tags

Name Description
since Version 4.1.0

core_auth_listing_delete( NULL   $var, ) : bool|null

Description

Function to determine if current user can delete a listing on the client side. Only used if user_id != 1. If the user_id for current user logged into the client side is 1, the user will always be able to delete listings, and this core event is bypassed.

Arguments

Name Type Description Default
$var NULL

Not used.

Return value

Type Description
bool|null True, False, or NULL: NULL: Neither allow nor deny access. TRUE: Grand access and do not process any other addons that also use this core event. FALSE: Deny access and do not process any other addons that also use this core event.

core_auth_listing_edit(   $var, ) : bool|null

Description

Function to determine if current user can edit a listing on the client side. Only used if user_id != 1. If the user_id for current user logged into the client side is 1, the user will always be able to edit listings, and this core event is bypassed.

Arguments

Name Type Description Default
$var n/a

Return value

Type Description
bool|null True, False, or NULL: NULL: Neither allow nor deny access. TRUE: Grand access and do not process any other addons that also use this core event. FALSE: Deny access and do not process any other addons that also use this core event.

core_check_listing_alert( \unknown_type   $vars, ) : string

Description

Used by "My Listing Filters" to determine whether a filter is matched for a given listing

Arguments

Name Type Description Default
$vars \unknown_type

Return value

Type Description
string one of NO_DATA|MATCH|NO_MATCH

core_cron_close_listings_skip_listing( array   $vars, ) : bool

Description

Used in cron job that closes the listing, at the point before each listing is closed.

Arguments

Name Type Description Default
$vars array

Associative array, see method's source for full documentation.

Return value

Type Description
bool Return true to skip normal closing that is performed for the listing.

Tags

Name Description
since Geo Version 5.1.4

core_current_listings_add_action_button( array   $vars, ) : string

Description

Used on My Active Listings page, to add action buttons.
These are the buttons that appear when a "Manage This Listing" button is clicked.

Arguments

Name Type Description Default
$vars array

Associative array, see method's source for full documentation.

Return value

Type Description
string HTML to insert as a button

core_current_listings_end( ) : n/a

Description

Called at end of My Active Listings page, to allow addons to manipulate page data.

Return value

Type Description
n/a n/a

Tags

Name Description
since 7.0.4

core_delete_listing_alert( int   $filter_id, ) : n/a

Description

Used by "My Listing Filters" to delete data associated with a filter

Arguments

Name Type Description Default
$filter_id int

Return value

Type Description
n/a n/a

core_display_add_listing_alert_field( ) : string

Description

Used by "My Listing Filters" to add addon conditions to filters. Displays HTML for adding a new filter

Return value

Type Description
string

core_display_login_bottom(   $vars, ) : string

Description

Used to display extra stuff at the very bottom of the login form, below all the normal login buttons.

Arguments

Name Type Description Default
$vars n/a

Associative array, see method's source for full documentation.

Return value

Type Description
string Expects to return a string

Tags

Name Description
since Geo Version 6.0.0

core_display_registration_code_form_top( ) : string

Description

Used to display extra stuff at the top of the registration code form page

Return value

Type Description
string Expects to return a string

Tags

Name Description
since Geo Version 6.0.0

core_display_registration_form_top( ) : string

Description

Used to display extra stuff at the top of the registration form page

Return value

Type Description
string Expects to return a string

Tags

Name Description
since Geo Version 6.0.0

core_email( Array   $email_data, ) : n/a

Description

Function called when the system generates an e-mail to be sent out.
If this addon sends an e-mail, the email index in {@link addon_example_info::$exclusive} should be set to true to prevent triggering multiple addons that send e-mails. NOTE: Geo plans to stop using this core event to send e-mails in a future release, instead sending e-mails from the core system files. At that time we may add an "overwrite" type core event to allow an addon to still send e-mails, but at that time the "email" core event will no longer work.

Arguments

Name Type Description Default
$email_data Array

Return value

Type Description
n/a n/a

core_errorhandle( array   $error_data, ) : n/a

Description

Function called when the system generates an error or debug message.
Note that the geo software uses this as a means to trigger debug messages.

Arguments

Name Type Description Default
$error_data array

Return value

Type Description
n/a n/a

core_filter_display_image( string   $image_tag, ) : string

Description

Function called at end of $site_class->display_image. It is passed the image tag and is expected to return the "manipulated" tag.
Note that other addons might manipulate the image tag before or after this function is called in this addon. The addons are called according to their order in the admin.

Arguments

Name Type Description Default
$image_tag string

Return value

Type Description
string Manipulated text for image tag.

core_filter_display_page( String   $full_text, ) : String

Description

Function called at end of $site_class->display_page() (if using db based templates) or as template pre-compile filter, or in chunks for cacheing.
It is passed the full page text and is expected to return "manipulated" text. Note that other addons might manipulate the page text before or after this function is called in this addon. The addons are called according to their order in the admin. Note: Text will probably be sent through in "chunks" and the results may be cached. If you need this to be run for the full page text only, and cannot have the output filtered, use {@link addon_example_util::core_filter_display_page_nocache()} instead.

Arguments

Name Type Description Default
$full_text String

full text of the entire page

Return value

Type Description
String Text for the page to display.

core_filter_display_page_nocache( string   $full_text, ) : string

Description

Function called at end of $site_class->display_page (when using db-based templates) or as template post-filter (if using file based templates) It is passed the full page text and is expected to return "manipulated" text. The output of this addon is not cached.
Note that other addons might manipulate the page text before or after this function is called in this addon. The addons are called according to their order in the admin. Using this instead of the {@link addon_example_util::core_display_page()} core event will potentially slow down page loads. This function is always called when displaying any page, even if the page is not cached. Note that both this, and the normal filter_display_page are both called on each page load, the difference is that the results of this filter is not recorded in the cache system, and that this will be getting the entire page all at once instead of in chunks.

Arguments

Name Type Description Default
$full_text string

full text of the entire page

Return value

Type Description
string Text for the page to display.

Tags

Name Description
since 3.1.0

core_filter_email( array   $email, ) : array

Description

Filter the array of e-mail information right before it is used to send an e-mail. This is called in geoEmail::sendMail() so if that method is bypassed to send the e-mail (not common), this may get bypassed as well.

Arguments

Name Type Description Default
$email array

The array of email information to be filtered.

Return value

Type Description
array the modified / filtered array of e-mail information.

Tags

Name Description
since Geo version 7.0.3

core_filter_geoFilter_listingDescription( string   $desc, ) : string

Description

Function called at end of geoFilter::listingDescription()
Filter the description for display on category browsing pages

Arguments

Name Type Description Default
$desc string

Return value

Type Description
string Filtered text, or original text if no filtering is needed.

Tags

Name Description
since Geo Version 4.0.4

core_filter_geoFilter_listingShortenDescription( string   $desc, ) : string

Description

Function called at end of geoFilter::listingShortenDescription()
Filter the description for display on category browsing pages

Arguments

Name Type Description Default
$desc string

Return value

Type Description
string Filtered text, or original text if no filtering is needed.

Tags

Name Description
since Geo Version 4.0.4

core_filter_geoFilter_replaceDisallowedHtml( string   $html, ) : string

Description

Function called at end of geoFilter::replaceDisallowedHtml()
Filter the HTML

Arguments

Name Type Description Default
$html string

Return value

Type Description
string Filtered text, or original text if no filtering is needed.

Tags

Name Description
since Geo Version 4.0.4

core_filter_listing_placement_category_query( \geoTableSelect   $query, ) : n/a

Description

Allows manipulating the categories shown as options during listing placement.
For instance, for only allowing certain categories based on User Group or some other criteria

Arguments

Name Type Description Default
$query \geoTableSelect

Return value

Type Description
n/a n/a

Tags

Name Description
since GeoCore 7.0.3

core_filter_ssl_url_checks( array|bool   $sslChecks, ) : array|bool

Description

Function called in app_top.main.php - this allows your addon to specify additional "checks" for if the page should be in SSL mode or not, or optionally do it's own checks if there are checks needed that can't be done by looking at the get vars.
Note that this only happens if the admin has turned on the setting "Force SSL URL" in "Site Setup > General Settings" In this case, you are filtering an array of "checks", not a string. Or boolean true if an addon before this one returned true (see below for what this means) The structure of the array is as follows: array ( array ( 'get_key1' => 'get_var', 'get_key2' => 'get_var2' ) array ( 'get_key1' => 'get_var3' ) ) If the above array was returned, that would mean that if the url ends in: ?get_key1=get_var&get_key2=get_var2... OR ?get_key1=get_var3... The above would be considered URL's that need to be viewed in SSL mode. Note that the URL can have additional vars as well, for example the following URL would also match: ?get_key1=get_var3&additional_test=additional_value If a value is set to PHP NULL then that means the var should not be set in the URL at all, for instance: array ('a' => 4, 'b' => null) would mean ?a=4 matches, but NOT ?a=4&b=123 since the b value is set. If you return boolean true, that indicates you did your own checks and your addon says that the current page being viewed should be viewed in SSL mode.

Arguments

Name Type Description Default
$sslChecks array|bool

An array of arrays of checks, as described above, or bool true if another addon used that special case.

Return value

Type Description
array|bool Array following the same structure, with additional checks added, or possibly some of the existing keys altered/removed if desired. OR boolean true if the var passed in is true, or if this addon does it's own checks and says that the current page should be viewed in SSL mode

Tags

Name Description
since Geo Version 4.0.4

core_geoCategory_getListingCount( array   $vars, ) : n/a

Description

Allows addon to manipulate the query that counts how many listings are in a particular category. This is called from {@see geoCategory::getListingCount()} called after the main parts have been added, but before the parts restricting it to classified-only or auction-only count are done, and before it is converted into a "count" query.
This is a notification type event so the return value is ignored.

Arguments

Name Type Description Default
$vars array

See source code for documentation

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo version 6.0.4

core_geoFields_getDefaultFields( array   $vars, ) : array

Description

Mostly used in admin on fields to use page, this allows you to add additional "fields" that can have the same settings as other fields in the fields to use admin panel.
For instance if you wanted to add a new field for "Widget".

Arguments

Name Type Description Default
$vars array

Associative array, see method's source for full documentation.

Return value

Type Description
array An array of fields in the format of method's source.

Tags

Name Description
since Geo Version 5.0.0

core_geoFields_getDefaultLocations( array   $vars, ) : array

Description

Mostly used in admin on fields to use page, this allows you to add additional "display locations" that can be checked or un-checked in the admin panel for each field. For instance if you wanted to add a new location for "Example Pages".

Arguments

Name Type Description Default
$vars array

Associative array, see method's source for full documentation.

Return value

Type Description
array An array of locations in the format of method's source.

Tags

Name Description
since Geo Version 5.0.0

core_module_search_box_add_search_fields( array   $vars, ) : string

Description

Used in module_search_box_1 to allow addons to add additional search criteria to search box.

Arguments

Name Type Description Default
$vars array

See inline PHP comments for documentation

Return value

Type Description
string Text to add to search box search criteria

Tags

Name Description
since Geo Version 5.1.2

core_module_title_add_text( ) : string

Description

Used in module_title to allow addons to add text to the current page's title, as displayed by the title module. Just return the text to add to the page.
Note that if text is returned here, the "default text" that is used on misc. pages would not be used, but other "dynamic" title text would still be displayed, like listing or category title. This text is inserted AFTER that text, but BEFORE the "page number" text if on a 2nd or nth page when browsing categories.

Return value

Type Description
string Text to add to the current page's title that is displayed by the title module.

Tags

Name Description
since Geo Version 5.0.2

core_module_title_prepend_text( ) : string

Description

Used in module_title to allow addons to add text to the current page's title, as displayed by the title module. Just return the text to add to the page.
This one prepends text to front of title.

Return value

Type Description
string Text to add to the current page's title that is displayed by the title module.

Tags

Name Description
since Geo Version 5.1.2

core_my_account_home_add_box(   $vars, ) : array

Description

Used to display info box on the "new" my account home page. That's the one with all the statistic-info-type boxes on it, not the old one with all the my account links in the middle of the page with nothing else.
..

Arguments

Name Type Description Default
$vars n/a

null Nothing is passed in.

Return value

Type Description
array See method's source for documentation.

Tags

Name Description
since Geo Version 4.0.4

core_my_account_links_add_link( array   $vars, ) : array

Description

Use in My Account Links module, to add a link to the my account links.
This is a return array type of core event. Expected to return a "link array" (Associative array as documented in method's source), or can even return an array of "link arrays" if desired.

Arguments

Name Type Description Default
$vars array

Associative array, see method's source for full documentation.

Return value

Type Description
array An array of arras, as documented in method's source.

Tags

Name Description
since Geo Version 4.0.4

core_notify_Display_ad_display_classified_after_vars_set( array   $vars, ) : n/a

Description

This is called when display listing details, right after all the listing template vars are set. This would be a good place to change/remove a specific template var, for instance if you did not want to display a specific bit of info in certain cases.

Arguments

Name Type Description Default
$vars array

An associative array of vars

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 4.0.4

core_notify_ListingFeed_generateSql( \geoListingFeed   $feed, ) : n/a

Description

Called when a listing feed is being generated, right before it uses the SQL query to get the results. This is perfect place to manipulate what listings are displayed by the feed.

Arguments

Name Type Description Default
$feed \geoListingFeed

The feed object this notify call is being called from.

Return value

Type Description
n/a n/a

core_notify_display_page(   $vars, ) : n/a

Description

This one is called when displaying the page, to allow you to edit any template vars in the view class if desired.
NOTE: For manipulating variables on the listing details page, take a look at the core event notify_Display_ad_display_classified_after_vars_set documented at {@link addon_example_util::core_notify_Display_ad_display_classified_after_vars_set()}

Arguments

Name Type Description Default
$vars n/a

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 4.0.4

core_notify_geoListing_remove(   $vars, ) : n/a

Description

This one is called when a listing is being removed, usually the result of a mass-removal, for instance if an entire category is being removed.
Called from {@link geoListing::remove()}

Arguments

Name Type Description Default
$vars n/a

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 5.0.0

core_notify_geoPC_get_hash_types( ) : n/a

Description

Called at the time that the password "hash types" list is being populated.
This notification is the best time to register custom hash types defined by the addon. See the method source for an example of usage.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo version 7.1.0

core_notify_geoTemplate_loadTemplateSets( array   $vars, ) : n/a

Description

This is called from geoTemplate::loadTemplateSets() to allow adding additional template sets to be loaded in addition to those loaded by the t_sets.php file.

Arguments

Name Type Description Default
$vars array

An associative array of vars, see method source for documentation

Return value

Type Description
n/a n/a

core_notify_image_insert( array   $image_info, ) : n/a

Description

Called when an image is being inserted in the database, at the time of insertion which means usually during listing placement, which means before the listing itself is created.

Arguments

Name Type Description Default
$image_info array

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_notify_image_remove( int   $image_id, ) : n/a

Description

Called when an image is being removed from database, which could happen for a number of reasons.

Arguments

Name Type Description Default
$image_id int

The id of the image being removed

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_notify_modules_preload( array   $modules, ) : n/a

Description

This one is called right before the contents of the {head_html} are put together, but right after the modules and addon tags are pre-loaded.
This would be good place to add something to the head of the page, based on if a particular module is loaded on the page or not.

Arguments

Name Type Description Default
$modules array

An array of module tags that were found when pre-loading all the tags that are going to be on the current page.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo version 6.0.2

core_notify_new_bid_success(   $vars, ) : n/a

Description

This one is called when a new bid it inserted in the bids table, in Auction_bid class, in the method insert_into_bid_table.

Arguments

Name Type Description Default
$vars n/a

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_notify_sold_sign_status_changed( array   $vars, ) : n/a

Description

Called when the "sold" status of a classified changes, or when buy-now-only auction is sold out, and the settings are set to mark such auctions as "sold" rather than closing them. In such cases, "is_auction" will be set in the $vars array to easily distinguish when it is a sold-out buy-now-only auction being marked as sold.

Arguments

Name Type Description Default
$vars array

See inline PHP comments for documentation

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 7.0.4

core_notify_user( string   $str, ) : n/a

Description

This is called when one of the geoAdmin::user methods are called, such as geoAdmin::userNotice().

Arguments

Name Type Description Default
$str string

The string that is to be displayed.

Return value

Type Description
n/a n/a

Tags

Name Description
since 3.1.0

core_notify_user_remove( int   $user_id, ) : n/a

Description

Called when a user is being deleted, after all the misc. stuff is removed but before the critical stuff is removed.

Arguments

Name Type Description Default
$user_id int

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_overload_Browse_ads_display_browse_result( Array   $vars, ) : Mixed

Description

Function that overloads the Browse_ads::display_browse_result() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function code source for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return the string geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

core_overload_Browse_tag_display_browse_result( Array   $vars, ) : Mixed

Description

Function that overloads the Browse_tag::display_browse_result() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function code source for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return the string geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

core_overload_Notify_friend_notify_friend_( Array   $vars, ) : Mixed

Description

Function that overloads the Notify_friend::notify_friend_() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return the string geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

core_overload_Notify_friend_notify_friend_sendMail( array   $vars, ) : Mixed

Description

Function that overloads the Notify_friend::notify_friend_() BUT at the point that the e-mail is being sent, not at the beginning. This allows the main built-in functionality to work, but let an addon send the actual e-mail address.

Arguments

Name Type Description Default
$vars array

Associative array of variables that were passed to the function being over-loaded, see the function for more documentation.

Return value

Type Description
Mixed If you want the original function to still continue, return the string geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

Tags

Name Description
since Geo Version 7.3.5

core_overload_Notify_seller_notify_seller_( array   $vars, ) : Mixed

Description

Function that overloads the Notify_seller::notify_seller_() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars array

Associative array of variables that were passed to the function being over-loaded, see the function for more documentation.

Return value

Type Description
Mixed If you want the original function to still continue, return the string geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

core_overload_Notify_seller_notify_seller_sendMail( array   $vars, ) : Mixed

Description

Function that overloads the Notify_seller::notify_seller_() BUT at the point that the e-mail is being sent, not at the beginning. This allows the main built-in functionality to work, but let an addon send the actual e-mail address.

Arguments

Name Type Description Default
$vars array

Associative array of variables that were passed to the function being over-loaded, see the function for more documentation.

Return value

Type Description
Mixed If you want the original function to still continue, return the string geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

Tags

Name Description
since Geo Version 7.3.5

core_overload_Search_classifieds_BuildResults( Array   $vars, ) : Mixed

Description

Function that overloads the Search_classifieds::BuildResults() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function code source for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return the string geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

Tags

Name Description
since Geo Version 4.0.4

core_overload_Site_display_image( Array   $vars, ) : Mixed

Description

Function that overloads the geoImage::display_image() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function code source for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return the string geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

core_overload_geoFilter_listingDescription( Array   $vars, ) : Mixed

Description

Function that overloads the geoFilter::listingDescription() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function code source for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

Tags

Name Description
since Geo Version 4.0.4

core_overload_geoFilter_listingShortenDescription( Array   $vars, ) : Mixed

Description

Function that overloads the geoFilter::listingShortenDescription() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function code source for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

Tags

Name Description
since Geo Version 4.0.4

core_overload_geoFilter_replaceDisallowedHtml( Array   $vars, ) : Mixed

Description

Function that overloads the geoFilter::replaceDisallowedHtml() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function code source for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

Tags

Name Description
since Geo Version 4.0.4

core_overload_imagesOrderItem_processImages( Array   $vars, ) : Mixed

Description

Function that overloads the imagesOrderItem::processImages() function. This function is responsible for performing any tasks that the original function normally does.

Arguments

Name Type Description Default
$vars Array

Associative array of variables that were passed to the function being over-loaded, see the function code source for more details.

Return value

Type Description
Mixed If you want the original function to still continue, return geoAddon::NO_OVERLOAD. Otherwise, return a value like the original function would normally return, to keep the original function from continuing.

Tags

Name Description
since Geo Version 4.0.4

core_prevent_new_listing( Array   $userdata, ) : boolean

Description

Allows an addon to restrict new listing creation based on arbitrary criteria

Arguments

Name Type Description Default
$userdata Array

created by geoUser's toArray() for the current user

Return value

Type Description
boolean true to stop new listing placement | false to allow it to continue

core_registration_add_field_display( array   $registered_variables, ) : array

Description

This is called when the registration form is being displayed, and allows an addon to add additional fields to be displayed on the registration form.

Arguments

Name Type Description Default
$registered_variables array

The registered vars set in the registration class.

Return value

Type Description
array See method's inline comments for expected array

Tags

Name Description
since Geo Version 4.0.9

core_registration_add_field_update( array   $vars, ) : n/a

Description

This is a notify type core event, to allow saving of user input registration information. This can be called in 3 different scenarios, either inserting user into the DB directly (the user ID will be specified), inserting into the registration waiting approval, or moving from waiting approval to user data (registration approved)

Arguments

Name Type Description Default
$vars array

See comments in method's source

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 4.0.9

core_registration_add_variable( array   $user_input, ) : array

Description

Allow setting of "registered_variables" according to post params (user input), so that they can be accessed later when saving the data.

Arguments

Name Type Description Default
$user_input array

Return value

Type Description
array See comments in method's source

Tags

Name Description
since Geo Version 4.0.9

core_registration_check_info( array   $vars, ) : n/a

Description

Allow checking info submitted during registration and "adding errors" as is documented in the PHP comments in this method in-line. This is a notify core event, return value is ignored, errors are added directly to the register class.

Arguments

Name Type Description Default
$vars array

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 4.1.0

core_rewrite_single_url( Array   $vars, ) : String

Description

Allows rewriting a single URL (typically via the SEO addon)

Arguments

Name Type Description Default
$vars Array

Return value

Type Description
String

core_session_create( string   $session_id, ) : n/a

Description

This is called when a new session is created. This is done in addition to, NOT instead of the normal session handling procedures. It is called once the session creation process is finished. Note that nothing is expected to be returned.

Arguments

Name Type Description Default
$session_id string

The session ID for the new session.

Return value

Type Description
n/a n/a

core_session_login( string   $vars, ) : n/a

Description

This is called when a user logs in. This is done in addition to, NOT instead of the normal session handling procedures. It is called once the session login process is finished. Note that nothing is expected to be returned.

Arguments

Name Type Description Default
$vars string

An associative array containing the username and plain-text password.

Return value

Type Description
n/a n/a

core_session_logout( mixed   $vars, ) : n/a

Description

This is called when a user logs out. This is done in addition to, NOT instead of the normal session handling procedures. It is called once the session logout process is finished. Note that nothing is expected to be returned.

Arguments

Name Type Description Default
$vars mixed

An associative array containing the username

Return value

Type Description
n/a n/a

core_session_touch( string   $session_id, ) : n/a

Description

This is called when a session is touched, meaning the user has accessed a page. This is done in addition to, NOT instead of the normal session handling procedures. It is called once the session touch process is finished. Note that nothing is expected to be returned.

Arguments

Name Type Description Default
$session_id string

The session ID for the new session.

Return value

Type Description
n/a n/a

core_show_listing_alert_filter_data( int   $filter_id, ) : string

Description

Used by "My Listing Filters" as a convenience method for obtaining email-friendly result text.

Arguments

Name Type Description Default
$filter_id int

Return value

Type Description
string

core_show_listing_alerts_table_body( int   $filter_id, ) : string

Description

Used by "My Listing Filters" to add addon conditions to filters. Returns body text for a specific filter on "show all filters" page

Arguments

Name Type Description Default
$filter_id int

ID of filter to return info for

Return value

Type Description
string

core_show_listing_alerts_table_headers( ) : string

Description

Used by "My Listing Filters" to add addon conditions to filters. Returns column header for "show all filters" page

Return value

Type Description
string

core_update_add_listing_alert_field( Array   $vars, ) : n/a

Description

Used by "My Listing Filters" to add addon conditions to filters. Processes form data when adding a new filter

Arguments

Name Type Description Default
$vars Array

Return value

Type Description
n/a n/a

core_use_listing_icons( ) : boolean

Description

Returns true if an addon has "listing icons" to show. Listing icons are the "sold," "reserve met," etc image badges that appear on listings

Return value

Type Description
boolean

core_user_edit( mixed   $vars, ) : n/a

Description

This is called when a user's info is changed.
This is done in addition to, NOT instead of the normal procedures. It is called once the changes are already made. Note that nothing is expected to be returned.

Arguments

Name Type Description Default
$vars mixed

An associative array containing changed user's data

Return value

Type Description
n/a n/a

core_user_information_edit_form_check_info(   $vars, ) : n/a

Description

Check any field values that may have been changed that were displayed by the user_information_edit_form_display core event. This is called as an update core event, meaning the return value is ignored. Typically if there is a problem with the fields, it would add an error like it does in the function that calls this.

Arguments

Name Type Description Default
$vars n/a

Vars passed in, as documented in source code of this method.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 7.3.0

core_user_information_edit_form_display(   $vars, ) : array

Description

Used to display info on the "client side" on "my account information - edit" page in the section that allows editing "my personal information"
Expected to return an associative array, or even an array of arrays for multiple fields, with each field having keys as specified below, note that only 'label' and 'value' are required, rest are optional: label : label of the field value : the value (such as the input text HTML tag to allow editing) error : if there is error with the field required : set to true if field required type : if set to "single_checkbox" will display single checkbox

Arguments

Name Type Description Default
$vars n/a

Vars passed in, as documented in source code of this method.

Return value

Type Description
array See PHP source for working example for this function.

Tags

Name Description
since Geo Version 6.0.0

core_user_information_edit_form_update(   $vars, ) : n/a

Description

Save any field values that may have been changed that were displayed by the user_information_edit_form_display core event. This is called as an update core event, meaning the return value is ignored.

Arguments

Name Type Description Default
$vars n/a

Vars passed in, as documented in source code of this method.

Return value

Type Description
n/a n/a

Tags

Name Description
since Geo Version 6.0.0

core_user_register( mixed   $vars, ) : n/a

Description

This is called when a new user registers or is created by the admin.
This is done in addition to, NOT instead of the normal procedures. It is called once the registration process is finished and the user is activated. Note that nothing is expected to be returned.

Arguments

Name Type Description Default
$vars mixed

An associative array containing new users data

Return value

Type Description
n/a n/a

getPageId( string   $pageName, ) : string

Description

This function actually does something. It's used by our eWidget order item to get the page id to use.

Arguments

Name Type Description Default
$pageName string

Return value

Type Description
string

useAddonRegistryExample( ) : n/a

Description

This is an example of how to use addon settings using an addon registry
It doesn't really do anything..

Return value

Type Description
n/a n/a
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.