classes/php5_classes/Transaction.class.php

Properties

Description

This holds the geoTransaction class.

Classes

geoTransaction

Properties

 
 
System  
No 
No 

Description

This is the object used for a transaction in the order and invoice system.
A transaction will be assigned to an invoice, that invoice will be assigned to an order that the invoice is "paying" for. There will be many transactions to one invoice. Since this is an object that represents a single transaction in the system, there can be many instances of it. If you are creating a new transaction, you would start off by creating a new geoTransaction object, then assigning settings for it. A transaction with a negative "amount" means it is a charge, that is what is "owed" from the "buyer" to the seller (which in most cases will be the "site"). A positive amount represents a payment from the "buyer" to the "seller" (seller and buyer are set for the invoice that the transaction is attached to)

Methods

__construct, get, getAmount, getDate, getDescription, getGateway, getGatewayTransaction, getId, getInvoice, getRecurringBilling, getStatus, getTransaction, getUser, remove, save, serialize, set, setAmount, setDate, setDescription, setGateway, setGatewayTransaction, setId, setInvoice, setRecurringBilling, setStatus, setUser, touch, unSerialize,

__construct( ) : n/a

Description

Constructor, sets up stuff

Return value

Type Description
n/a n/a

get( string   $item, mixed   $default = false, ) : Mixed

Description

Gets the specified item from the registry, or if item is one of the "main" items it gets that instead.

Arguments

Name Type Description Default
$item string
$default mixed

What to return if the item is not set.

false

Return value

Type Description
Mixed the specified item, or false if item is not found.

getAmount( ) : double

Description

Get the amount for this transaction

Return value

Type Description
double

getDate( ) : int

Description

Get the date for this transaction

Return value

Type Description
int unix timestamp

getDescription( ) : string

Description

Get the description for this transaction

Return value

Type Description
string

getGateway( ) : \geoPaymentGateway

Description

Get the gateway object for this transaction

Return value

Type Description
\geoPaymentGateway

getGatewayTransaction( ) : string

Description

Can be used by gateways, to have an easily searchable field that goes with the transaction id that the gateway expects.
Max length is 255, but if a gatway needs a longer ID length it can store the first 255 chars here to be able to do a quick search, then store the full transaction id in the registry as trans_id_full or something.

Return value

Type Description
string

getId( ) : int

Description

Get the ID for this transaction. Returns 0 if this is a new transaction w/o an ID yet.

Return value

Type Description
int

getInvoice( ) : \geoInvoice|null

Description

Gets the invoice object that this transaction is attached to, or null if not attached to anything

Return value

Type Description
\geoInvoice|null

getRecurringBilling( ) : \geoRecurringBilling|null

Description

Gets the recurringBilling object that this transaction is attached to, or null if not attached to recurringBilling

Return value

Type Description
\geoRecurringBilling|null

Tags

Name Description
since Version 4.1.0

getStatus( ) : int

Description

Returns status of invoice, either 1 for status is cool, 0 for "do not apply to invoice yet"

Return value

Type Description
int

getTransaction( int|string   $identify = 0, ) : \geoTransaction

Description

Gets the transaction specified by the ID and returns the geoTransaction object for that transaction, or a new blank transaction item if the id is 0 or not a valid ID.

Arguments

Name Type Description Default
$identify int|string

Either int for ID of transaction, or string for gateway_transaction match instead. If 0 or invalid, Object returned is for a new blank transaction.

0

Return value

Type Description
\geoTransaction

getUser( ) : int

Description

Get the user (id) for this transaction, or 0 if created by system.

Return value

Type Description
int

remove( int   $id, ) : n/a

Description

Static function that removes a transaction as specified by ID.

Arguments

Name Type Description Default
$id int

Return value

Type Description
n/a n/a

save( ) : n/a

Description

Alias of geoTransaction::serialize() - see that method for details.

Return value

Type Description
n/a n/a

serialize( ) : n/a

Description

