SACC
[ class tree: SACC ] [ index: SACC ] [ all elements ]

Class: Xbs_SaccSACCAccountHandler

Source Location: /class/SACCAccount.php

Class Overview

CDMBaseHandler
   |
   --Xbs_SaccSACCAccountHandler

Object handler for SACCAccount


Author(s):

  • Ashley Kitson http://xoobs.net

Copyright:

  • (c) 2004 Ashley Kitson, UK

Methods



Class Details

[line 62]
Object handler for SACCAccount



Tags:

copyright:  (c) 2004 Ashley Kitson, UK
author:  Ashley Kitson http://xoobs.net


[ Top ]


Class Methods


constructor Xbs_SaccSACCAccountHandler [line 71]

Xbs_SaccSACCAccountHandler Xbs_SaccSACCAccountHandler( xoopsDatabase &$db)

Function: Constructor



Tags:

version:  1


Parameters:

xoopsDatabase   &$db   Handle to database object

[ Top ]

method create [line 86]

SACCAccount &create( [string $accType = null], [boolean $isNew = true])

Create account object - overide ancestor because we need to know what type of account it is



Tags:

return:  object else FALSE on failure


Parameters:

string   $accType   default null. Type of account to create, SACC_ACTP_INCOME, SACC_ACTP_EXPENSE, SACC_ACTP_ASSET, SACC_ACTP_LIABILITY, SACC_ACTP_BANK, SACC_ACTP_SUPPLIER, SACC_ACTP_CUSTOMER, SACC_ACTP_EQUITY
boolean   $isNew   default TRUE. This is a new account we are creating

[ Top ]

method defunctChildAccounts [line 278]

void defunctChildAccounts( int $account)

Defunct any children of an account that has been defuncted itself



Parameters:

int   $account   SACCAccount object to process

[ Top ]

method getall [line 149]

SACCAccount &getall( int $id, [string $row_flag = null])

function getall - overide ancestor because we need to know account type



Tags:

return:  object on success else FALSE on failure


Parameters:

int   $id   id of account to get
string   $row_flag   default null. Row status flag

[ Top ]

method getSelectList [line 355]

array getSelectList( [int $org_id = 1], [boolean $ignore_prnt_setting = FALSE])

Function: return array of code, value pairs for use in drop down select box



Tags:

return:  array([id]->account name)
version:  1.1


Parameters:

int   $org_id   Id of organisation to get list for
boolean   $ignore_prnt_setting   Ignore the Use parent config setting. This ensures all accounts are included

[ Top ]

method insert [line 298]

void insert( SACCAccount &$account)

Insert data into database - extend ancestor for pre processing



Parameters:

SACCAccount   &$account   Handle to account object

[ Top ]

method loadEntries [line 378]

void loadEntries( SACCAccount &$obj)

function loadEntries - load account entries for the given account



Parameters:

SACCAccount   &$obj   Handle to account object

[ Top ]

method reload [line 199]

SACCAccount reload( SACCAccount &$obj, [int $key = null])

function reload - extend ancestor to add account information



Parameters:

SACCAccount   $obj   handle to account object
int   $key   Accoint id

[ Top ]

method setOrder [line 237]

void setOrder( int $ac_id, int $order)

function setOrder - sets the display order for accounts

Recursive function, will set order for child accounts




Parameters:

int   $ac_id   account id of account to set order for
int   $order   starting order number

[ Top ]

method updateBalances [line 214]

void updateBalances( int $ac_id, [int $ac_dr = 0], [int $ac_cr = 0])

Update the account balance for a given account

Recursive function that will update balances for the parent account




Parameters:

int   $ac_id   account id
int   $ac_dr   debit account balance
int   $ac_cr   credit account balance

[ Top ]

method _get [line 136]

void &_get( mixed $key, [mixed $row_flag = null])

create sql string for getting object data



[ Top ]

method _ins_insert [line 255]

void _ins_insert( mixed $cleanVars)

create sql string for object insert



[ Top ]

method _ins_update [line 267]

void _ins_update( mixed $cleanVars)

create sql string for object update



[ Top ]

method _reload [line 186]

void &_reload( [mixed $key = null])

create sql to reload object data



[ Top ]


Documentation generated on Thu, 23 Feb 2006 13:06:04 +0000 by phpDocumentor 1.3.0RC3