Welcome!

This documentation was generated by phpDocumentor 2.0.0a12. Note that the PHPDoc generator used is currently in alpha status (the generator is in ALPHA status, NOT the GeoCore software itself), so some things may not work properly, such as links within descriptions and things like that.

Also note that phpDocumentor 2.0.0a12 is maintained by phpdoc.org, we only use the tool to generate API documentation that may be useful to some 3rd party developers. If you have any development related questions not answered here or in the user manual, contact support.

Namespaces

  • global
    • 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.
    • 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.
    • 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.
    • addon_example_tags
      Expects one function for each tag.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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 so that old locations that use the old name geoTables will still work.
    • 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.
    • geoUtil
      Misc utility functions
    • geoView
      As the name implies, this is used for creating the page view.
    • 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 to hold database table names, used throughout the code.

Packages

  • Default
    • ExampleAddon
    • 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.
      • 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.
      • 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.
      • 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.
      • 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 so that old locations that use the old name geoTables will still work.
      • 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.
      • geoUtil
        Misc utility functions
      • geoView
        As the name implies, this is used for creating the page view.
      • 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 to hold database table names, used throughout the code.