Serializes the current transaction (saves changes in the database, or creates new transaction if the id is not set. If it is a new transaction, it will set the transaction ID after it has been inserted into the database.
Also automatically serializes any objects attached to it that are not already serialized, for instance the registry object attached to this transaction.

Return value

Type Description
n/a n/a

set( string   $item, mixed   $value, ) : n/a

Description

Sets the given item to the given value. If item is one of built-in items, it sets that instead of something from the registry.

Arguments

Name Type Description Default
$item string
$value mixed

Return value

Type Description
n/a n/a

setAmount( double   $amount, ) : n/a

Description

Set the amount for this transaction

Arguments

Name Type Description Default
$amount double

Return value

Type Description
n/a n/a

setDate( int   $timestamp, ) : n/a

Description

Set the date for this transaction

Arguments

Name Type Description Default
$timestamp int

unix timestamp

Return value

Type Description
n/a n/a

setDescription( string   $description, ) : n/a

Description

Set the description for this transaction

Arguments

Name Type Description Default
$description string

Return value

Type Description
n/a n/a

setGateway( \geoPaymentGateway|string   $paymentGateway, ) : n/a

Description

Set the gateway used for this transaction.

Arguments

Name Type Description Default
$paymentGateway \geoPaymentGateway|string

Either the payment gateway object, or the payment gateway's unique name identifier.

Return value

Type Description
n/a n/a

setGatewayTransaction( string   $value, ) : n/a

Description

Can be used by gateways, to have an easily searchable field that goes with the transaction id that the gateway expects.
Max length is 255, but if a gatway needs a longer ID length it can store the first 255 chars here to be able to do a quick search, then store the full transaction id in the registry as trans_id_full or something.

Arguments

Name Type Description Default
$value string

Return value

Type Description
n/a n/a

setId( int   $val, ) : n/a

Description

Set the ID for this transaction. Only used internally.

Arguments

Name Type Description Default
$val int

Return value

Type Description
n/a n/a

setInvoice( \geoInvoice|int   $invoice, ) : n/a

Description

Sets the invoice this transaction is attached to, can be attached to object or by invoice ID.

Arguments

Name Type Description Default
$invoice \geoInvoice|int

Either the invoice object, or the invoice ID.

Return value

Type Description
n/a n/a

setRecurringBilling( \geoRecurringBilling|int   $recurringBilling, ) : n/a

Description

Sets the recurring billing object this transaction is attached to, can be attached to object or by recurring billing ID.

Arguments

Name Type Description Default
$recurringBilling \geoRecurringBilling|int

Either the recurring billing object, or the recurring billing ID.

Return value

Type Description
n/a n/a

Tags

Name Description
since Version 4.1.0

setStatus( int   $status, ) : n/a

Description

Sets status of invoice, either 1 for status is cool, 0 for "do not apply to invoice yet"

Arguments

Name Type Description Default
$status int

Either a 1 or 0, this is only an on/off status.

Return value

Type Description
n/a n/a

setUser( int   $userId, ) : n/a

Description

Set the user (id) for this transaction (0 if created by system)

Arguments

Name Type Description Default
$userId int

Return value

Type Description
n/a n/a

touch( ) : n/a

Description

Use when this object, or one of it's child objects, has been changed, so that when it is serialized, it will know there are changes that need to be serialized.
This also recursevly touches all "parent" objects that this one is attached to. Note that this is automatically called internally when any of the set functions are used.

Return value

Type Description
n/a n/a

unSerialize( int|string   $id = 0, ) : n/a

Description

Unserializes the object for the given ID and applies parameters to this object.

Arguments

Name Type Description Default
$id int|string

Either the id for the transaction, or the gatewayTransaction string.

0

Return value

Type Description
n/a n/a

Properties

$_pendingChanges, $registry, $status, $transactions,

boolean  private  $_pendingChanges =

Used internally to remember whether there has been changes to the order since it was last serialized. If there is not changes, when serialize is called, nothing will be done.


\geoRegistry  private  $registry =

The registry


int  private  $status =

Status of transaction. Either 1 for verified, or 0 for "do not apply to invoice yet".


array  private  static $transactions =

Array of all the transactions retrieved for page load


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.