classes/php5_classes/SellerBuyer.class.php

Properties

Description

This is the main "back end system" for the seller/buyer payment gateways.

Classes

geoSellerBuyer

Properties

 
 
System  
No 
No 

Description

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.
This is actually the first class that started using callDisplay and callUpdate type functions, at least in the way they are used today. Since this is the first one, it is a little more primitive than "new" stuff like payment gateways or order items, but it does what it needs to do just fine.

Methods

__construct, callDisplay, callUpdate, getCartItemSetting, getCurrencySetting, getInstance, getListingSetting, getPlanSetting, getUserSetting, initTableStructure, loadTypes, setCartItemSetting, setCurrencySetting, setDefaultPlanSettings, setListingSetting, setPlanSetting, setUserSetting,

__construct( ) : n/a

Description

Use geoSellerBuyer::getInstance(), not new geoSellerBuyer.

Return value

Type Description
n/a n/a

callDisplay( string   $call_name, mixed   $vars = null, string   $separator = '', ) : mixed

Description

Calls the specified update function for all of the seller/buyer types, and seperates the returned responses from each of the order items by $seperater
IMPORTANT: This leaves it up to each seller/buyer type to make sure that type is turned on and all that, and that input is cleaned. NOTE: Unlike geoOrderItem or geoPaymentGateway callDisplay functions, this calls the function NON-Statically (meaning $item->call_name($vars) instead of Item::call_name($vars). In other words, it works more like triggerDisplay() for an addon core event.

Arguments

Name Type Description Default
$call_name string
$vars mixed null
$separator string

What string to use as glue, or one of these special cases: "array": return results of each in an array "bool_true": if any return true, then return true. otherwise return false. (strict match) "bool_false": if any return false, then return false. otherwise return true. (strict match)

''

Return value

Type Description
mixed Usually a string of each result seperated by seperater, or if seperater is special case, returns whatever that special case is for.

callUpdate( string   $call_name, mixed   $vars = null, ) : n/a

Description

Calls the specified update function for all of the seller/buyer types.
IMPORTANT: This leaves it up to each seller/buyer type to make sure that type is turned on and all that, and that input is cleaned. NOTE: Unlike geoOrderItem or geoPaymentGateway callUpdate functions, this calls the function NON-Statically (meaning $item->call_name($vars) instead of Item::call_name($vars), kind of like geoAddon::triggerUpdate() works for core events.

Arguments

Name Type Description Default
$call_name string
$vars mixed null

Return value

Type Description
n/a n/a

getCartItemSetting( string   $setting, mixed   $default_value = false, ) : mixed

Description

Gets a setting for the current main item in the cart right now.

Arguments

Name Type Description Default
$setting string

The setting to get.

$default_value mixed

If the setting is not found for the given listing ID, this is what is returned (default is false).

false

Return value

Type Description
mixed The setting asked for.

getCurrencySetting( int   $currency_type_id, string   $setting, mixed   $default_value = null, ) : mixed

Description

Gets a setting for the price plan/category.

Arguments

Name Type Description Default
$currency_type_id int
$setting string

The setting to get.

$default_value mixed

If the setting is not found for the given listing ID, this is what is returned (default is null).

null

Return value

Type Description
mixed The setting asked for.

Tags

Name Description
since Version 6.0.0

getInstance( ) : \geoSellerBuyer

Description

Gets an instance of geoSellerBuyer

Return value

Type Description
\geoSellerBuyer

getListingSetting( int   $listing_id, string   $setting, mixed   $default_value = false, ) : mixed

Description

Gets a setting for the given listing.

Arguments

Name Type Description Default
$listing_id int

The listing ID to get the setting for.

$setting string

The setting to get.

$default_value mixed

If the setting is not found for the given listing ID, this is what is returned (default is false).

false

Return value

Type Description
mixed The setting asked for.

getPlanSetting( int   $price_plan_id = 0, int   $category = 0, string   $setting, mixed   $default_value = false,   $forceCat = false, ) : mixed

Description

Gets a setting for the price plan/category.

Arguments

Name Type Description Default
$price_plan_id int 0
$category int

The category ID (or 0 for not category specific)

0
$setting string

The setting to get.

$default_value mixed

If the setting is not found for the given listing ID, this is what is returned (default is false).

false
$forceCat n/a false

Return value

Type Description
mixed The setting asked for.

getUserSetting( int   $user_id, string   $setting, mixed   $default_value = false, ) : mixed

Description

Gets a setting for the given user.

Arguments

Name Type Description Default
$user_id int
$setting string

The setting to get.

$default_value mixed

If the setting is not found for the given listing ID, this is what is returned (default is false).

false

Return value

Type Description
mixed The setting asked for.

initTableStructure( ) : n/a

Description

Initializes the needed table structure changes, that way only sites that use the feature will use this.

Return value

Type Description
n/a n/a

loadTypes( string   $dirname = '', ) : n/a

Description

Loads all of the seller-buyer objects into an array.

Arguments

Name Type Description Default
$dirname string

Leave this blank, used internally to recursively load types from different folders.

''

Return value

Type Description
n/a n/a

setCartItemSetting( string   $setting, mixed   $value, ) : n/a

Description

Set a setting on the current "main item" that is in the cart. If no cart item is currently initialized, will not set anything.

Arguments

Name Type Description Default
$setting string

The setting to set.

$value mixed

The value to set, can be a string, int, or array, although use of array is discourages for large arrays as it will take up a lot more space in the DB.

Return value

Type Description
n/a n/a

setCurrencySetting( int   $currency_type_id, string   $setting, mixed   $value, ) : n/a

Description

Set setting for specific currency type.

Arguments

Name Type Description Default
$currency_type_id int
$setting string
$value mixed

Return value

Type Description
n/a n/a

Tags

Name Description
since Version 6.0.0

setDefaultPlanSettings( int   $price_plan_id = 0, int   $category = 0, array   $settings, ) : n/a

Description

Sets an array of default settings for the given price plan and category.

Arguments

Name Type Description Default
$price_plan_id int 0
$category int 0
$settings array

An associative array of settings to be set for the given price plan and category.

Return value

Type Description
n/a n/a

setListingSetting( int   $listing_id, string   $setting, mixed   $value, ) : n/a

Description

Set a setting for a specific listing, useful for instance, to set whether a certain listing is using a particular payment type.

Arguments

Name Type Description Default
$listing_id int
$setting string

The setting name to be set.

$value mixed

The value to set, can be a string, int, or array, although use of array is discourages for large arrays as it will take up a lot more space in the DB.

Return value

Type Description
n/a n/a

setPlanSetting( int   $price_plan_id = 0, int   $category = 0, string   $setting, mixed   $value, ) : n/a

Description

Set a setting for a specific price plan and category, usually used in admin.

Arguments

Name Type Description Default
$price_plan_id int

The price plan ID.

0
$category int

The category ID.

0
$setting string

The setting name to be set.

$value mixed

The value to set, can be a string, int, or array, although use of array is discourages for large arrays as it will take up a lot more space in the DB.

Return value

Type Description
n/a n/a

setUserSetting( int   $user_id, string   $setting, mixed   $value, ) : n/a

Description

Set a setting for a specific user, for instance a setting needed to know who to send money to (like the paypal ID)

Arguments

Name Type Description Default
$user_id int
$setting string

The setting name to be set.

$value mixed

The value to set, can be a string, int, or array, although use of array is discourages for large arrays as it will take up a lot more space in the DB.

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.