560
enuuk Auction platform tutorial At this tutorial you will have related info about: - Installation - Multiligual - adding new languages - CSS - enuuk Auction platform REST web services - Technical documentation We are preparing a more complete tutorial including Administrator manual. It will be available soon. Thanks for your cooperation.

Manual

Embed Size (px)

Citation preview

Page 1: Manual

enuuk Auction platform tutorial

At this tutorial you will have related info about:- Installation- Multiligual - adding new languages- CSS- enuuk Auction platform REST web services- Technical documentation

We are preparing a more complete tutorial including Administrator manual. It will be available soon.Thanks for your cooperation.

Page 2: Manual

Installationenuuk Auction platform should be installed using the enuuk platform installer

1.1 Installation script1.1.1 Setting upOnce you have purchased and downloaded your enuuk Auction platform, extract orunzip the archive into the directory on your web server in which you want to placeyour auction site.

Remember to check your server requirements:http://www.phpauction.net/server-requirements

The installation script will check your server compatibility.

PermissionsBefore running the enuuk platform installer you will need to give permissions to thefollowing files and directories.

Files can be in the hosting root folder (the main one which contains httpdocs orpublic_html or web or www) or a subdirectory which you installation could be residingsuch as # /home/yoursite/public_html/auctions/

* chmod 777 /uploaded* chmod 777 config.php

1.1.2 Running Enuuk platform installerBefore you start with your installation confirm you have the following info:· DatabaseDatabase host name, username & password, database name.

Step 1Point to www.yourdomain.com/install. This is the enuuk platform installer welcomescreen.

Step 2The enuuk platform installer will perform pre-installation checks on server settingsrequirements. After verification and if everything is correct click in the Next button.

If you incur in an error at this stage, make the necessary changes. After, click the buttonstating that you have made the corrections. If everything is correct, you can proceedby clicking the Next button.

Step 3The enuuk platform installer will perform pre-installation checks on files writablerequirements. After verification and if everything is correct click in the Next button.

If you incur in an error at this stage, make the necessary changes. After, click the buttonstating that you have made the corrections. If everything is correct, you can proceedby clicking the Next button.

You have to manually create the database, username and password. Once they arecreated fill the correspondent fields in this form.

Step 4enuuk platform installer will setup some generally used options for your site:

Page 3: Manual

* Site Name* Language* From email account* Admin email account

Step 5enuuk platform installer will setup the administrator's configuration* Admin login* Admin password* Base country

The platform is installed. Login at the front end with the administrtor info and accessthe admin back-end. You can configure now your auction site.

Note: Remember to rename your installation script after it is installed for security.

Page 4: Manual

Enuuk platform design documentation

Enuuk platform web design is based on template PHP files and CSS styles.Customizing the look and feel will depend on your html, CSS and design skills.

This document will give you the basic guide to understand the structure of thephp files and the CSS styles used in enuuk platform. Also how the theme selection toolbehaviors so you can create or edit your themes.

Theme selectionTo facilitate the look & feel customization, enuuk platform has a Theme Selectionfeature. This feature allows to select some themes available in the package.

By default enuuk platform includes 1 design with 5 colors variation. The design isnamed enuukColor and the color variation by default is enuuk logo color scheme.Each color variation is considered one theme.

The themes must be placed in the /themes folder. The theme selected by default is:Default. Each theme is grouped in a folder with the name. As an example:- enuukBlue- enuukGreenThe theme folder has the CSS style file and the php files if necessary.

There are 2 CSS files: styles and color- styles.css contains the general information about the site structure: columns, text, etc.- color.css contains color information.

The php can be included in the theme folder but is not necessary if they are not modifiedfrom the default theme. In that case the package will use the default template but withthe CSS style defined in the theme. Normally to edit the look & feel the usual modifiedfiles are the ones related to header, footer and index.

You can add as many themes as you want in this features and select them in theadmin back-end.

PHP filesAs explained, template php files are used to define each page. These files can bemodified for a theme, so in that case you should have the modified file in the themefolder. We highly recommend to always using a copy to modify the templates andleave the default theme as a base for future designs or as a backup.

The structure of each enuuk platform website page is the following:- Header- Content PHP file- Footer

Each page contains the header and the footer and it’s the same for all of them.

The header file (header.php) is the first file read by the browser and contains all theopening tags for the html page such as <html>, <header>, <body>, etc. It has all theinfo display in each page header such as logo, counters, menu bar, etc.

The content PHP file contains the information displayed between the header and the

Page 5: Manual

footer. All of them are related to the URL display at the browser. As an example for theregistration, the URL display at the browser is:Http://www.yourauction.com/user/register, the php file related is userForm.php.The footer file includes the footer displayed at every page. In this file you close all htmltags for the html page.

CSS stylesThe styles use in enuuk platform are contained in the files style.css and color.css ofthe selected theme. As we have mentioned before, we only recommend editing themif you have the necessary skills to edit them.This is the list of the principal styles. You can edit and add new ones as desired.- Clear: Used to clear a floating layout, usually inside an empty DIV in this manner: <div class=”clear”></div>- c1 through c23: Used to make column-based layouts. Any container is divided in 24 imaginary columns, which can be used to make up space. For example: <div class=”c6”>this DIV would occupy the 25% of the width</div> <div class=”c18 cLast”>this one would occupy the other 75%</div>- cLast: Each row of columns must be ended with this class in order for it to display correctly. Moreover, a clearing DIV is mandatory after the cLast. <div class=”c6”>First column</div> <div class=”c12”>Second column</div> <div class=”c6 cLast”>Third and last column</div> <div class=”clear”></div>- p1 through p23: Used to push a column element to the right.- fullBox: Makes a 10 pixel padding all around an element. Do NOT use on any of the c1-23 classed elements.- hBox: Makes a 10-pixel padding to the left and right of an element. Do NOT use on any of the c1-23 classed elements.- vBox: Makes a 10-pixel padding to the top and bottom of an element.- inlineList: Only for UL and OL. Makes a list of inline LI, putting a border between each one.- indentList: Only for UL and OL. Create a list of LI with bullets for decoration.

Page 6: Manual

Multilngual feature -

Adding new languagesTo add new languages to your auction site please follow the next steps.

For text display at the site:1. Add the language at the admin back-end at:

Set up / Languages

Remember to follow the Languages and locations standards, using RFC4646 codes(based on ISO-639), such as "es-MX" (Spanish spoken in Mexico), "en" (general English)or "ca-va" (Catalan variant named Valencian)

More info at:http://www.ietf.org/rfc/rfc4646.txthttp://www.iana.org/assignments/language-subtag-registry

2. Duplicate any of the languages files available at locale/ folder on your installation

3. Rename it for the new language using the language standards

4. Perform the translation using a gettext catalogs application. We recommend PoEdit:

http://www.poedit.net/Poedit is cross-platform gettext catalogs (.po files) editor. It is built with wxWidgetstoolkit and can run on any platform supported by it (although it was only tested onUnix with GTK+ and Windows). It aims to provide more convenient approach to editingcatalogs than launching vi and editing the file by hand.

Open the .po file of the new language. It will be a copy of the one selected with theprimary language (English) and the secondary selected. Translate the secondarylanguage.

5. Upload the new language folder with all its content.

EmailsMail texts are now in files (themes/mails/*.txt). Perform the translation.

Modifying default textTo modiy the english default text, you will have to modify it directly at the php file.Open the correspondent file and search the text you want to modify. It is mandatoryto keep the structure and modify exclusive the text <?= _('Home') ?>. Next time youopen the extra languages with poEdit remember to first update them.

ProblemsSometimes it happens. Usually, if you want to transtate enuuk Auction platform to anon common language, or your server is does not have installed your language, youcan even get this error trying to change the default language.

How to solve this?Ask your server admin (or support) to actually check the installed languages in theserver (tell him they are located in /usr/lib/locale and can display them withlocale -a). The new language will not be in the list, so he has to manually add it,with locale-gen shell order.

Page 7: Manual

enuuk Auction platform REST web services

Virtually all pages in enuukAuction platform provide different ways to display data. Bydefault HTML is returned after a user request, using a HTML template filled with thereturned data. But there are other formats to get the processed data, and these formatscan even be extended easily.

Suppose, for instance, the following REST request:

In this case you are calling the search page, with a "keyword" as parameter.By default HTML is returned, but you can change the format just adding a "v" parameter,like:

This returns the same dynamic data, but in PHP (serialized) format.

Currently, the following formats are implemented in all pages:- HTML : by default if no "v" parameter is defined. Uses HTML templates.- PHP : serialized PHP data- JSON : Javascript notation (you need PHP 5.2 in your server, or PECL json moduleloaded)- Echo : just flush out data using PHP's var_dump

In the next weeks we expect to deploy: pure XML (all pages), and RSS (main pages)formats.

As input for the request, GET or POST can be used. The system process all requestparameters (Get, Post and Cookies) the same way.

Technically speaking, the code responsible for generating those formats is located inthe files of class/View/. Adding a new file tailored to your needs can be easily done bya proficient programmer painless. For example, using v=Echo for reference, he canprepare a new View to filter the data he needs to import to other system.

Page 8: Manual

enuuk Auction

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 9: Manual

Contents

Package migrator Procedural Elements 2Migrator.php 2

Package migrator Classes 3Class Migrator 3

Var $countryMapper 3Var $idToNick 3Var $message 4Var $newDB 4Var $newPrefix 4Var $oldDB 4Var $oldPrefix 5Method connectToDB 5Method convertToDate 5Method createCountryMapper 6Method getMessage 6Method migrate 6Method migrateAuctions 7Method migrateCategories 7Method migrateUsers 7

Package upgrader Procedural Elements 9Upgrader.php 9

Package upgrader Classes 10Class Upgrader 10

Var $DB 10Var $message 10Var $versions 11Constructor __construct 11Method detectVersion 11Method getMessage 11Method lastVersion 11Method update 12Method update10to11 12Method update11to12 12Method update12to13 12Method update13to14 12Method update14to15 13Method update15to16 13Method update16to17 13Method update17to18 13Method update18to20 13

Package utils Procedural Elements 15Date.php 15

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 10: Manual

DB.php 16Error.php 17GoogleCheckout.php 18MailNotificator.php 19String.php 20SystemInspector.php 21SystemInstaller.php 22

Package utils Classes 23Class Date 23

Method check 23Method invertDate 23Method javascriptFormated 24Method secondsDifference 24Method showTimeDifference 25Method toLocaleLongString 25Method toLocaleShortString 25Method yearDifference 26

Class DB 26Var $db 26Method createArrayFromDBResult 27Method getInstance 27

Class Error 28Class Constant BY_CODE 28Class Constant BY_UNKNOWN 28Class Constant BY_USER 28

Class GoogleCheckout 28Class Constant BIDPACKFEE 28Class Constant DB_TABLE 28Class Constant DIRECTPAY 29Class Constant FINALFEE 29Class Constant INVOICE 29Class Constant OTHERFEE 29Class Constant RELISTINGFEE 29Class Constant SIGNUPFEE 29Class Constant STOREFEE 29Var $_cart 29Var $_country 29Var $_currency 30Var $_lang 30Var $_merchantId 30Var $_merchantKey 30Var $_serverType 30Constructor __construct 31Method configureOptions 31Method getOrderDataFromDB 32Method __get 32Method __set 32

Class MailNotificator 33Class Constant AUCTIONMAIL 33

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 11: Manual

Class Constant AUCTIONMAIL_FIXED 33Class Constant AUCTIONMAIL_LOT 33Class Constant AUCTIONMAIL_REVERSE 33Class Constant FILE_PATH 33Class Constant MAIL_BID 34Class Constant MAIL_BUY_FIXED_BUYER 34Class Constant MAIL_BUY_FIXED_SELLER 34Class Constant MAIL_BUY_LOT_BUYER 34Class Constant MAIL_BUY_LOT_SELLER 34Class Constant MAIL_DUE_FEE 34Class Constant MAIL_ENDAUCTION_BIDDER 34Class Constant MAIL_ENDAUCTION_NOWINNER 34Class Constant MAIL_ENDAUCTION_WINNER 35Class Constant MAIL_INVOICE 35Class Constant MAIL_MESSAGE 35Class Constant MAIL_NO_LONGER_LEAD_BIDDER 35Class Constant MAIL_OFFER_ANSWER 35Class Constant MAIL_OFFER_QUESTION 35Class Constant NEWPASSWD 35Class Constant REGISTRATION_MAIL 36Class Constant USERMAIL_APPROVED 36Var $errorMessage 36Var $hasError 36Var $language 36Var $_emailBody 36Var $_emailSubject 37Method getData 37Method reFormatString 37Method send 38Method sendOneMail 38Method __get 39

Class MyPDO 39Var $count 39Method exec 39Method prepare 40Method query 40

Class String 40Method camelize 41Method isEmail 41

Class SystemInspector 42Var $errorMessage 42Var $isInstallable 42Var $systemRequirements 42Method verifyGD 43Method verifyGettext 43Method verifyLinux 43Method verifyModRW 43Method verifyPDO 43Method verifyPdoMysql 44

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 12: Manual

Method verifyPHP 44Method verifyRewriteEngine 44Method verifySPLClasses 45Method verifySystem 45

Class SystemInstaller 45Class Constant GENERAL_OPTIONS_TABLE 45Class Constant LANGUAGE_TABLE 45Var $configFile 46Var $configPath 46Var $dbConfig 46Var $dbSqlScript 46Var $errorMessage 47Var $hasError 47Var $pdoErrorMessage 47Constructor __construct 47Method constructDB 48Method createAdmin 48Method getDBConfig 48Method getLanguageName 48Method getSiteLanguages 49Method installDB 49Method setConfigPath 49Method setSQLScript 50Method setUpSiteOptions 50Method verifyDatabaseConfig 50Method verifyDB 51Method verifySTR 51

Package Views Procedural Elements 53CSV.php 53Echo.php 54HTML.php 55JSON.php 56PHP.php 57Rss.php 58

Package Views Classes 59Class View_CSV 59

Method display 59Class View_Echo 59

Method display 60Class View_HTML 60

Method display 60Method setContext 61

Class View_JSON 61Method array2json 61Method display 62Method jsEncode 62

Class View_PHP 62Method display 62

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 13: Manual

Class View_Rss 63Method display 63

Package enuukAuction Procedural Elements 65ResponseHandler.php 65config.php 66

Define TABLE_PREFIX 66index.php 67

Function handleException 67Function __autoload 68

install.php 69migration.php 70

Package enuukAuction Classes 71Class ResponseHandler 71

Class Constant DB_TABLE 71Class Constant RESPONSE_HANDLER_ERROR_LOG_FILE 71Class Constant RESPONSE_HANDLER_LOG_FILE 71Var $_currency 71Var $_data 72Var $_gRequest 72Var $_gResponse 72Var $_itemName 72Var $_merchantId 72Var $_merchantKey 73Var $_root 73Var $_serverType 73Var $_status 73Var $_xmlResponse 73Constructor __construct 74Method gcOrderStateChange 74Method getData 74Method getDirectFeeStatus 75Method getGoogleOrderNumber 75Method getId 75Method getInvoiceStatus 76Method getItemName 76Method getPaymentType 76Method newOrderNotification 76Method processResponse 77Method updateInvoice 77Method __get 77Method __set 78

Package Action Procedural Elements 80Admin.php 80BidPack.php 81StoreSize.php 82BidPack.php 83Category.php 84CustomPage.php 85

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 14: Manual

Fee.php 86Index.php 87Invoicepay.php 88Message.php 89Offer.php 90PaypalDirectPay.php 91ResponseHandler.php 92Search.php 93Store.php 94User.php 95UserPayMethod.php 96

Package Action Classes 97Class Action_Admin 97

Method defaultAction 97Method verifyLoggedAdmin 97

Class Action_Admin_BidPack 98Method activate 98Method add 98Method deactivate 98Method defaultAction 98Method delete 99Method edit 99Method initialBids 99

Class Action_Admin_StoreSize 99Method changeStatus 100Method defaultAction 100Method doEdit 100Method processStoreSizeForm 100Method verifyOptionalParameters 101

Class Action_BidPack 101Method buy 101Method defaultAction 101

Class Action_Category 102Method defaultAction 102

Class Action_CustomPage 102Method defaultAction 103Method initPage 103Method initThematic 103

Class Action_Fee 104Method defaultAction 104

Class Action_Index 104Method defaultAction 104

Class Action_Invoicepay 105Method defaultAction 105Method paypalCancel 105Method paypalNotify 105Method paypalPay 106Method paypalReturn 106

Class Action_Message 106

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 15: Manual

Method compose 106Method defaultAction 107Method delete 107Method deleteAll 107Method mark 108Method markAll 108Method submit 108Method view 108

Class Action_Offer 109Method add 109Method calculateFees 110Method copyAuction 110Method defaultAction 110Method delete 110Method details 111Method draftOffers 111Method edit 111Method fees 112Method isLoggedUserASeller 112Method processOfferForm 112Method publishOffer 112Method qa 113Method wanted 113

Class Action_PaypalDirectPay 113Method defaultAction 114Method paypalCancel 114Method paypalCancelOther 114Method paypalNotify 114Method paypalNotifyOther 114Method paypalPay 115Method paypalReturn 115Method paypalReturnOther 115

Class Action_ResponseHandler 116Method defaultAction 116Method googleCheckoutReturn 116Method offerDetails 116

Class Action_Search 117Method defaultAction 117

Class Action_Store 117Method calculateFees 118Method category 118Method create 118Method defaultAction 119Method delete 119Method details 119Method edit 119Method fees 120Method isLoggedUserASeller 120Method processStoreForm 120

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 16: Manual

Method testStore 120Class Action_User 121

Method activeOffers 121Method bids 121Method bulkUpload 122Method closedOffers 122Method configureSellerGoogleCheckoutOptions 122Method configureSellerPaypalOptions 123Method confirm 123Method defaultAction 123Method draftOffers 124Method edit 124Method favourites 124Method invoice 124Method invoiceDetails 125Method leftFeedback 125Method login 125Method logout 125Method profile 126Method receivedFeedback 126Method recoverPassword 126Method register 126Method soldItems 127Method userFees 127Method verifyUserParameters 127Method welcome 127Method wonAuctions 128

Class Action_UserPayMethod 128Method defaultAction 128

Package Action_Admin Procedural Elements 130Banner.php 130Category.php 131Country.php 132Currency.php 133CustomAuctionFields.php 134CustomFields.php 135CustomPages.php 136Fee.php 137Index.php 138Invoices.php 139Offers.php 140PayMethod.php 141Settings.php 142Store.php 143Thematics.php 144User.php 145

Package Action_Admin Classes 146Class Action_Admin_Banner 146

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 17: Manual

Method activation 146Method add 146Method changeStatus 146Method defaultAction 147Method deleteBanner 147Method editBanner 147Method processBannerForm 147

Class Action_Admin_Category 148Method add 148Method defaultAction 148Method delete 148Method edit 149Method order 149Method special 149Method verifyOptionalParams 149Method verifyParameters 150

Class Action_Admin_Country 150Method activate 150Method deactivate 150Method defaultAction 151Method edit 151

Class Action_Admin_Currency 151Method add 151Method defaultAction 151Method edit 152

Class Action_Admin_CustomAuctionFields 152Method activate 152Method add 152Method defaultAction 152Method delete 153Method edit 153Method suspend 153Method verifyOptionalParams 153

Class Action_Admin_CustomFields 154Method activate 154Method add 154Method defaultAction 154Method delete 154Method edit 155Method suspend 155Method verifyOptionalParams 155Method verifyParameters 155

Class Action_Admin_CustomPages 156Method activate 156Method add 156Method defaultAction 157Method delete 157Method edit 157Method maxListedPages 157

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 18: Manual

Method suspend 157Method verifyOptionalParams 158Method verifyParameters 158

Class Action_Admin_Fee 158Method activate 159Method defaultAction 159Method details 159Method feeLangEdit 159Method feeLangList 159Method general 160Method suspend 160Method verifyOptionalParams 160

Class Action_Admin_Index 160Method defaultAction 161

Class Action_Admin_Invoices 161Method defaultAction 161Method deleteInvoice 161Method headerFooter 161Method invoiceDetails 162Method paymentType 162Method resendInvoice 162Method sendInvoices 162Method sentInvoices 163Method settings 163Method updateStatus 163Method verifyHeaderFooter 163Method verifyInvoiceSettings 163

Class Action_Admin_Offers 164Method activate 164Method auctionAutoExtension 164Method bidIncrementSetting 164Method deactivate 165Method defaultAction 165Method delete 165Method edit 165Method processOfferForm 165Method publishOffer 166Method types 166

Class Action_Admin_PayMethod 166Method activate 166Method add 167Method deactivate 167Method defaultAction 167Method delete 167Method edit 167Method verifyOptionalParams 167

Class Action_Admin_Settings 168Method addLanguage 168Method addThisSetting 168

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 19: Manual

Method auctionRelisting 169Method bannerSettings 169Method captchaSetting 169Method defaultAction 169Method defaultCurrency 169Method defaultLanguage 170Method editLanguage 170Method feedbackSetting 170Method googleAnalytics 170Method homeRefresh 170Method imageGallerySetting 171Method itemsListing 171Method languages 171Method maxImageUploadSize 171Method metaTags 171Method paypalSettings 172Method signupConfirmation 172Method siteDesign 172Method sslSetting 172Method timezone 172Method verifyBannerSettings 173Method verifyLanguageParams 173Method verifyMetaTags 173

Class Action_Admin_Store 174Method defaultAction 174Method doActivate 174Method doDeactivate 174Method doDelete 175

Class Action_Admin_Thematics 175Method activate 175Method add 176Method defaultAction 176Method delete 176Method edit 176Method suspend 176Method verifyOptionalParams 177Method verifyParameters 177

Class Action_Admin_User 177Method activate 178Method ban 178Method bannedEmails 178Method bids 178Method defaultAction 178Method delete 179Method deleteConfirm 179Method displayUserOffers 179Method edit 179Method feedback 179Method filter 180

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 20: Manual

Method invoice 180Method invoiceDetails 180Method newUserType 180Method offers 181Method search 181Method suspend 181Method suspendConfirm 181Method unban 181Method verifyCustomParameters 182Method verifyUserParameters 182Method viewip 182

Package Core Procedural Elements 184Action.php 184Context.php 185Controller.php 186View.php 187

Package Core Classes 188Class Core_Action 188

Var $context 188Var $db 188Var $requestedMethod 189Constructor __construct 189Method defaultAction 189Method filterInputStrings 189Method getContext 190Method preprocessContext 190Method run 190Method setContext 191Method verifyLoggedUser 191Method __destruct 191

Class Core_Context 191Var $_data 192Var $_errorMessage 192Var $_HTTPHost 192Var $_language 193Var $_loggedUser 193Var $_message 193Var $_parameters 194Var $_relativePath 194Var $_siteOptions 194Var $_status 194Constructor __construct 195Method addData 195Method toArray 195Method __get 195Method __set 196

Class Core_Controller 196Var $_actionToCall 197

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 21: Manual

Var $_context 197Var $_viewToCall 197Constructor __construct 197Method getParameters 198Method processParameters 198Method run 198Method verifyInputAgainstHacks 199

Class Core_View 199Var $context 199Method display 200Method setContext 200

Package general Procedural Elements 202BannedEmail.php 202Banner.php 203Bid.php 204BidIncrement.php 205BidPack.php 206Category.php 207PresentationData.php 208Country.php 209Cron.php 210Currency.php 211CustomField.php 212CustomOfferField.php 213CustomPage.php 214DBReadable.php 215DBSearchable.php 216DBWritable.php 217Favourite.php 218Fee.php 219FeeRangeContainer.php 220FixedAuction.php 221Image.php 222Invoice.php 223Item.php 224Language.php 225LotAuction.php 226Message.php 227MetaTag.php 228Offer.php 229OffersQuestion.php 230PayMethod.php 231Paypal.php 232PennyAuction.php 233ReverseAuction.php 234SiteOptions.php 235StandardAuction.php 236Store.php 237StoreSize.php 238

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 22: Manual

Thematic.php 239Timezone.php 240User.php 241UserFeedback.php 242UserPayMethod.php 243

Package general Classes 244Class BannedEmail 244

Class Constant DB_TABLE 244Var $_email 244Method deleteFromDB 244Method getInstanceFromDB 245Method getListFromDB 245Method saveToDB 245Method __get 246Method __set 246

Class Banner 246Class Constant BANNER_HTML 247Class Constant BANNER_IMAGE 247Class Constant DB_TABLE 247Var $_active 247Var $_bannerHTML 247Var $_id 247Var $_image 247Var $_type 248Var $_url 248Constructor __construct 248Method deleteFromDB 248Method getBanner 248Method getInstanceFromDB 249Method getListFromDB 249Method saveToDB 249Method validURL 250Method __get 250Method __set 250

Class Bid 251Class Constant DB_TABLE 251Var $comment 251Var $date 251Var $id 251Var $offer 252Var $user 252Var $value 252Constructor __construct 252Method deleteFromDB 252Method getInstanceFromDB 253Method getListFromDB 253Method saveToDB 253Method __get 254Method __set 254

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 23: Manual

Class BidIncrement 254Class Constant DB_TABLE 255Var $_bottom 255Var $_id 255Var $_increment 255Var $_ranges 255Var $_top 256Method addIncrementRange 256Method getBidIncrement 256Method getInstanceFromDB 256Method getListFromDB 257Method rangeValueExists 257Method saveToDB 257Method __get 258Method __set 258

Class BidPack 258Class Constant DB_TABLE 259Var $_active 259Var $_id 259Var $_number 259Var $_price 259Method deleteFromDB 260Method getInstanceFromDB 260Method getListFromDB 260Method saveToDB 261Method __get 261Method __set 261

Class Category 262Class Constant CAT_LANG_TABLE 262Class Constant DB_TABLE 262Class Constant ORDER_ALPHABETICALLY 262Class Constant ORDER_MANUALLY 262Class Constant ORDER_MAX_OFFERS 262Class Constant ORDER_MAX_SPECIAL 262Class Constant ORDER_SPECIAL 262Class Constant ORDER_SPECIAL_ALPHA 262Class Constant ORDER_SPECIAL_MANUALLY 262Var $cachedCategories 263Var $cachedCategoriesLang 263Var $_active 263Var $_id 263Var $_name 264Var $_order 264Var $_parent 264Var $_special 264Constructor __construct 264Method addName 265Method deleteFromDB 265Method discoverCatId 265

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 24: Manual

Method discoverId 266Method getCachedCategories 266Method getCachedCategoriesLang 266Method getInstanceFromDB 267Method getListFromDB 267Method getName 267Method getOrderedListFromDB 268Method getParentAndChildID 268Method getSortedListFromDB 268Method getSubcatsFromDB 269Method hasSubcats 269Method makeCatBreadCrumb 270Method saveToDB 270Method __get 270Method __set 271

Class Core_PresentationData 271Method getCustomPagesData 271Method getData 272Method getGoogleAnalyticsCode 272Method getLanguageDirection 272Method getLanguages 273Method getMetaInfo 273Method getStatistics 273

Class Country 274Class Constant DB_TABLE 274Var $_active 274Var $_id 274Var $_name 275Method getInstanceFromDB 275Method getListFromDB 275Method getListOfCountriesWithUsers 275Method saveToDB 276Method __get 276Method __set 276

Class Cron 277Method closeExpiredOffers 277Method openDatePendingOffers 277Method relistOffers 278Method run 278

Class Currency 278Class Constant DB_TABLE 279Var $_id 279Var $_name 279Method getConverterURL 279Method getInstanceFromDB 280Method getListFromDB 280Method saveToDB 280Method __get 280Method __set 281

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 25: Manual

Class CustomField 281Class Constant DB_LANGUAGE_TABLE 281Class Constant DB_TABLE 281Class Constant TYPE_INPUT 282Class Constant TYPE_TEXTAREA 282Var $_active 282Var $_id 282Var $_mandatory 282Var $_name 283Var $_showInProfile 283Var $_type 283Constructor __construct 283Method addName 283Method deleteFromDB 284Method fieldExists 284Method getInstanceFromDB 284Method getListFromDB 285Method getName 285Method isActive 285Method saveToDB 286Method __get 286Method __set 286

Class CustomOfferField 287Class Constant DB_LANGUAGE_TABLE 287Class Constant DB_TABLE 287Var $_active 287Var $_id 287Var $_mandatory 288Var $_name 288Var $_showInAuctionDetails 288Var $_type 288Constructor __construct 289Method addName 289Method deleteFromDB 289Method fieldExists 289Method getInstanceFromDB 290Method getListFromDB 290Method getName 290Method isActive 291Method saveToDB 291Method __get 291Method __set 292

Class CustomPage 292Class Constant CUSTOM_PAGE_LANGUAGE_TABLE 292Class Constant DB_TABLE 293Var $_active 293Var $_date 293Var $_id 293Var $_text 293

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 26: Manual

Var $_thematicId 294Var $_title 294Constructor __construct 294Method addText 294Method addTitle 294Method deleteFromDB 295Method discoverId 295Method getInstanceFromDB 295Method getListFromDB 296Method getText 296Method getTitle 296Method pageExists 297Method saveToDB 297Method __get 297Method __set 298

Class DBReadable 298Method getInstanceFromDB 298Method getListFromDB 299

Class DBSearchable 299Method discoverId 300

Class DBWritable 300Method saveToDB 300

Class Favourite 301Class Constant DB_TABLE 301Class Constant TYPE_OFFER 301Class Constant TYPE_STORE 301Class Constant TYPE_USER 301Var $_focusId 301Var $_id 302Var $_offers 302Var $_type 302Var $_user 302Method deleteFromDB 303Method getFavouriteOffers 303Method getInstanceFromDB 303Method getListFromDB 304Method saveToDB 304Method __get 304Method __set 304

Class Fee 305Class Constant BIDPACKFEE 305Class Constant DB_TABLE 305Class Constant DIRECT_FEE 305Class Constant FEES_LANG_TABLE 305Class Constant FEES_RANGE_TABLE 306Class Constant FEES_USERS_TABLE 306Class Constant FEE_NOTPAID 306Class Constant FEE_PAID 306Class Constant FEE_PAYMENT_IN_PROCESS 306

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 27: Manual

Class Constant FINALFEE 306Class Constant FROZEN_TABLE 306Class Constant INVOICE_FEE 306Class Constant OTEHR_FEE 306Class Constant RELISTING_FEE 306Class Constant SIGNUP_FEE 306Class Constant STOREFEE 306Var $_action 306Var $_active 307Var $_baseField 307Var $_chargeAtCreation 307Var $_description 307Var $_feeRangeContainer 307Var $_fixed 308Var $_title 308Method chargeFee 308Method freeze 309Method getBidPackFeeData 309Method getDescription 309Method getFeeList 310Method getInstanceFromDB 310Method getListForOffer 311Method getListForStore 311Method getListFromDB 311Method getTitle 312Method getUserFee 312Method listFrozenFromDB 312Method removeBidPackFee 313Method removeStoreFee 313Method removeUserFee 314Method saveToDB 314Method setDescription 314Method setTitle 315Method simulateFee 315Method updateBidPackFeeStatus 315Method updateFeeStatus 316Method updateStoreFeeStatus 316Method updateUserFeeStatus 316Method __get 317Method __set 317

Class FeeRangeContainer 318Class Constant DB_TABLE 318Var $_action 318Var $_endRange 318Var $_feeRange 319Var $_startRange 319Method addRange 319Method getAllCharges 319Method getFixedCharge 320

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 28: Manual

Method getInstanceFromDB 320Method getListFromDB 321Method getPercentCharge 321Method saveToDB 321Method valueExistsInRange 322Method __get 322Method __set 322

Class FixedAuction 323Constructor __construct 323Method calculateNextBid 323Method finishOffer 323Method getBidButtonText 323Method getExtendedDataFromDB 324Method getInstanceFromDB 324Method getListFromDB 324Method getListOnOneCategory 325Method getWinners 325Method makeBid 325Method removeUserBids 325Method saveToDB 326Method type 326Method typeName 326Method __get 326Method __set 327

Class Image 327Class Constant DB_TABLE 327Class Constant DEFAULT_IMAGE_ID 327Class Constant UPLOAD_PATH 327Var $id 327Var $references 328Var $size 328Var $url 328Constructor __construct 328Method copyAsNewImage 328Method createImage 329Method createNewName 329Method deletefromDB 329Method deleteFromDBOnly 330Method doUpload 330Method getInstanceFromDB 330Method getListFromDB 331Method isRemoteFile 331Method removeFile 331Method renameFile 332Method saveToDB 332Method uploadFile 332Method uploadRemoteFile 333Method validFile 333Method __get 333

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 29: Manual

Method __set 334Class Invoice 334

Class Constant DB_TABLE 334Class Constant DIRECTPAY 335Class Constant INVOICE 335Class Constant INVOICE_LINES_TABLE 335Class Constant NOT_PAID 335Class Constant PAID 335Class Constant PAYMENT_PENDING 335Class Constant PAYMENT_VERIFIED 335Class Constant PENDING 335Class Constant SENT 335Var $_adminMail 335Var $_date 336Var $_defaultCurrency 336Var $_defaultLanguage 336Var $_fromMail 336Var $_id 336Var $_invoiceCopyToAdmin 337Var $_invoiceFooter 337Var $_invoiceHeader 337Var $_invoiceLimit 337Var $_invoiceLines 337Var $_invoiceTaxName 338Var $_invoiceTaxPercent 338Var $_siteName 338Var $_status 338Var $_tax 338Var $_total 339Var $_user 339Var $_userEmail 339Var $_userId 339Constructor __construct 339Method calculateTotal 340Method createMail 340Method deleteFromDB 340Method generateInvoice 340Method getInstanceFromDB 341Method getInvoiceLinesFromDB 341Method getListFromDB 342Method getStatsFromDB 342Method saveToDB 342Method sendInvoices 343Method sendMail 343Method sendOneInvoice 343Method updateInvoiceStatus 344Method __get 344Method __set 344

Class Item 345

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 30: Manual

Class Constant DB_TABLE 345Class Constant ITEM_IMAGES_TABLE 345Var $description 345Var $id 346Var $image 346Var $images 346Var $name 346Var $user 346Var $youtubeVideo 347Constructor __construct 347Method addImage 347Method copyItem 347Method deleteFromDB 348Method deleteImage 348Method emptyImages 348Method getInstanceFromDB 348Method getItemImages 349Method getListFromDB 349Method imageExist 349Method saveToDB 350Method verifyYoutubeVideo 350Method __get 350Method __set 351

Class Language 351Class Constant DB_TABLE 351Var $_active 351Var $_id 352Var $_name 352Var $_orientation 352Constructor __construct 352Method changeLanguage 352Method deteleFromDB 353Method getInstanceFromDB 353Method getListFromDB 353Method languageAvailable 354Method localeInit 354Method saveToDB 355Method __get 355Method __set 355

Class LotAuction 356Class Constant DB_TABLE 356Var $quantity 356Constructor __construct 356Method calculateNextBid 356Method finishOffer 357Method getBidButtonText 357Method getExtendedDataFromDB 357Method getInstanceFromDB 357Method getListFromDB 358

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 31: Manual

Method getOffersWon 358Method getQuantity 358Method getWinners 359Method makeBid 359Method removeUserBids 359Method saveToDB 359Method type 360Method typeName 360Method __get 360Method __set 360

Class Message 361Class Constant ALL_MESSAGES 361Class Constant DB_TABLE 361Class Constant READ_MESSAGES 361Class Constant SENT_MESSAGES 361Class Constant UNREAD_MESSAGES 361Class Constant VISIBLE_BOTH 361Class Constant VISIBLE_RECEIVER 361Class Constant VISIBLE_SENDER 362Var $_fromUser 362Var $_id 362Var $_message 362Var $_messageTime 362Var $_status 362Var $_subject 363Var $_toUser 363Var $_visibility 363Constructor __construct 363Method deleteFromDB 363Method deleteMessage 364Method getInstanceFromDB 364Method getListFromDB 364Method listInboxMessages 365Method listMessages 365Method listSentMessages 366Method readMessage 366Method saveToDB 366Method updateStatus 367Method __get 367Method __set 367

Class MetaTag 368Class Constant DB_TABLE 368Var $_id 368Var $_languageId 368Var $_metaDescription 369Var $_metaKeywords 369Method getInstanceFromDB 369Method getListFromDB 369Method saveToDB 370

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 32: Manual

Method __get 370Method __set 370

Class Offer 371Class Constant DB_TABLE 371Class Constant FIXED_PRICE 371Class Constant LOT 371Class Constant OFFERS_CATEGORIES_TABLE 371Class Constant OFFERS_CUSTOM_FIELD_TABLE 371Class Constant OFFERS_PAYMETHODS_TABLE 371Class Constant OFFERS_TYPES_TABLE 371Class Constant PENNY 371Class Constant REVERSE 371Class Constant SHIP_CONDITIONS_BUYER 372Class Constant SHIP_CONDITIONS_SELLER 372Class Constant STANDARD 372Var $active 372Var $bids 372Var $categories 372Var $currentPrice 372Var $customFields 373Var $datePending 373Var $draft 373Var $endDate 373Var $featured 373Var $file 374Var $fileSize 374Var $id 374Var $inWebstore 374Var $item 374Var $payMethods 375Var $relisting 375Var $shipConditions 375Var $shipCosts 375Var $shipInternational 375Var $shipTerms 376Var $startDate 376Var $startPrice 376Var $types 376Var $views 376Var $winner 377Constructor __construct 377Method addFieldValue 377Method calculateNextBid 377Method copyAsDraft 378Method deleteFromDB 378Method discoverId 378Method finishOffer 379Method getBidButtonText 379Method getCustomOfferData 379

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 33: Manual

Method getExtendedDataFromDB 379Method getFieldValue 380Method getInstance 380Method getInstanceFromDB 380Method getListForThisParent 381Method getListForThisParentInStore 381Method getListFromDB 382Method getListOnOneCategory 382Method getOfferCount 382Method getStatsFromDB 383Method getTypesFromDB 383Method getUserBuyers 383Method getUserSells 384Method getWinners 384Method makeBid 384Method relist 385Method removeUserBids 385Method saveToDB 385Method type 386Method typeName 386Method updateTypesToDB 386Method __get 386Method __set 387

Class OffersQuestion 387Class Constant DB_TABLE 387Var $_answer 388Var $_date 388Var $_id 388Var $_offerId 388Var $_question 389Var $_user 389Constructor __construct 389Method getInstanceFromDB 389Method getListFromDB 389Method questionExists 390Method saveToDB 390Method __get 390Method __set 391

Class PayMethod 391Class Constant DB_TABLE 391Class Constant LANG_TABLE 391Var $active 391Var $gatewayId 392Var $id 392Var $isGateway 392Var $name 392Constructor __construct 392Method addName 393Method deleteFromDB 393

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 34: Manual

Method discoverId 393Method getInstanceFromDB 394Method getListFromDB 394Method getName 394Method saveToDB 395Method __get 395Method __set 395

Class Paypal 396Class Constant DB_TABLE 396Class Constant IPN_ACCEPTED 396Class Constant IPN_COMPLETED 396Class Constant IPN_DENIED 396Class Constant IPN_FAILED 396Class Constant IPN_INVALID 396Class Constant IPN_PENDING 396Class Constant IPN_SUCCESS 396Class Constant IPN_UNKNOWN 396Class Constant IPN_VERIFIED 396Var $_bussiness 397Var $_cancelURL 397Var $_errorMessage 397Var $_fields 397Var $_ipnData 398Var $_ipnResponse 398Var $_notifyURL 398Var $_returnURL 398Var $_url 399Constructor __construct 399Method addFields 399Method configureOptions 399Method validateIPN 400Method __get 400Method __set 400

Class PennyAuction 401Class Constant EXTENDED_DB_TABLE 401Var $bidIncrementValue 401Constructor __construct 401Method calculateNextBid 401Method finishOffer 402Method getBidButtonText 402Method getExtendedDataFromDB 402Method getInstanceFromDB 402Method getListFromDB 403Method getListOnOneCategory 403Method getWinners 403Method makeBid 403Method removeUserBids 404Method saveToDB 404Method type 404

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 35: Manual

Method typeName 404Method __get 404Method __set 405

Class ReverseAuction 405Constructor __construct 405Method calculateNextBid 406Method finishOffer 406Method getBidButtonText 406Method getExtendedDataFromDB 406Method getInstanceFromDB 406Method getListFromDB 407Method getListOnOneCategory 407Method getWinners 407Method makeBid 407Method saveToDB 408Method type 408Method typeName 408

Class SiteOptions 408Class Constant DB_TABLE 409Class Constant SSL_IN_LOGIN 409Var $_generalOption 409Var $_keys 409Constructor __construct 409Method getInstanceFromDB 410Method getListFromDB 410Method getThemeList 410Method saveToDB 410Method __get 411Method __set 411

Class StandardAuction 411Class Constant BID_INCREMENTS_DB_TABLE 412Class Constant BID_INCREMENT_FIXED 412Class Constant BID_INCREMENT_TABLE 412Class Constant EXTENDED_DB_TABLE 412Var $bidIncrements 412Var $bidIncrementType 412Var $bidIncrementValue 412Var $buyNowPrice 413Var $reservePrice 413Constructor __construct 413Method calculateNextBid 413Method finishOffer 413Method getBidButtonText 413Method getExtendedDataFromDB 414Method getInstanceFromDB 414Method getListFromDB 414Method getListOnOneCategory 415Method getWinners 415Method makeBid 415

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 36: Manual

Method removeUserBids 415Method saveToDB 416Method type 416Method typeName 416Method __get 416Method __set 416

Class Store 417Class Constant DB_TABLE 417Class Constant STORE_BIG 417Class Constant STORE_MEDIUM 417Class Constant STORE_SIZE_TABLE 417Class Constant STORE_SMALL 418Var $_active 418Var $_description 418Var $_featured 418Var $_id 418Var $_logo 418Var $_name 419Var $_offers 419Var $_owner 419Var $_size 419Var $_test 419Constructor __construct 420Method deleteFromDB 420Method discoverId 420Method getInstanceFromDB 421Method getListFromDB 421Method getOffersInStore 421Method getStatsFromDB 422Method getUserStore 422Method offerAllowedInStore 422Method offerAvailableInStore 423Method saveToDB 423Method __get 423Method __set 424

Class StoreSize 424Class Constant DB_TABLE 424Class Constant STORE_LANGUAGE_TABLE 424Var $_active 424Var $_id 425Var $_name 425Var $_size 425Constructor __construct 425Method deleteFromDB 425Method getInstanceFromDB 426Method getListFromDB 426Method getName 426Method saveToDB 427Method setName 427

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 37: Manual

Method __get 427Method __set 428

Class Thematic 428Class Constant DB_TABLE 428Class Constant THEMATIC_LANGUAGE_TABLE 428Var $_active 428Var $_id 429Var $_inFooter 429Var $_inHomeColumn 429Var $_inMenu 429Var $_name 429Constructor __construct 430Method addName 430Method deleteFromDB 430Method discoverId 431Method getInstanceFromDB 431Method getListFromDB 431Method getName 432Method saveToDB 432Method thematicExists 432Method __get 433Method __set 433

Class Timezone 433Class Constant DB_TABLE 434Var $_id 434Method getInstanceFromDB 434Method getListFromDB 434Method __get 434Method __set 435

Class User 435Class Constant ADMIN 435Class Constant DB_TABLE 435Class Constant DB_USER_FIELD_TABLE 436Class Constant DB_USER_TRUST_REQUEST_TABLE 436Class Constant EMAIL_VERIFIED 436Class Constant INACTIVE 436Class Constant NEVER_ACTIVATED 436Class Constant SELLER 436Class Constant TRUST_REQUEST_ACCEPTED 436Class Constant TRUST_REQUEST_DENIED 436Class Constant TRUST_REQUEST_PENDING 436Class Constant USER_IP_TABLE 436Var $active 436Var $address 437Var $admin 437Var $balance 437Var $bidCredit 437Var $birthdate 437Var $city 438

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 38: Manual

Var $countryId 438Var $customFields 438Var $email 438Var $id 439Var $name 439Var $password 439Var $passwordEncripted 439Var $phone 439Var $prestige 440Var $registerDate 440Var $seller 440Var $sessionCookie 440Var $state 440Var $trustSeller 441Var $trustUserRequestStatus 441Var $trustUserStatusRequested 441Var $userLanguage 441Var $userPayMethods 441Var $validEmail 442Var $zip 442Constructor __construct 442Method addFieldValue 442Method addUserIP 443Method deleteFromDB 443Method deleteIP 443Method deleteSession 444Method deleteUserInvoices 444Method getBidsStatsFromDB 444Method getCustomUserData 445Method getDefaultUserType 445Method getFieldValue 445Method getFilteredListFromDB 446Method getFiltersNames 446Method getGeneralStatsFromDB 446Method getInstance 447Method getInstanceFromDB 447Method getListFromDB 447Method getMessageStats 447Method getOffersStatsFromDB 448Method getPublicData 448Method getStatsFromDB 448Method getUserFavourite 449Method getUserFeedbacksStatsFromDB 449Method getUserIPList 449Method isUserFavourite 450Method recalculateFeedbacks 450Method renewSession 450Method saveToDB 451Method setDefaultType 451

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 39: Manual

Method toggleIPStatus 451Method verifyPassword 452Method verifySession 452Method verifyUserIP 453Method __get 453Method __set 453

Class UserFeedback 454Class Constant DB_TABLE 454Var $comment 454Var $date 454Var $fromUser 454Var $id 455Var $offer 455Var $toUser 455Var $value 455Method deleteFromDB 455Method getInstanceFromDB 456Method getListFromDB 456Method getTypesCount 456Method saveToDB 457Method __get 457Method __set 457

Class UserPayMethod 458Class Constant DB_TABLE 458Var $_active 458Var $_details 458Var $_id 459Var $_paymethodId 459Var $_userId 459Constructor __construct 459Method deleteFromDB 459Method getInstanceFromDB 460Method getListFromDB 460Method saveToDB 460Method __get 461Method __set 461

Appendices 462Appendix A - Class Trees 463

enuukAuction 463general 463upgrader 468utils 468Core 469Action 471Action_Admin 474Views 477migrator 478

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 40: Manual

Page 1 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 41: Manual

Package migrator Procedural Elements

Migrator.phpMigrator class file.

This file contains a class, Migrator, wich the code needed to migrate some data from oldphpAuction products to enuukAuction

Package migratorCopyright Copyright (c) 2009, enuuk

Page 2 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 42: Manual

Package migrator Classes

Class Migrator [line 16]

Code to migrate some from old phpAuction products

Package migrator

Migrator::$countryMapper

array = [line 51]

Maps old countries to standard ids

Access private

Migrator::$idToNick

array = [line 58]

Maps the login name (old "nick") to old numeric id.For example, $idToNick[4] = "John";

Page 3 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 43: Manual

Access private

Migrator::$message

string = [line 45]

Access private

Migrator::$newDB

PDO = [line 34]

PDO object for new DB connection

Access private

Migrator::$newPrefix

string = [line 40]

DB tables prefix (ie. "eA_")

Access private

Migrator::$oldDB

PDO = [line 22]

PDO object for old DB connection

Page 4 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 44: Manual

Access private

Migrator::$oldPrefix

string = [line 28]

DB tables prefix (ie. "PHPAUCTIONXL_")

Access private

void function Migrator::connectToDB($oldDB, $oldHost, $oldUser, $oldPass, $oldPrefix, $newDB, $newHost,$newUser, $newPass, $newPrefix) [line 100]

Function Parameters:

$oldDB $oldHost $oldUser $oldPass $oldPrefix $newDB $newHost $newUser $newPass $newPrefix

opens old DB and new DB

Access public

string function Migrator::convertToDate($s) [line 438]Function Parameters:

$s

Page 5 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 45: Manual

Converts strings in format "YYYYmmddHHiiss" to "YYYY/mm/ddHH:ii:ss",or same thing with short version: "YYmmdd" to "YY/mm/dd"

Access private

void function Migrator::createCountryMapper() [line 389]Finds the country ISO ID based on the name, for each country in old DB

Access private

string function Migrator::getMessage() [line 451]returns the message string

Access public

void function Migrator::migrate($oldDB, $oldHost, $oldUser, $oldPass, $oldPrefix, $newDB, $newHost, $newUser,$newPass, $newPrefix) [line 63]

Function Parameters:

$oldDB $oldHost $oldUser $oldPass $oldPrefix $newDB $newHost $newUser $newPass

Page 6 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 46: Manual

$newPrefix

do all steps for migration

Access public

boolean function Migrator::migrateAuctions() [line 280]get old user data and populate new DB tables

Access public

boolean function Migrator::migrateCategories() [line 140]get old categories and populate new DB tables

Access public

boolean function Migrator::migrateUsers() [line 209]get old user data and populate new DB tables

Access public

Page 7 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 47: Manual

Page 8 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 48: Manual

Package upgrader Procedural Elements

Upgrader.phpUpgrader class file.

This file contains a class, Uugrader, wich the code needed to upgrade the DB from oldenuukAuction to a new version

Package upgraderCopyright Copyright (c) 2009, enuuk

Page 9 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 49: Manual

Package upgrader Classes

Class Upgrader [line 16]

Code to upgrade

Package upgrader

Upgrader::$DB

PDO = [line 22]

PDO object for DB connection

Access private

Upgrader::$message

string = [line 27]

Access private

Page 10 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 50: Manual

Upgrader::$versions

array = [line 32]

Access private

Constructor void function Upgrader::__construct($DB) [line 34]Function Parameters:

MyPDO $DB

Access public

string function Upgrader::detectVersion() [line 43]

Access public

string function Upgrader::getMessage() [line 674]returns the message string

Access public

string function Upgrader::lastVersion() [line 683]returns last version avaiable

Page 11 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 51: Manual

Access public

void function Upgrader::update($oldVersion, $newVersion) [line 95]Function Parameters:

$oldVersion $newVersion

Access public

void function Upgrader::update10to11() [line 118]

Access private

void function Upgrader::update11to12() [line 179]

Access private

void function Upgrader::update12to13() [line 196]

Access private

void function Upgrader::update13to14() [line 213]

Access private

Page 12 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 52: Manual

void function Upgrader::update14to15() [line 230]

Access private

void function Upgrader::update15to16() [line 247]

Access private

void function Upgrader::update16to17() [line 384]

Access private

void function Upgrader::update17to18() [line 440]

Access private

void function Upgrader::update18to20() [line 495]

Access private

Page 13 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 53: Manual

Page 14 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 54: Manual

Package utils Procedural Elements

Date.php

Package utilsCopyright Copyright (c) 2009, enuuk

Page 15 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 55: Manual

DB.phpDatabase classes file.

This file contains 2 classes: DB : class to create a PDO connection, actually creates a MyPDO objectMyPDO : wrapper for PDO class, to overload query and prepare methods for changing table prefix

Package utilsCopyright Copyright (c) 2009, enuuk

Page 16 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 56: Manual

Error.php

Package utilsCopyright Copyright (c) 2009, enuuk

Page 17 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 57: Manual

GoogleCheckout.php

Package utils

require_once 'class/contrib/GoogleCheckout/library/googleitem.php' [line 11]

require_once 'class/contrib/GoogleCheckout/library/googleshipping.php' [line 12]

require_once 'class/contrib/GoogleCheckout/library/googletax.php' [line 13]

require_once 'class/contrib/GoogleCheckout/library/googlecart.php' [line 10]

require_once 'class/contrib/GoogleCheckout/library/googlerequest.php' [line 9]

require_once 'class/contrib/GoogleCheckout/library/googlemerchantcalculations.php' [line 7]

require_once 'class/contrib/GoogleCheckout/library/googleresult.php' [line 8]

require_once 'class/contrib/GoogleCheckout/library/googleresponse.php' [line 6]

Copyright Copyright (c) 2009, enuuk

Page 18 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 58: Manual

MailNotificator.phpMail Notificator.

This class uses PHPMailer to send mails for user notifications, which text are stored inDB, in different languages.

Package utilsCopyright Copyright (c) 2009, enuuk

require_once 'class/contrib/phpmailer/class.phpmailer.php' [line 12]

Mail Notificator.This class uses PHPMailer to send mails for user notifications, which text are stored in

DB, in different languages.

Copyright Copyright (c) 2009, enuuk

Page 19 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 59: Manual

String.php

Package utilsCopyright Copyright (c) 2009, enuuk

Page 20 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 60: Manual

SystemInspector.php

Package utilsCopyright Copyright (c) 2009, enuuk

Page 21 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 61: Manual

SystemInstaller.php

Package utilsCopyright Copyright (c) 2009, enuuk

Page 22 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 62: Manual

Package utils Classes

Class Date [line 10]

Date utilities.

Package utils

void function Date::check($date) [line 68]Function Parameters:

$date

Verifies a date in the format yyyy/mm/dd

Static Access public

void function Date::invertDate($s) [line 49]Function Parameters:

string $s

Page 23 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 63: Manual

Changes dd/mm/yyyy for yyyy/mm/dd, and opposite

Static Access public

void function Date::javascriptFormated($d) [line 60]Function Parameters:

$d

Creates a string for javascript Date object initiation.js Date uses the format: (year,month-1,day,hours,minutes,seconds,milliseconds) Used

for DatePicker widget initiation.

Static Access public

integer function Date::secondsDifference($date) [line 106]Function Parameters:

string $date in format yyyy/mm/dd hh:mm:ss or similar strtotime-able

returns the number of seconds from now to $date

Static Access public

Page 24 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 64: Manual

string function Date::showTimeDifference($date) [line 87]Function Parameters:

string $date in format yyyy/mm/dd or similar strtotime-able

returns a string with the days, hours, etc that there are from now to $date

Static Access public

void function Date::toLocaleLongString($d, $lang) [line 29]Function Parameters:

$d $lang

Static Access public

void function Date::toLocaleShortString($d, $lang) [line 16]Function Parameters:

$d $lang

Shows data in format regarding locale.Now uses manual processing, but the idea is to use IntlDateFormatter in the future (PHP

5.3+)

Page 25 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 65: Manual

Static Access public

integer function Date::yearDifference($startDate, $endDate) [line 119]Function Parameters:

startDate $startDate start date in yyyy/mm/dd format or similar strtotime-ableendDate $endDate end date in yyyy/mm/dd format or similar strtotime-able

returns year difference between two dates

Static Access public

Class DB [line 21]

Creates a DB object instance, acording config.php file parameters.Instanciate a MyPDO object, which is a extended class of PDO. Normal PDO methods

work, but query() and prepare() are improved.

Package utils

DB::$db

resource = [line 27]

Page 26 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 66: Manual

Contains DB resource

Var database resourceStatic Access protected

array function DB::createArrayFromDBResult($queryResult, $key, $value) [line 71]Function Parameters:

PDOStatement $queryResult string $key Row from DB to use as key in returning arraystring $value Row from DB to use as value in returning array

Creates an array taking the keys and values from defined parameters.For example, if a table with these columns (id,name,surname) contains the values

(1,"John","Connor") and (2,"Sarah","Connor"),and this method is called like "createArrayFromDBResult($query,"id","name"), the result isfollowing array: (1=>"John", 2=>"Sarah").

Static Access public

void function DB::getInstance() [line 32]Action to get the DB object

Static Access public

Page 27 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 67: Manual

Class Error [line 10]

Error utilities.

Package utils

Error::BY_CODE

= 2 [line 13]

Error::BY_UNKNOWN

= 3 [line 14]

Error::BY_USER

= 1 [line 12]

Class GoogleCheckout [line 19]

Google Checkout class

Package utils

GoogleCheckout::BIDPACKFEE

= 'BIDPACKFEE' [line 36]

GoogleCheckout::DB_TABLE

= 'V5_googleCheckoutTransactions' [line 24]

Page 28 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 68: Manual

DB Table

GoogleCheckout::DIRECTPAY

= 'DIRECTFEE' [line 32]

GoogleCheckout::FINALFEE

= "FINALVALUEFEE" [line 34]

GoogleCheckout::INVOICE

= 'INVOICE' [line 29]

Payment identifier constants

GoogleCheckout::OTHERFEE

= 'OTHERFEE' [line 31]

GoogleCheckout::RELISTINGFEE

= 'RELISTINGFEE' [line 33]

GoogleCheckout::SIGNUPFEE

= 'SIGNUPFEE' [line 30]

GoogleCheckout::STOREFEE

= "STOREFEE" [line 35]

GoogleCheckout::$_cart

mixed = [line 47]

Access private

GoogleCheckout::$_country

mixed = [line 45]

Access private

Page 29 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 69: Manual

GoogleCheckout::$_currency

mixed = [line 46]

Access private

GoogleCheckout::$_lang

mixed = [line 44]

Access private

GoogleCheckout::$_merchantId

mixed = [line 41]

class variables

Access private

GoogleCheckout::$_merchantKey

mixed = [line 42]

Access private

GoogleCheckout::$_serverType

mixed = [line 43]

Page 30 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 70: Manual

Access private

Constructor void function GoogleCheckout::__construct($merchantId, $merchantKey, [$serverType = 'sandbox'],[$lang = 'en_US'], [$currency = 'USD']) [line 49]

Function Parameters:

$merchantId $merchantKey $serverType $lang $currency

Access public

string function GoogleCheckout::configureOptions($amount, $type, $id, $itemDesc, $context, $DB, $url, $item)[line 114]

Function Parameters:

Core_Context $context context objectstring $url return urlGoogleItem $item item to be added in the Google Checkout cartMyPDO $DB MyPDO object $amount $type $id $itemDesc

function to configure Google check out button

Static Access public

Page 31 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 71: Manual

array function GoogleCheckout::getOrderDataFromDB($DB, $googleOrderNumber) [line 95]Function Parameters:

MyPDO $DB database instancestring $googleOrderNumber google order number of the order

function to retrieve item name from database

Static Access public

void function GoogleCheckout::__get($property) [line 68]Function Parameters:

$property

Access public

void function GoogleCheckout::__set($property, $value) [line 78]Function Parameters:

$property $value

Access public

Page 32 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 72: Manual

Class MailNotificator [line 20]

Mail Notificator.This class uses PHPMailer to send mails for user notifications, which text are stored in

DB, in different languages.

Package utils

MailNotificator::AUCTIONMAIL

= "auctionmail" [line 49]

when A new auction has been created by user

MailNotificator::AUCTIONMAIL_FIXED

= "auctionmailfixed" [line 54]

when A new Fixed auction has been created by user

MailNotificator::AUCTIONMAIL_LOT

= "auctionmaillot" [line 59]

when A new LOT auction has been created by user

MailNotificator::AUCTIONMAIL_REVERSE

= "auctionmailreverse" [line 64]

when A new REVERSE auction has been created by user

MailNotificator::FILE_PATH

= 'themes/mails/' [line 25]

mail content directory

Page 33 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 73: Manual

MailNotificator::MAIL_BID

= 'bid' [line 89]

when someone bids on a auction, inform the seller mail

MailNotificator::MAIL_BUY_FIXED_BUYER

= 'buy_fixed_buyer' [line 109]

user have purchased the fixed price item

MailNotificator::MAIL_BUY_FIXED_SELLER

= 'buy_fixed_seller' [line 114]

user have sold the fixed price item

MailNotificator::MAIL_BUY_LOT_BUYER

= 'buy_lot_buyer' [line 119]

user have purchased an item from lot

MailNotificator::MAIL_BUY_LOT_SELLER

= 'buy_lot_seller' [line 124]

user have sold the fixed price item

MailNotificator::MAIL_DUE_FEE

= 'unpaid_fees' [line 104]

user have some due fee to pay

MailNotificator::MAIL_ENDAUCTION_BIDDER

= "mail_endauction_bidder" [line 79]

when an auction finish and there is a winner - mail for bidder

MailNotificator::MAIL_ENDAUCTION_NOWINNER

= "mail_endauction_nowinner" [line 69]

Page 34 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 74: Manual

when an auction finish but there is no winner

MailNotificator::MAIL_ENDAUCTION_WINNER

= "mail_endauction_winner" [line 74]

when an auction finish and there is a winner - mail for owner

MailNotificator::MAIL_INVOICE

= 'invoice' [line 99]

invoice mail

MailNotificator::MAIL_MESSAGE

= 'message' [line 94]

someone sent a message

MailNotificator::MAIL_NO_LONGER_LEAD_BIDDER

= 'no_longer_winner' [line 84]

when someone bids over a previous bid

MailNotificator::MAIL_OFFER_ANSWER

= 'offer_answer' [line 134]

a question has been answered

MailNotificator::MAIL_OFFER_QUESTION

= 'offer_question' [line 129]

a question has been asked

MailNotificator::NEWPASSWD

= "newpasswd" [line 44]

New password mail

MailNotificator::REGISTRATION_MAIL

Page 35 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 75: Manual

= "usermail" [line 34]

Registration mail constant

MailNotificator::USERMAIL_APPROVED

= "usermail_approved" [line 39]

user registration is confirmed

MailNotificator::$errorMessage

mixed = "" [line 146]

Access public

MailNotificator::$hasError

mixed = false [line 147]

Access public

MailNotificator::$language

mixed = 'en_US' [line 152]

default language is hard coded as fail safe measure

Access public

MailNotificator::$_emailBody

mixed = [line 140]

variable to store email content: body and subject

Page 36 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 76: Manual

Access private

MailNotificator::$_emailSubject

mixed = [line 141]

Access private

bool function MailNotificator::getData($type, $lang) [line 244]Function Parameters:

string $type define type of emailstring $lang language variable

function to retrieve the text of a mail

Access private

formatted function MailNotificator::reFormatString($data, $str) [line 297]Function Parameters:

string $str original string that needs to be formatedarray $data the data paramater, this array contains the values that will be used in the place of<#values#>

Function to re-format the mail text

Page 37 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 77: Manual

Access private

bool function MailNotificator::send($to, $from, $fromName, $type, $lang, $data, [$bcc = '']) [line 166]Function Parameters:

string $to User emailstring $from Site default emailstring $fromName Site default namestring $type A type of mail defined as a constant in this classstring $lang Language for mail textarray $data Extra values needed to fill in the mail text $bcc

Sends the notification mail

Access public

void function MailNotificator::sendOneMail($to, $from, $fromName, $body, $subject, [$bcc = '']) [line 198]Function Parameters:

$to $from $fromName $body $subject $bcc

Function to send one mail

Access private

Page 38 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 78: Manual

void function MailNotificator::__get($property) [line 309]Function Parameters:

$property

Getter Method

Access public

Class MyPDO [line 88]

Class extended from PDO.Method query() is overloaded to replace table prefix normal PDOStatement

Package utils

MyPDO::$count

mixed = 0 [line 90]

Static Access public

void function MyPDO::exec($s) [line 106]Function Parameters:

Page 39 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 79: Manual

$s

Access public

void function MyPDO::prepare($s, [$opt = array()]) [line 93]Function Parameters:

$s $opt

Access public

void function MyPDO::query($s) [line 99]Function Parameters:

$s

Access public

Class String [line 10]

String utilities.

Page 40 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 80: Manual

Package utils

string function String::camelize($s) [line 30]Function Parameters:

string $s original string

Remove spaces and othe punctuation characters, and uppercase first letter of everyword.

Static Access public

void function String::isEmail($s) [line 16]Function Parameters:

$s

Verifies if string is a valid email

Static Access public

Page 41 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 81: Manual

Class SystemInspector [line 12]

System Inspector.Checks the requirements of the system

Package utils

SystemInspector::$errorMessage

mixed = "" [line 28]

variable to store Error Messages

Access public

SystemInspector::$isInstallable

mixed = false [line 23]

Variable to identify if the system can be used to install the V5by default its value is set to false, but in each function call we will change it's value to true

if the return value of the function itself is true;

Access public

SystemInspector::$systemRequirements

mixed = [line 17]

Variable to store System Verification results, Like which test is pass or fail

Page 42 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 82: Manual

Access public

void function SystemInspector::verifyGD() [line 83]Verifies if GD library is loaded with PHP or not

Access public

void function SystemInspector::verifyGettext() [line 98]Verifies if the gettext extension is loaded with PHP.

This module is required for translation

Access public

void function SystemInspector::verifyLinux() [line 54]Verifies if system is Linux

Access public

void function SystemInspector::verifyModRW() [line 151]

Access public

void function SystemInspector::verifyPDO() [line 112]

Page 43 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 83: Manual

Verifies if PDO is loaded with PHP

Access public

void function SystemInspector::verifyPdoMysql() [line 126]Verifies if PDO-MySql driver is loaded with PHP

Access public

void function SystemInspector::verifyPHP() [line 69]Verifies if the current php version is >=5.0.0

Access public

void function SystemInspector::verifyRewriteEngine($path) [line 163]Function Parameters:

$path

function to check if URL Rewritting is Working or not.this function sends a request to http://host/testModRewrite.txt if re-write engine is on and

url rewritting is working; then server will redirect the request tohttp://host/install/testModRewrite.txt otherwise server will send a 404 error document. in theabove text document there is a a base64 encoded text to verify if rewrite engine is on

Access public

Page 44 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 84: Manual

void function SystemInspector::verifySPLClasses() [line 140]Verifies if SPL module is loaded with PHP or not

Access public

void function SystemInspector::verifySystem() [line 33]Verifies the Whole System and stores the result in a array

Access public

Class SystemInstaller [line 12]

System Installer.Installs the V5 system

Package utils

SystemInstaller::GENERAL_OPTIONS_TABLE

= 'V5_siteOptions' [line 49]

SystemInstaller::LANGUAGE_TABLE

= 'V5_languages' [line 48]

Page 45 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 85: Manual

language table variable

SystemInstaller::$configFile

mixed = "config.php" [line 43]

Access public

SystemInstaller::$configPath

mixed = __FILE__ [line 42]

Database config file path

Access public

SystemInstaller::$dbConfig

mixed = [line 37]

array to store database configuration details

Access public

SystemInstaller::$dbSqlScript

mixed = [line 17]

Variable to store SQL Script lines

Page 46 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 86: Manual

Access public

SystemInstaller::$errorMessage

mixed = "" [line 22]

variable to store the error messages

Static Access public

SystemInstaller::$hasError

mixed = false [line 32]

variable to keep error status in the program

Static Access public

SystemInstaller::$pdoErrorMessage

mixed = "" [line 27]

variable to store database connection exception message

Access public

Constructor void function SystemInstaller::__construct() [line 54]SystemInstaller constructor

Page 47 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 87: Manual

Access public

void function SystemInstaller::constructDB() [line 206]Constructs the database

Access public

bool function SystemInstaller::createAdmin($password, $email, $country) [line 378]Function Parameters:

string $password admin passwordstring $email admin emailstring $country

function to setup admin user account

Static Access public

void function SystemInstaller::getDBConfig() [line 90]Write the User Configuration to config.php

Access public

string function SystemInstaller::getLanguageName($lang) [line 360]Function Parameters:

Page 48 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 88: Manual

string $lang language id

function to return language name for specified language id

Static Access public

void function SystemInstaller::getSiteLanguages() [line 310]Function to retrieve list of languages

Static Access public

void function SystemInstaller::installDB() [line 233]Installs the SQL script of V5 database...

Access private

void function SystemInstaller::setConfigPath($path) [line 302]Function Parameters:

$path

Setting the config file path

Page 49 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 89: Manual

Access public

void function SystemInstaller::setSQLScript($sql) [line 294]Function Parameters:

$sql

setting the SQL dump data

Access public

bool function SystemInstaller::setUpSiteOptions($params) [line 338]Function Parameters:

array $params list of parameters as associative array

function to setup general options in V5_siteOptions

Static Access public

void function SystemInstaller::verifyDatabaseConfig() [line 105]Verifies the Database Configuration provided by User

Access public

Page 50 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 90: Manual

void function SystemInstaller::verifyDB() [line 149]Verifies Database Connection detail by attempting to connect to database

Access public

void function SystemInstaller::verifySTR($str) [line 278]Function Parameters:

$str

function to verify a string for validity

Access private

Page 51 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 91: Manual

Page 52 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 92: Manual

Package Views Procedural Elements

CSV.php

Package ViewsCopyright Copyright (c) 2009, enuuk

Page 53 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 93: Manual

Echo.php

Package ViewsCopyright Copyright (c) 2009, enuuk

Page 54 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 94: Manual

HTML.php

Package ViewsCopyright Copyright (c) 2009, enuuk

Page 55 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 95: Manual

JSON.php

Package ViewsCopyright Copyright (c) 2009, enuuk

Page 56 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 96: Manual

PHP.php

Package ViewsCopyright Copyright (c) 2009, enuuk

Page 57 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 97: Manual

Rss.php

Package ViewsCopyright Copyright (c) 2009, enuuk

Page 58 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 98: Manual

Package Views Classes

Class View_CSV [line 11]

View for exporting lists as csv file.

Package Views

void function View_CSV::display() [line 16]Executes View

Access public

Class View_Echo [line 9]

Just flush out processed data, for testing issues.

Page 59 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 99: Manual

Package Views

void function View_Echo::display() [line 14]Executes View

Access public

Class View_HTML [line 16]

View for displaying HTML.Will receive data, including:

context->data['template'] = Template to callcontext->data['theme'] = Theme to use With this 2 values the template located in

"themes/$data['theme']/$data['template']" is called.

Package Views

void function View_HTML::display() [line 32]Executes View

Access public

Page 60 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 100: Manual

void function View_HTML::setContext($context) [line 21]Function Parameters:

Core_Context $context

Retrieves context

Access public

Class View_JSON [line 9]

Flush out data with JSON notation

Package Views

void function View_JSON::array2json($a) [line 32]Function Parameters:

$a

Converts a PHP array in JSON format

Access private

Page 61 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 101: Manual

void function View_JSON::display() [line 14]Executes View

Access public

void function View_JSON::jsEncode($v) [line 48]Function Parameters:

$v

Converts a single item of a PHP array in JSON format

Access private

Class View_PHP [line 9]

Flush out data in serialized PHP form

Package Views

void function View_PHP::display() [line 14]Executes View

Page 62 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 102: Manual

Access public

Class View_Rss [line 12]

View for displaying RSS.Will receive data, from action and

Package Views

void function View_Rss::display() [line 17]Executes View

Access public

Page 63 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 103: Manual

Page 64 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 104: Manual

Package enuukAuction ProceduralElements

ResponseHandler.php

Package enuukAuctionCopyright Copyright (c) 2009, enuuk

require_once 'contrib/GoogleCheckout/library/googlerequest.php' [line 12]

require_once 'contrib/GoogleCheckout/library/googleresult.php' [line 11]

require_once 'contrib/GoogleCheckout/library/googlemerchantcalculations.php' [line 10]

require_once 'contrib/GoogleCheckout/library/googleresponse.php' [line 9]

Google Checkout Response Handler

Page 65 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 105: Manual

config.phpDB access config file

This file contains only variables for DB access. Others global variables are stored in"siteOptions" DB table.

The application uses PDO as default DB abstraction. See class DB for more details.

Package enuukAuction

TABLE_PREFIX = "V5_" [line 17]DB access config file

This file contains only variables for DB access. Others global variables are stored in"siteOptions" DB table.

The application uses PDO as default DB abstraction. See class DB for more details.

Page 66 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 106: Manual

index.phpenuuk Auction index

This is the main file. All HTTP requests to the site are routed to this file (check .htaccessfor details), so mod_rewrite should be present in the server. Here a config file (with DBaccess details) is loaded, an _autoload function defined in order to load classes, and anobject Core_Controller is instantiated to manage the user request.

The MVC implemented is a mix between Apache Struts(http://en.wikipedia.org/wiki/Apache_Struts) and Digg Core(http://www.onlamp.com/pub/a/php/2005/09/15/mvc_intro.html). There is only one Controllerwhich manages all user requests and routes requests to the concrete Action, which is theapplication logic that interacts with the classes of the system, such as User, Items, etc(classes in "general" package). The Action calls the needed general classes to doits operation, and returns the data to display to the Controller. The Controller receives thedata and creates a concrete View (usually View_HTML) giving it the data.

The following packages of classes are present in this application: Core : Defines the MVC pattern. It contains five classes. Controller is a final class, but Action and View are abstract classes, created to extend concrete Actions and Views classes. See Core_Controller class documentation for more details. Moreover there is a Core_Context class in order to store all data needed by the other classes.Action : There are different Actions, in relation with user calls. The first directory of URL defines concrete Action to call. For example, www.example.com/category/Arts -> Action_Category is called.Action_Admin : Same as before, but for admin back end. For example, www.example.com/admin/User -> Action_Admin_User is called.View : There are different Views, to manage different outputs. By default View_HTML is called, unless a parameter "v" is included in the request.general : This package groups normal classes, like User, Item, etcutils : This includes auxiliary packages, like DB or String.tests : Not used in main application, just for PHPUnit testing.

Package enuukAuctionCopyright Copyright (c) 2009, enuuk

void function handleException($e) [line 85]Function Parameters:

Page 67 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 107: Manual

Exception $e

Handles a root fatal exception, displaying a general error pageThis is used only for errors in __autoload() or fatal errors (like DB's)

require_once 'config.php' [line 50]

Loading persistent system configuration

void function __autoload($class) [line 60]Function Parameters:

$class

Classes "autoload"All classes are under class/ directory. Moreover, the package is included in class name,

appending with a "_" before the real class name; the packages are usually underdirectories. So, as example, Action_Index class is in file class/Action/Index.php

Page 68 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 108: Manual

install.phpenuuk Instalation script.

Package enuukAuctionCopyright Copyright (c) 2009, enuuk

include $installFilePath."step".$step.".php" [line 80]

include $installFilePath."step".$step.".php" [line 83]

include $installFilePath."step".$step.".php" [line 77]

include $installFilePath."step".$step.".php" [line 74]

include $installFilePath."step".$step.".php" [line 71]

Path to Include Files

include $installFilePath."stepEnd.php" [line 62]

Local variables to handle and display error messages

include_once $installFilePath."install_footer.php" [line 87]

include_once "install/install_header.php" [line 37]

SystemInspector Object

require_once 'config.php' [line 20]

Page 69 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 109: Manual

migration.php

Package enuukAuction

require_once "class/Migrator.php" [line 20]

Migration script (from old phpAuction products DB to enuukAuction DB)

Copyright Copyright (c) 2009, enuuk

Page 70 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 110: Manual

Package enuukAuction Classes

Class ResponseHandler [line 14]

Package enuukAuction

ResponseHandler::DB_TABLE

= 'V5_googleCheckoutTransactions' [line 19]

db table

ResponseHandler::RESPONSE_HANDLER_ERROR_LOG_FILE

= 'googleerror.log' [line 24]

google response log files

ResponseHandler::RESPONSE_HANDLER_LOG_FILE

= 'googlemessage.log' [line 25]

ResponseHandler::$_currency

mixed = [line 33]

Access private

Page 71 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 111: Manual

ResponseHandler::$_data

mixed = [line 38]

Access private

ResponseHandler::$_gRequest

mixed = [line 35]

Access private

ResponseHandler::$_gResponse

mixed = [line 34]

Access private

ResponseHandler::$_itemName

mixed = [line 39]

Access private

ResponseHandler::$_merchantId

mixed = [line 30]

class variables

Page 72 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 112: Manual

Access private

ResponseHandler::$_merchantKey

mixed = [line 31]

Access private

ResponseHandler::$_root

mixed = [line 37]

Access private

ResponseHandler::$_serverType

mixed = [line 32]

Access private

ResponseHandler::$_status

mixed = [line 40]

Access private

ResponseHandler::$_xmlResponse

mixed = [line 36]

Page 73 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 113: Manual

Access private

Constructor void function ResponseHandler::__construct($merchantId, $merchantKey, $serverType, $currency)[line 42]

Function Parameters:

$merchantId $merchantKey $serverType $currency

Access public

string function ResponseHandler::gcOrderStateChange($DB) [line 185]Function Parameters:

MyPDO $DB database instance

This function updates the status of differnt fees accroding to the new-financial-order-state received in the status It first retrieves order data from GC transaction logtable, convert the new-financial-order-state to respective Fee status value.Then it update the respective fees and return the Fee status value.

Access private

void function ResponseHandler::getData() [line 91]retrieve Response data

Page 74 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 114: Manual

Access private

string function ResponseHandler::getDirectFeeStatus($googleStatus) [line 480]Function Parameters:

string $googleStatus status string coming from Google Checkout

function to return direct fee status

Access private

string function ResponseHandler::getGoogleOrderNumber() [line 467]function to return Order number (Googlecheckout item name)

Access public

int function ResponseHandler::getId($itemName) [line 428]Function Parameters:

string $itemName GoogleCheckout response Item name

function to retrieve and return ID from Item name

Access public

Page 75 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 115: Manual

void function ResponseHandler::getInvoiceStatus($googleStatus) [line 501]Function Parameters:

$googleStatus

Access private

string function ResponseHandler::getItemName() [line 453]function to return item name (Googlecheckout item name)

Access public

string function ResponseHandler::getPaymentType($itemName) [line 403]Function Parameters:

string $itemName GoogleCheckout response Item name

function to retrieve type of payment for this item, item name for any item isPAYMENT_TYPE_CONSTANT#ID (invoice or offer)

Access public

void function ResponseHandler::newOrderNotification($DB) [line 139]Function Parameters:

MyPDO $DB database Inserts Response data to Google Checkout table

Page 76 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 116: Manual

Access private

void function ResponseHandler::processResponse($DB) [line 101]Function Parameters:

MyPDO $DB

Function to process Response receivedGoogleCheckout sends a lot of notifications such as new-order,risk-calculation,charge-

amount etc, only relevant notifications are processed

Access public

void function ResponseHandler::updateInvoice($DB, $orderNumber, $status) [line 378]Function Parameters:

MyPDO $DB Database instancestring $orderNumber Google order numberstatus $status

retrieve invoice id from the description string passed to the function

Access private

void function ResponseHandler::__get($property) [line 68]Function Parameters:

Page 77 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 117: Manual

$property

Access public

void function ResponseHandler::__set($property, $value) [line 78]Function Parameters:

$property $value

Access public

Page 78 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 118: Manual

Page 79 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 119: Manual

Package Action Procedural Elements

Admin.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 80 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 120: Manual

BidPack.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 81 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 121: Manual

StoreSize.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 82 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 122: Manual

BidPack.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 83 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 123: Manual

Category.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 84 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 124: Manual

CustomPage.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 85 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 125: Manual

Fee.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 86 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 126: Manual

Index.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 87 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 127: Manual

Invoicepay.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 88 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 128: Manual

Message.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 89 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 129: Manual

Offer.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 90 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 130: Manual

PaypalDirectPay.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 91 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 131: Manual

ResponseHandler.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 92 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 132: Manual

Search.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 93 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 133: Manual

Store.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 94 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 134: Manual

User.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 95 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 135: Manual

UserPayMethod.php

Package ActionCopyright Copyright (c) 2009, enuuk

Page 96 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 136: Manual

Package Action Classes

Class Action_Admin [line 12]

Action AdminAction for managing Admin operations

Package Action

void function Action_Admin::defaultAction() [line 18]Default action

this enroutes the admin operation to the selected Action/Admin/xxx.php class

Access public

void function Action_Admin::verifyLoggedAdmin() [line 57]

Access private

Page 97 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 137: Manual

Class Action_Admin_BidPack [line 18]

Action BidPackAction for BidPack operations

URL View template file / bidPackList.php /add bidPackForm.php /edit bidPackForm.php /delete bidPackList.php -

Package Action

void function Action_Admin_BidPack::activate() [line 86]

Access public

void function Action_Admin_BidPack::add() [line 31]

Access public

void function Action_Admin_BidPack::deactivate() [line 104]

Access public

void function Action_Admin_BidPack::defaultAction() [line 20]

Access public

Page 98 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 138: Manual

void function Action_Admin_BidPack::delete() [line 122]

Access public

void function Action_Admin_BidPack::edit() [line 43]

Access public

void function Action_Admin_BidPack::initialBids() [line 139]

Access public

Class Action_Admin_StoreSize [line 19]

Action StoreSizeAction for StoreSize operations

URL View template file /storeSize storesSizes.php Action add storeSizeForm.phpedit storeSizeForm.phpdelete storeSizeDelete.php

Package Action

Page 99 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 139: Manual

void function Action_Admin_StoreSize::changeStatus($par, [$status = 0]) [line 53]Function Parameters:

$par $status

toggle store size status

Access private

void function Action_Admin_StoreSize::defaultAction() [line 21]

Access public

void function Action_Admin_StoreSize::doEdit() [line 117]edit existing store size

Access private

void function Action_Admin_StoreSize::processStoreSizeForm($par) [line 82]Function Parameters:

$par

Page 100 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 140: Manual

Access private

void function Action_Admin_StoreSize::verifyOptionalParameters($fields, $defaultLang) [line 170]Function Parameters:

$fields $defaultLang

Access private

Class Action_BidPack [line 11]

Action BidPackActions related to see and buy bid packs for penny auctions

Package Action

void function Action_BidPack::buy() [line 36]buy a bid pack: show the price to confirm

Access public

void function Action_BidPack::defaultAction() [line 17]

Page 101 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 141: Manual

Default actionShows remaining bids for logged user and

Access public

Class Action_Category [line 11]

Action CategoryCategory action

Package Action

void function Action_Category::defaultAction() [line 16]Default action

Access public

Class Action_CustomPage [line 10]

Action for CustomPage

Page 102 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 142: Manual

Package Action

void function Action_CustomPage::defaultAction() [line 15]Default action

Access public

void function Action_CustomPage::initPage($customPage) [line 69]Function Parameters:

CustomPage $customPage

Access private

void function Action_CustomPage::initThematic($pages, $thematicId) [line 93]Function Parameters:

array $pages $thematicId

Access private

Page 103 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 143: Manual

Class Action_Fee [line 10]

Action for displaying a fee summary

Package Action

void function Action_Fee::defaultAction() [line 12]

Access public

Class Action_Index [line 12]

Action for homepageThis action only contains a method, defaultAction, that gets some generic info

Package Action

void function Action_Index::defaultAction() [line 17]Default action

Access public

Page 104 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 144: Manual

Class Action_Invoicepay [line 10]

Action for Invoicepayment

Package Action

void function Action_Invoicepay::defaultAction() [line 12]

Access public

void function Action_Invoicepay::paypalCancel() [line 33]User cancel payment of invoice

Access public

void function Action_Invoicepay::paypalNotify() [line 80]Notification url for receiving notification from paypal regarding status of payment.

Fee and Invoice status is updated according to the status received

Access public

Page 105 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 145: Manual

void function Action_Invoicepay::paypalPay() [line 25]Left for future usage

Access public

void function Action_Invoicepay::paypalReturn() [line 44]After user return from paypal after paying for Invoice

Access public

Class Action_Message [line 17]

Action MessageAction for Message operations

URL View template file /message messageList.php/message/add messageAdd.php/message/view messageView.php/message/delete messageDelete.php

Package Action

void function Action_Message::compose() [line 40]

Page 106 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 146: Manual

addshows new message form

Access public

void function Action_Message::defaultAction() [line 23]Default action

get personal message list

Access public

void function Action_Message::delete(0) [line 221]Function Parameters:

['id'] 0 number message id

deletedelete current message: show form and process it

Access public

void function Action_Message::deleteAll($par) [line 157]Function Parameters:

$par

Page 107 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 147: Manual

deleteAlldelete selected messages

Access private

void function Action_Message::mark() [line 305]

Access public

void function Action_Message::markAll($par) [line 253]Function Parameters:

$par

Access private

void function Action_Message::submit() [line 348]

Access public

void function Action_Message::view(0) [line 120]Function Parameters:

['id'] 0 number message id

Page 108 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 148: Manual

viewshow message

Access public

Class Action_Offer [line 21]

Action OfferAction for Offer operations

URL View template file /offer jumps to Action_Category->defaultAction()/offer/add offerAdd.php/offer/fees offerAdd.php/offer/details offerDetails.php/offer/edit offerEdit.php/offer/wanted offerWanted.php/offer/delete offerDelete.php

Package Action

void function Action_Offer::add() [line 38]add

shows new Offer form

Page 109 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 149: Manual

Access public

void function Action_Offer::calculateFees($offer) [line 696]Function Parameters:

Offer $offer

calculate feesbased on parameters from offer form, calculates the values of active fees

Access private

void function Action_Offer::copyAuction() [line 1600]function to copy auction as a new draft auction

Access public

void function Action_Offer::defaultAction() [line 27]Default action

get offer list

Access public

void function Action_Offer::delete(0) [line 1461]Function Parameters:

Page 110 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 150: Manual

['id'] 0 number offer id

deletedelete current offer: show form and process it

Access public

void function Action_Offer::details() [line 786]details

show Offer data

Access public

void function Action_Offer::draftOffers() [line 600]draftOffers action, this action is used when PayMethod is set to Direct,

When PayMethod is Invoice, fees are not applied until user click on "Agree"button, but in Direct fee, fee are already applied when user reaches Fee page, (stored inFee::FEES_USERS_TABLE table) When user want to keep the Auction as Draft (in case ofDirect Fee) (he click on "Keep as Draft" button) all related fee that were appliedare removed from table the user is then forward to user's draft auction page(user/draftOffers)

Access public

void function Action_Offer::edit() [line 993]edit details

show offer data form and process it edit/id

Page 111 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 151: Manual

Access public

void function Action_Offer::fees() [line 109]offer fees

This method works bit differently for two payment types (Invoice::INVOICE &Invoice::DIRECTPAY) 1) When payment type is Invoice, fees are simulated, what user seeis just a simiulation, and they are stored in DB only when user agree to pay the fee 2)When payment type is DirectPay, real fees are stored in DB when user reaches Fees page, this is required, because, in this case when user clicks on pay button, user is sent topayment gateway, so if real fees are not stored in DB, system will have no record whenuser returns from payment gateway after making the payment

Access public

void function Action_Offer::isLoggedUserASeller() [line 188]

Access private

int function Action_Offer::processOfferForm() [line 212]saves all data from the offerForm, and save it as draft

Access private

void function Action_Offer::publishOffer($offer) [line 615]Function Parameters:

Page 112 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 152: Manual

Offer $offer

Access public

void function Action_Offer::qa() [line 1525]action for processing offer question and answers

Access public

void function Action_Offer::wanted() [line 1160]wanted

show bid form and process it

Access public

Class Action_PaypalDirectPay [line 13]

Action for Payments other then Invoice for direct payment of offerpaypalReturn,paypalNotify,paypalCancel is used for rest of paymentsPaypap*Other is used

Page 113 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 153: Manual

Package Action

void function Action_PaypalDirectPay::defaultAction() [line 15]

Access public

void function Action_PaypalDirectPay::paypalCancel() [line 34]User is sent to this url if he cancels payment of direct fee for Offer

Access public

void function Action_PaypalDirectPay::paypalCancelOther() [line 215]paypal return url for other actions

When user cancel payment from paypal before paying Fee such as Sign up or Relistingor other future fee

Access public

void function Action_PaypalDirectPay::paypalNotify() [line 96]function for receiving notification for direct payment of Offer

Paypal send notification to this url, for following type of fee

Access public

void function Action_PaypalDirectPay::paypalNotifyOther() [line 272]

Page 114 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 154: Manual

function for receiving notification for all other types of paymentPaypal send notification to this url, for following type of fee

Fee::SIGNUP_FEE,Fee::RELISTING_FEE,Fee::FINALFEE,Fee::STOREFEE,Fee::DIRECT_FEE more fee can be added

Access public

void function Action_PaypalDirectPay::paypalPay() [line 24]

Access public

void function Action_PaypalDirectPay::paypalReturn() [line 46]user return to this URL after paying direct fee for creating offer

Fee status is set to Pending

Access public

void function Action_PaypalDirectPay::paypalReturnOther() [line 146]paypal return url for other actions

When user returns from paypal after paying Fee such as Sign up or Relisting or otherfuture fee

Access public

Page 115 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 155: Manual

Class Action_ResponseHandler [line 12]

Action for Google Checkout Response Handler Processing of Invoices and for fees ofother types of payments in done in ResponseHandler class other payments areprocesses in this Action

Package Action

void function Action_ResponseHandler::defaultAction() [line 21]Action to handle GoogleCheckout notifications, GoogleCheckout sends all payment

status related notifications to this urlThis Action is not used by the user directly, as this method requires notification data in

order to process the notification this method call ResponseHandler::processResponse() toprocess the notifications, the only processing that is done in this method sending mails ordoing processes that make use of context variables

Access public

void function Action_ResponseHandler::googleCheckoutReturn() [line 109]forwards user to respective page when user returns back from google checkout after

completing any transactionUser arrives to this page after making payment payment of Direct fee for Actions other

then Invoice & GoogleCheckout::DIRECTPAY

Access public

void function Action_ResponseHandler::offerDetails() [line 85]

Page 116 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 156: Manual

offerDetails actionUser arrives to this action after making payment of Direct fee for Auction

(GoogleCheckout::DIRECTPAY)

Access public

Class Action_Search [line 12]

Action for searchThis action only contains a method, defaultAction,

Package Action

void function Action_Search::defaultAction() [line 14]

Access public

Class Action_Store [line 19]

Action StoreAction for Store operations

Page 117 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 157: Manual

URL View template file /store stores.php/store/add storeForm.php/store/ABC storeHome.php/store/edit storeForm.php/Store/delete storeDelete.php

Package Action

void function Action_Store::calculateFees($store) [line 584]Function Parameters:

Store $store

calculate feesbased on parameters from offer form, calculates the values of active fees

Access private

void function Action_Store::category() [line 127]store category action

Access public

void function Action_Store::create() [line 205]store add Action

Page 118 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 158: Manual

Access public

void function Action_Store::defaultAction() [line 21]

Access public

void function Action_Store::delete() [line 628]webstore delete action

Access public

void function Action_Store::details($store) [line 263]Function Parameters:

Store $store

Access private

void function Action_Store::edit() [line 327]edit Store details

show store data form and process it edit/id

Page 119 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 159: Manual

Access public

void function Action_Store::fees() [line 510]store fees action

This method works bit differently for two payment types (Invoice::INVOICE &Invoice::DIRECTPAY) 1) When payment type is Invoice, fees are simulated, what user seeis just a simiulation, and they are stored in DB only when user agree to pay the fee 2)When payment type is DirectPay, real fees are stored in DB when user reaches Fees page, this is required, because, in this case when user clicks on pay button, user is sent topayment gateway, so if real fees are not stored in DB, system will have no record whenuser returns from payment gateway after making the payment

Access public

void function Action_Store::isLoggedUserASeller() [line 660]

Access private

void function Action_Store::processStoreForm() [line 425]

Access private

void function Action_Store::testStore() [line 414]testStore action, this action is used when PayMethod is set to Direct,

When PayMethod is set toInvoice, fees are not applied until user click on"Agree" button on fee page, but in Direct fee, fee are already applied when userreaches Fee page, (stored in Fee::FEES_USERS_TABLE table) When user want to keepthe Store in test mode (in case of Direct Fee), he click on "'Keep it as test"button, all related fee that were applied are removed from table the user is then forward tothe store home page

Page 120 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 160: Manual

Access public

Class Action_User [line 23]

Action UserAction for user operations

URL View template file /user userList.php/user/register userRegister.php/user/welcome userWelcome.php/user/login userLogin.php/user/profile userProfile.php/user/edit userEdit.php/user/delete userDelete.php/user/logout userLogout.php/user/favourites userFavourites.php

Package Action

void function Action_User::activeOffers() [line 496]force to close an active offer

Access public

void function Action_User::bids() [line 567]

Page 121 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 161: Manual

bidsshow bids a user has made

Access public

void function Action_User::bulkUpload() [line 1227]Function for creating Draft Auction by bulk uploading them

Access public

void function Action_User::closedOffers() [line 439]show closed offers and process action for relist an offer

Access public

void function Action_User::configureSellerGoogleCheckoutOptions($merchantId, $merchantKey, $amount, $item,[$shipping = 0.0]) [line 1428]

Function Parameters:

$merchantId $merchantKey $amount $item $shipping

configuring Google checkout button

Page 122 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 162: Manual

Access private

void function Action_User::configureSellerPaypalOptions($amount, $email, $item, [$shipping = 0.0],[$shippingOption = 2]) [line 1408]

Function Parameters:

$amount $email $item $shipping $shippingOption

configuring pay pal for sells between users

Access private

void function Action_User::confirm() [line 245]confirm

validates registration from mail Uses from parameters: ['id'] string login name['p'] string MD5($id.$email)

Access public

void function Action_User::defaultAction() [line 29]Default action

get a list of active users

Page 123 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 163: Manual

Access public

void function Action_User::draftOffers() [line 532]show list of draft offers

Access public

void function Action_User::edit() [line 839]edit profile

show user data form and process it

Access public

void function Action_User::favourites() [line 1149]user favourite action

Access public

void function Action_User::invoice() [line 1001]user invoice action

Access public

Page 124 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 164: Manual

void function Action_User::invoiceDetails() [line 1040]invoice details action

Access public

void function Action_User::leftFeedback() [line 715]left feedback

show feedback sent and sets a way to vote

Access public

void function Action_User::login() [line 310]login

shows login form and process it Uses from parameters: ['id'] string login name['pass'] string password

Access public

void function Action_User::logout() [line 929]logout

user logout

Access public

Page 125 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 165: Manual

void function Action_User::profile() [line 371]profile

show user data, and open/closed auctions

Access public

void function Action_User::receivedFeedback() [line 688]received feedback

show feedback received

Access public

void function Action_User::recoverPassword() [line 941]recoverPassword

user password recovery

Access public

void function Action_User::register() [line 58]register

shows new user form

Access public

Page 126 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 166: Manual

void function Action_User::soldItems() [line 656]usersold items action

Access public

void function Action_User::userFees() [line 1099]user fees

Access public

string function Action_User::verifyUserParameters($db, $par) [line 219]Function Parameters:

$db $par

test each parameter for correct input

Access private

void function Action_User::welcome() [line 114]welcome

receives data from user/register for inserting new user in DB

Page 127 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 167: Manual

Access public

void function Action_User::wonAuctions() [line 587]wonAuctions

show auctions won by the user

Access public

Class Action_UserPayMethod [line 11]

Action UserPayMethodAction for user paymethods operations

Package Action

void function Action_UserPayMethod::defaultAction() [line 13]

Access public

Page 128 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 168: Manual

Page 129 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 169: Manual

Package Action_Admin ProceduralElements

Banner.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 130 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 170: Manual

Category.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 131 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 171: Manual

Country.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 132 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 172: Manual

Currency.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 133 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 173: Manual

CustomAuctionFields.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 134 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 174: Manual

CustomFields.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 135 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 175: Manual

CustomPages.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 136 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 176: Manual

Fee.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 137 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 177: Manual

Index.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 138 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 178: Manual

Invoices.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 139 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 179: Manual

Offers.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 140 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 180: Manual

PayMethod.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 141 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 181: Manual

Settings.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 142 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 182: Manual

Store.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 143 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 183: Manual

Thematics.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 144 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 184: Manual

User.php

Package Action_AdminCopyright Copyright (c) 2009, enuuk

Page 145 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 185: Manual

Package Action_Admin Classes

Class Action_Admin_Banner [line 10]

Action for Admin backend Banner pages

Package Action_Admin

void function Action_Admin_Banner::activation() [line 188]

Access public

void function Action_Admin_Banner::add() [line 46]

Access public

void function Action_Admin_Banner::changeStatus($par, [$status = 0]) [line 208]Function Parameters:

$par $status

Page 146 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 186: Manual

function to toggle status of banner

Access private

void function Action_Admin_Banner::defaultAction() [line 15]Default action

Access public

void function Action_Admin_Banner::deleteBanner($par) [line 227]Function Parameters:

$par

function to delete banner

Access private

void function Action_Admin_Banner::editBanner() [line 71]

Access private

void function Action_Admin_Banner::processBannerForm() [line 110]

Page 147 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 187: Manual

Access private

Class Action_Admin_Category [line 10]

Action for Admin Category management

Package Action_Admin

void function Action_Admin_Category::add() [line 30]Add category action

Access public

void function Action_Admin_Category::defaultAction() [line 15]Default action

Access public

void function Action_Admin_Category::delete() [line 186]Delete category action

Access public

Page 148 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 188: Manual

void function Action_Admin_Category::edit() [line 102]Edit category Action

Access public

void function Action_Admin_Category::order() [line 228]order action

Access public

void function Action_Admin_Category::special() [line 254]special action

Access public

void function Action_Admin_Category::verifyOptionalParams($par) [line 295]Function Parameters:

$par

Function to verify optional parameters

Access private

Page 149 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 189: Manual

void function Action_Admin_Category::verifyParameters($par) [line 284]Function Parameters:

$par

function to verify

Access private

Class Action_Admin_Country [line 10]

Action for Admin backend Country pages

Package Action_Admin

void function Action_Admin_Country::activate() [line 82]

Access public

void function Action_Admin_Country::deactivate() [line 100]

Access public

Page 150 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 190: Manual

void function Action_Admin_Country::defaultAction() [line 12]

Access public

void function Action_Admin_Country::edit() [line 42]

Access public

Class Action_Admin_Currency [line 10]

Action for Admin backend Currency pages

Package Action_Admin

void function Action_Admin_Currency::add() [line 39]

Access private

void function Action_Admin_Currency::defaultAction() [line 12]

Access public

Page 151 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 191: Manual

void function Action_Admin_Currency::edit() [line 80]

Access private

Class Action_Admin_CustomAuctionFields [line 10]

CustomOfferFieldcustom fields back-end action

Package Action_Admin

void function Action_Admin_CustomAuctionFields::activate() [line 169]Activate action

Access public

void function Action_Admin_CustomAuctionFields::add() [line 19]

Access public

void function Action_Admin_CustomAuctionFields::defaultAction() [line 12]

Page 152 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 192: Manual

Access public

void function Action_Admin_CustomAuctionFields::delete() [line 220]delete field action

Access public

void function Action_Admin_CustomAuctionFields::edit() [line 81]

Access public

void function Action_Admin_CustomAuctionFields::suspend() [line 193]suspend of de-activate action

Access public

void function Action_Admin_CustomAuctionFields::verifyOptionalParams($par) [line 256]Function Parameters:

$par

Function to verify optional parameters

Access private

Page 153 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 193: Manual

Class Action_Admin_CustomFields [line 10]

CustomFieldcustom fields back-end action

Package Action_Admin

void function Action_Admin_CustomFields::activate() [line 160]Activate action

Access public

void function Action_Admin_CustomFields::add() [line 20]

Access public

void function Action_Admin_CustomFields::defaultAction() [line 12]

Access public

void function Action_Admin_CustomFields::delete() [line 208]delete field action

Page 154 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 194: Manual

Access public

void function Action_Admin_CustomFields::edit() [line 82]

Access public

void function Action_Admin_CustomFields::suspend() [line 184]suspend of de-activate action

Access public

void function Action_Admin_CustomFields::verifyOptionalParams($par) [line 270]Function Parameters:

$par

Function to verify optional parameters

Access private

void function Action_Admin_CustomFields::verifyParameters($par) [line 244]Function Parameters:

$par

Page 155 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 195: Manual

function to verify parameters

Access private

Class Action_Admin_CustomPages [line 10]

CustomPagescustom pages back-end action

Package Action_Admin

void function Action_Admin_CustomPages::activate() [line 186]Activate action

Access public

void function Action_Admin_CustomPages::add() [line 34]page Add action

Access public

Page 156 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 196: Manual

void function Action_Admin_CustomPages::defaultAction() [line 15]default action

Access public

void function Action_Admin_CustomPages::delete() [line 234]delete page action

Access public

void function Action_Admin_CustomPages::edit() [line 105]page edit action

Access public

void function Action_Admin_CustomPages::maxListedPages() [line 315]max Custom Pages action

Access public

void function Action_Admin_CustomPages::suspend() [line 210]suspend of de-activate action

Page 157 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 197: Manual

Access public

void function Action_Admin_CustomPages::verifyOptionalParams($par) [line 295]Function Parameters:

$par

function to verify optional parameters

Access private

void function Action_Admin_CustomPages::verifyParameters($par) [line 267]Function Parameters:

$par

function to verify parameters

Access private

Class Action_Admin_Fee [line 10]

Action for Admin backend Fee settings pages

Page 158 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 198: Manual

Package Action_Admin

void function Action_Admin_Fee::activate() [line 25]

Access public

void function Action_Admin_Fee::defaultAction() [line 12]

Access public

void function Action_Admin_Fee::details() [line 57]

Access public

void function Action_Admin_Fee::feeLangEdit() [line 173]action to edit fee title and description of particular fee

Access public

void function Action_Admin_Fee::feeLangList() [line 162]Action to display fee list for editing fee description and title

Access public

Page 159 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 199: Manual

void function Action_Admin_Fee::general() [line 20]

Access public

void function Action_Admin_Fee::suspend() [line 41]

Access public

void function Action_Admin_Fee::verifyOptionalParams($par) [line 140]Function Parameters:

$par

Function to verify optional parameters

Access private

Class Action_Admin_Index [line 10]

Action for Admin homepage

Package Action_Admin

Page 160 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 200: Manual

void function Action_Admin_Index::defaultAction() [line 15]Default action

Access public

Class Action_Admin_Invoices [line 10]

InvoiceInvoice back-end action

Package Action_Admin

void function Action_Admin_Invoices::defaultAction() [line 12]

Access public

void function Action_Admin_Invoices::deleteInvoice() [line 231]delete invoice action

Access public

void function Action_Admin_Invoices::headerFooter() [line 96]

Page 161 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 201: Manual

Invoice Header Footer update action

Access public

void function Action_Admin_Invoices::invoiceDetails() [line 319]invoice details action

Access public

void function Action_Admin_Invoices::paymentType() [line 358]payment type action

Access public

void function Action_Admin_Invoices::resendInvoice() [line 298]re-send invoice action

Access public

void function Action_Admin_Invoices::sendInvoices() [line 150]Send invoice Action

Access public

Page 162 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 202: Manual

void function Action_Admin_Invoices::sentInvoices() [line 184]sent invoices action

Access public

void function Action_Admin_Invoices::settings() [line 20]Invoice settings action

Access public

void function Action_Admin_Invoices::updateStatus() [line 270]invoice status toggle action

Access public

void function Action_Admin_Invoices::verifyHeaderFooter($par) [line 139]Function Parameters:

$par

Access private

void function Action_Admin_Invoices::verifyInvoiceSettings($par) [line 85]

Page 163 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 203: Manual

Function Parameters:

$par

Access private

Class Action_Admin_Offers [line 10]

Action for Admin backend Offers

Package Action_Admin

void function Action_Admin_Offers::activate() [line 55]

Access public

void function Action_Admin_Offers::auctionAutoExtension() [line 159]action auction auto extension

Access public

void function Action_Admin_Offers::bidIncrementSetting() [line 87]

Page 164 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 204: Manual

Access public

void function Action_Admin_Offers::deactivate() [line 71]

Access public

void function Action_Admin_Offers::defaultAction() [line 12]

Access public

void function Action_Admin_Offers::delete() [line 203]

Access public

void function Action_Admin_Offers::edit() [line 246]edit details

show offer data form and process it edit/id

Access public

int function Action_Admin_Offers::processOfferForm() [line 393]saves all data from the offerForm, and save it as draft

Access private

Page 165 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 205: Manual

void function Action_Admin_Offers::publishOffer($offer) [line 695]Function Parameters:

Offer $offer

Access private

void function Action_Admin_Offers::types() [line 131]

Access public

Class Action_Admin_PayMethod [line 10]

Action for Admin backend Pay method pages

Package Action_Admin

void function Action_Admin_PayMethod::activate() [line 172]

Access public

Page 166 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 206: Manual

void function Action_Admin_PayMethod::add() [line 23]

Access public

void function Action_Admin_PayMethod::deactivate() [line 188]

Access public

void function Action_Admin_PayMethod::defaultAction() [line 15]Default action

Access public

void function Action_Admin_PayMethod::delete() [line 75]

Access public

void function Action_Admin_PayMethod::edit() [line 109]

Access public

void function Action_Admin_PayMethod::verifyOptionalParams($par) [line 207]Function Parameters:

$par

Function to verify optional parameters

Page 167 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 207: Manual

Access private

Class Action_Admin_Settings [line 10]

Action for Admin backend Settings pages

Package Action_Admin

void function Action_Admin_Settings::addLanguage($par, &$data, $data) [line 250]Function Parameters:

array $par input parametersarray $data &$data

Function to add new language

Access private

void function Action_Admin_Settings::addThisSetting() [line 1092]

Access public

Page 168 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 208: Manual

void function Action_Admin_Settings::auctionRelisting() [line 782]action function for max auction relisting

Access public

void function Action_Admin_Settings::bannerSettings() [line 538]Banner action

Access public

void function Action_Admin_Settings::captchaSetting() [line 1066]

Access public

void function Action_Admin_Settings::defaultAction() [line 15]Default action

Access public

void function Action_Admin_Settings::defaultCurrency() [line 716]default currency action

Access public

Page 169 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 209: Manual

void function Action_Admin_Settings::defaultLanguage() [line 928]

Access public

void function Action_Admin_Settings::editLanguage($par, &$data, $obj, $data) [line 289]Function Parameters:

array $par input parametersarray $data contexts data array &$data Language $obj

Function to updating the language

Access private

void function Action_Admin_Settings::feedbackSetting() [line 1039]

Access public

void function Action_Admin_Settings::googleAnalytics() [line 847]function to setup google analytics id

Access public

void function Action_Admin_Settings::homeRefresh() [line 1012]

Page 170 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 210: Manual

Access public

void function Action_Admin_Settings::imageGallerySetting() [line 951]

Access public

void function Action_Admin_Settings::itemsListing() [line 179]

Access public

void function Action_Admin_Settings::languages() [line 64]Language settings

Access public

void function Action_Admin_Settings::maxImageUploadSize() [line 749]maxImageUploadSize

Access public

void function Action_Admin_Settings::metaTags() [line 638]function to update metatags

Page 171 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 211: Manual

Access public

void function Action_Admin_Settings::paypalSettings() [line 390]Paypal settings action

Access public

void function Action_Admin_Settings::signupConfirmation() [line 822]action for user Signup Confirmation

Access public

void function Action_Admin_Settings::siteDesign() [line 334]

Access public

void function Action_Admin_Settings::sslSetting() [line 982]

Access public

void function Action_Admin_Settings::timezone() [line 884]action to setup a default timezone

Access public

Page 172 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 212: Manual

void function Action_Admin_Settings::verifyBannerSettings($par) [line 623]Function Parameters:

$par

function to verify

Access private

void function Action_Admin_Settings::verifyLanguageParams($par) [line 226]Function Parameters:

$par

Function to verify

Access private

void function Action_Admin_Settings::verifyMetaTags($par) [line 699]Function Parameters:

$par

function to verify meta

Access private

Page 173 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 213: Manual

Class Action_Admin_Store [line 10]

StoreStore back-end action

Package Action_Admin

void function Action_Admin_Store::defaultAction() [line 12]

Access public

void function Action_Admin_Store::doActivate($par) [line 87]Function Parameters:

$par

Access private

void function Action_Admin_Store::doDeactivate($par) [line 74]Function Parameters:

$par

Page 174 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 214: Manual

action specific functions

Access private

void function Action_Admin_Store::doDelete($par) [line 100]Function Parameters:

$par

Access private

Class Action_Admin_Thematics [line 10]

CustomPagescustom pages back-end action

Package Action_Admin

void function Action_Admin_Thematics::activate() [line 153]activate action

Page 175 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 215: Manual

Access public

void function Action_Admin_Thematics::add() [line 26]page Add action

Access public

void function Action_Admin_Thematics::defaultAction() [line 15]

Access public

void function Action_Admin_Thematics::delete() [line 193]

Access public

void function Action_Admin_Thematics::edit() [line 80]page edit action

Access public

void function Action_Admin_Thematics::suspend() [line 173]

Access public

Page 176 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 216: Manual

void function Action_Admin_Thematics::verifyOptionalParams($par) [line 253]Function Parameters:

$par

Function to verify optional parameters

Access private

void function Action_Admin_Thematics::verifyParameters($par) [line 227]Function Parameters:

$par

function to verify parameters

Access private

Class Action_Admin_User [line 11]

Action for Admin backend Settings pages

Package Action_Admin

Page 177 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 217: Manual

void function Action_Admin_User::activate() [line 443]reactivate action

Access public

void function Action_Admin_User::ban() [line 725]

Access public

void function Action_Admin_User::bannedEmails() [line 775]

Access public

void function Action_Admin_User::bids() [line 676]user bid action

Access public

void function Action_Admin_User::defaultAction() [line 16]Default action

Access public

Page 178 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 218: Manual

void function Action_Admin_User::delete() [line 129]Delete Action

Access public

void function Action_Admin_User::deleteConfirm() [line 105]delete confirm action

Access public

void function Action_Admin_User::displayUserOffers($user) [line 665]Function Parameters:

User $user

display user offers

Access private

void function Action_Admin_User::edit() [line 261]export action

Access public

void function Action_Admin_User::feedback() [line 644]

Page 179 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 219: Manual

User feedback action

Access public

void function Action_Admin_User::filter() [line 229]filter action

Access public

void function Action_Admin_User::invoice() [line 546]invoice Action

Access public

void function Action_Admin_User::invoiceDetails() [line 573]invoiceDetail Action

Access public

void function Action_Admin_User::newUserType() [line 600]default new user type action

Access public

Page 180 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 220: Manual

void function Action_Admin_User::offers() [line 467]Offers Action

Access public

void function Action_Admin_User::search() [line 52]Search action

Access public

void function Action_Admin_User::suspend() [line 91]suspend

Access public

void function Action_Admin_User::suspendConfirm() [line 73]suspend action

Access public

void function Action_Admin_User::unban() [line 755]

Access public

Page 181 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 221: Manual

void function Action_Admin_User::verifyCustomParameters($par, $customFields) [line 387]Function Parameters:

$par $customFields

function to verify custom fields

Access public

string function Action_Admin_User::verifyUserParameters($par) [line 372]Function Parameters:

$par

test each parameter for correct input

Access private

void function Action_Admin_User::viewip() [line 404]View IP action

Access public

Page 182 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 222: Manual

Page 183 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 223: Manual

Package Core Procedural Elements

Action.php

Package CoreCopyright Copyright (c) 2009, enuuk

Page 184 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 224: Manual

Context.php

Package CoreCopyright Copyright (c) 2009, enuuk

Page 185 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 225: Manual

Controller.php

Package CoreCopyright Copyright (c) 2009, enuuk

Page 186 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 226: Manual

View.php

Package CoreCopyright Copyright (c) 2009, enuuk

Page 187 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 227: Manual

Package Core Classes

Class Core_Action [line 11]

Core_ActionBase class to extend concrete actions

Package CoreAbstract Element

Core_Action::$context

Core_Context = [line 17]

Object Core_Context with all data

Access protected

Core_Action::$db

MyPDO = [line 22]

Reference to DB conection

Page 188 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 228: Manual

Var DB objectAccess protected

Core_Action::$requestedMethod

string = [line 27]

Method to call

Access protected

Constructor void function Core_Action::__construct() [line 36]Public constructor

Some variables are populated with default values, an instance of PDO DB abstraction iscreated, and later general options (stored in DB) are loaded.

Access public

void function Core_Action::defaultAction() [line 142]Default action to call if no user parameters received.

Abstract method to be implemented by extended classes.

Abstract Element

void function Core_Action::filterInputStrings($inputs) [line 176]Function Parameters:

Page 189 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 229: Manual

$inputs

Removes slashes from input strings,improves URL surrounding them with <a>, changes "," to "."

in non-English floats

Access private

Core_Context function Core_Action::getContext() [line 148]Returns object context

Access public

void function Core_Action::preprocessContext() [line 64]Preprocess user parameters.

Get user parameters and populate some parameters if not present in user call, likemethod to call. Also verifies if session is present: cookies called "sessionLogin"and "sessionId" should match to an "id" and"sessionCookie" columns in DB table V5_users; in that case user information iscollected. Also verifies language settings in "langCookie" or "lang".Moreover loads general options stored in DB.

Access public

void function Core_Action::run() [line 121]Executes method defined if it exists, otherwise defaultAction is called.

Page 190 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 230: Manual

Access public

void function Core_Action::setContext($context) [line 49]Function Parameters:

Core_Context $context

Access public

void function Core_Action::verifyLoggedUser() [line 158]Checks if there is a currently logged in user

Access protected

void function Core_Action::__destruct() [line 44]Public destructor

Access public

Class Core_Context [line 11]

Page 191 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 231: Manual

Core_ContextStorage for keeping all "enviroment" information: user request data, relative

path, data returned by Action, etc

Package Core

Core_Context::$_data

array = [line 37]

Array containing the data after the execution of the model

Access private

Core_Context::$_errorMessage

string = [line 27]

Error message, to show to the user

Access private

Core_Context::$_HTTPHost

string = [line 68]

Server domain.For example, www.example.com

Page 192 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 232: Manual

Var pathAccess private

Core_Context::$_language

string = [line 48]

Language selected by userby default is "en_US"

Var languageAccess private

Core_Context::$_loggedUser

User = [line 42]

Object User with data for logged user

Var user's dataAccess private

Core_Context::$_message

string = [line 22]

Feedback message, to show to the user in case of success

Access private

Page 193 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 233: Manual

Core_Context::$_parameters

array = [line 32]

Array for the user request parameters

Access private

Core_Context::$_relativePath

string = [line 61]

Path of the web within the server.For example, if application is located in "/usr/www/V5/" and Apache

DocumentRoot is "/usr/www", this variable will contain "/V5/"

Var pathAccess private

Core_Context::$_siteOptions

array = [line 53]

Array with general options for the site, loaded from DB

Var options options from databaseAccess private

Core_Context::$_status

boolean = [line 17]

Flag to show if request was processed without errors

Page 194 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 234: Manual

Access private

Constructor void function Core_Context::__construct() [line 73]Public constructor

Access public

bool function Core_Context::addData($data) [line 108]Function Parameters:

array $data array with more new data

merge new data with existing data

Access public

array function Core_Context::toArray() [line 123]Creates an array for the View with the needed data.

"parameters" are not included, "loggedUser" is converted to arrayand "data" is expanded in same level as the rest of properties

Access public

void function Core_Context::__get($property) [line 82]

Page 195 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 235: Manual

Function Parameters:

$property

Access public

void function Core_Context::__set($property, $value) [line 92]Function Parameters:

$property $value

Access public

Class Core_Controller [line 17]

Core_Controller manage user request thru concrete Action and View.Core_Controller enroutes the user call to the correct Action. The first directory of user

request is used as Action name, for example, /category/Arts -> Action_Category is called.With the data returned from Actionl call, a View is instanciated. By default View_HTML isused, unless a parameter "v" is present in user parameters (actually is the Actionwho verifies this).

Package Core

Page 196 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 236: Manual

Core_Controller::$_actionToCall

string = [line 25]

Variable to store the name of the Action defined in the URL request.Example: /user/john -> "User"

Var action nameAccess private

Core_Controller::$_context

Core_Context = [line 38]

Storage of all needed data for the Action and the View.

Var nameAccess private

Core_Controller::$_viewToCall

string = [line 32]

Name of the View defined in the URL request by the parameter "v".By default is View_HTML

Var view nameAccess private

Constructor void function Core_Controller::__construct() [line 44]Public constructor.

Page 197 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 237: Manual

Just creates an instance of Core_Context class

Access public

array function Core_Controller::getParameters() [line 101]Return the properties $_actionToCall and $_parameters.

(Used just for testing)

Access public

void function Core_Controller::processParameters(&$server, &$request, $server, $request) [line 56]Function Parameters:

array $server is normally superglobal $_SERVERarray $request is normally superglobal $_REQUEST &$server &$request

Get the URL called and the REQUEST parameters, to resolve $_actionToCall andparameters in the Context object.

Access public

void function Core_Controller::run() [line 182]Call the chosen Action, get the data returned and call the chosen View

Page 198 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 238: Manual

Access public

bool function Core_Controller::verifyInputAgainstHacks($request, [$isBackEnd = 0]) [line 112]Function Parameters:

$request $isBackEnd

Check the request input against a list of filters, for trying to detect HACK attacks

Access public

Class Core_View [line 11]

Core_ViewBase class to extend concrete Views

Package CoreAbstract Element

Core_View::$context

array = [line 17]

Data to show

Page 199 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 239: Manual

Access protected

void function Core_View::display() [line 31]Executes View.

Abstract method to be implemented by extended classes

Abstract Element Access public

void function Core_View::setContext($context, $data) [line 23]Function Parameters:

array $data dataCore_Context $context

Receives data to paint

Access public

Page 200 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 240: Manual

Page 201 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 241: Manual

Package general Procedural Elements

BannedEmail.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 202 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 242: Manual

Banner.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 203 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 243: Manual

Bid.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 204 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 244: Manual

BidIncrement.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 205 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 245: Manual

BidPack.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 206 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 246: Manual

Category.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 207 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 247: Manual

PresentationData.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 208 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 248: Manual

Country.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 209 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 249: Manual

Cron.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 210 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 250: Manual

Currency.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 211 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 251: Manual

CustomField.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 212 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 252: Manual

CustomOfferField.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 213 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 253: Manual

CustomPage.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 214 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 254: Manual

DBReadable.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 215 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 255: Manual

DBSearchable.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 216 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 256: Manual

DBWritable.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 217 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 257: Manual

Favourite.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 218 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 258: Manual

Fee.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 219 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 259: Manual

FeeRangeContainer.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 220 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 260: Manual

FixedAuction.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 221 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 261: Manual

Image.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 222 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 262: Manual

Invoice.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 223 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 263: Manual

Item.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 224 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 264: Manual

Language.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 225 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 265: Manual

LotAuction.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 226 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 266: Manual

Message.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 227 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 267: Manual

MetaTag.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 228 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 268: Manual

Offer.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 229 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 269: Manual

OffersQuestion.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 230 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 270: Manual

PayMethod.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 231 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 271: Manual

Paypal.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 232 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 272: Manual

PennyAuction.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 233 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 273: Manual

ReverseAuction.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 234 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 274: Manual

SiteOptions.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 235 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 275: Manual

StandardAuction.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 236 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 276: Manual

Store.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 237 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 277: Manual

StoreSize.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 238 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 278: Manual

Thematic.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 239 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 279: Manual

Timezone.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 240 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 280: Manual

User.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 241 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 281: Manual

UserFeedback.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 242 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 282: Manual

UserPayMethod.php

Package generalCopyright Copyright (c) 2009, enuuk

Page 243 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 283: Manual

Package general Classes

Class BannedEmail [line 10]

BannedEmail

Package general

BannedEmail::DB_TABLE

= 'V5_bannedEmails' [line 15]

DB Tables

BannedEmail::$_email

mixed = [line 17]

Access private

void function BannedEmail::deleteFromDB($DB) [line 87]Function Parameters:

MyPDO $DB

Page 244 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 284: Manual

Access public

void function BannedEmail::getInstanceFromDB($DB, $id) [line 46]Function Parameters:

MyPDO $DB $id

Static Access public

void function BannedEmail::getListFromDB($DB, [$restrictions = '']) [line 62]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function BannedEmail::saveToDB($DB) [line 74]Function Parameters:

MyPDO $DB

Access public

Page 245 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 285: Manual

void function BannedEmail::__get($property) [line 19]Function Parameters:

$property

Access public

void function BannedEmail::__set($property, $value) [line 29]Function Parameters:

$property $value

Access public

Class Banner [line 9]

Banner class

Package general

Page 246 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 286: Manual

Banner::BANNER_HTML

= 'HTML' [line 17]

Banner::BANNER_IMAGE

= 'IMAGE' [line 16]

Banner::DB_TABLE

= 'V5_banners' [line 14]

database table

Banner::$_active

mixed = [line 24]

Access private

Banner::$_bannerHTML

mixed = [line 23]

Access private

Banner::$_id

mixed = [line 19]

Access private

Banner::$_image

mixed = [line 21]

Page 247 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 287: Manual

Access private

Banner::$_type

mixed = [line 20]

Access private

Banner::$_url

mixed = [line 22]

Access private

Constructor void function Banner::__construct() [line 26]

Access public

void function Banner::deleteFromDB($DB) [line 168]Function Parameters:

MyPDO $DB

Access public

void function Banner::getBanner($DB) [line 181]Function Parameters:

Page 248 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 288: Manual

MyPDO $DB

Static Access public

void function Banner::getInstanceFromDB($DB, $id) [line 97]Function Parameters:

MyPDO $DB $id

Static Access public

void function Banner::getListFromDB($DB, [$restrictions = '']) [line 119]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Banner::saveToDB($DB) [line 135]Function Parameters:

MyPDO $DB

Page 249 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 289: Manual

Access public

void function Banner::validURL($url) [line 80]Function Parameters:

$url

Access private

void function Banner::__get($property) [line 34]Function Parameters:

$property

Access public

void function Banner::__set($property, $value) [line 44]Function Parameters:

$property $value

Access public

Page 250 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 290: Manual

Class Bid [line 16]

Bid classThis is an individual bid made on an offer (auction). Usually $comment is empty, but in

standardAuction offers the proxibidding value is stored there, as "realbid=XX".

Package general

Bid::DB_TABLE

= 'V5_bids' [line 18]

Bid::$comment

mixed = [line 24]

Access protected

Bid::$date

mixed = [line 23]

Access protected

Bid::$id

mixed = [line 19]

Page 251 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 291: Manual

Access protected

Bid::$offer

mixed = [line 20]

Access protected

Bid::$user

mixed = [line 21]

Access protected

Bid::$value

mixed = [line 22]

Access protected

Constructor void function Bid::__construct() [line 26]

Access public

bool function Bid::deleteFromDB($DB) [line 141]Function Parameters:

MyPDO $DB database instance

Page 252 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 292: Manual

remove bid from DB

Access public

void function Bid::getInstanceFromDB($DB, $id) [line 61]Function Parameters:

MyPDO $DB $id

Static Access public

void function Bid::getListFromDB($DB, [$restrictions = '']) [line 89]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Bid::saveToDB($DB) [line 101]Function Parameters:

MyPDO $DB

Page 253 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 293: Manual

Access public

void function Bid::__get($property) [line 31]Function Parameters:

$property

Access public

void function Bid::__set($property, $value) [line 40]Function Parameters:

$property $value

Access public

Class BidIncrement [line 10]

BidIncrementclass to manage bid increment

Package general

Page 254 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 294: Manual

BidIncrement::DB_TABLE

= 'V5_bidIncrements' [line 15]

DB Tables

BidIncrement::$_bottom

mixed = [line 18]

Access private

BidIncrement::$_id

mixed = [line 17]

Access private

BidIncrement::$_increment

mixed = [line 20]

Access private

BidIncrement::$_ranges

mixed = [line 21]

Access private

Page 255 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 295: Manual

BidIncrement::$_top

mixed = [line 19]

Access private

void function BidIncrement::addIncrementRange($bottom, $top, [$increment = 0]) [line 91]Function Parameters:

int $bottom start value of the rangeint $top end value of the rangefloat $increment increment for this range

Function to add new increment range

Access public

numeric function BidIncrement::getBidIncrement($DB, $amount) [line 73]Function Parameters:

numeric $amount amount to retrieve percent charge forMyPDO $DB

function to retrieve percent charge

Static Access public

void function BidIncrement::getInstanceFromDB($DB, $id) [line 43]

Page 256 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 296: Manual

Function Parameters:

MyPDO $DB $id

Static Access public

void function BidIncrement::getListFromDB($DB, [$restrictions = '']) [line 61]Function Parameters:

MyPDO $DB $restrictions

Static Access public

bool function BidIncrement::rangeValueExists($bottom, $top) [line 116]Function Parameters:

int $bottom start valueint $top end value

function to check overlapping increment ranges

Access private

void function BidIncrement::saveToDB($DB) [line 131]

Page 257 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 297: Manual

Function Parameters:

MyPDO $DB

Access public

void function BidIncrement::__get($property) [line 23]Function Parameters:

$property

Access public

void function BidIncrement::__set($property, $value) [line 33]Function Parameters:

$property $value

Access public

Class BidPack [line 9]

Page 258 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 298: Manual

BidPack class

Package general

BidPack::DB_TABLE

= 'V5_bidPacks' [line 14]

Database table

BidPack::$_active

mixed = [line 19]

Access private

BidPack::$_id

mixed = [line 16]

Access private

BidPack::$_number

mixed = [line 17]

Access private

BidPack::$_price

mixed = [line 18]

Page 259 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 299: Manual

Access private

void function BidPack::deleteFromDB($DB) [line 115]Function Parameters:

MyPDO $DB

Remove record from database

Access public

void function BidPack::getInstanceFromDB($DB, $id) [line 64]Function Parameters:

MyPDO $DB $id

Static Access public

void function BidPack::getListFromDB($DB, [$restrictions = '']) [line 58]Function Parameters:

MyPDO $DB $restrictions

Page 260 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 300: Manual

Static Access public

void function BidPack::saveToDB($DB) [line 82]Function Parameters:

MyPDO $DB

Access public

void function BidPack::__get($property) [line 21]Function Parameters:

$property

Access public

void function BidPack::__set($property, $value) [line 31]Function Parameters:

$property $value

Access public

Page 261 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 301: Manual

Class Category [line 9]

Categories of items

Package general

Category::CAT_LANG_TABLE

= 'V5_categories_languages' [line 12]

Category::DB_TABLE

= 'V5_categories' [line 11]

Category::ORDER_ALPHABETICALLY

= 'ALPHABETICALLY' [line 17]

category order constants

Category::ORDER_MANUALLY

= 'MANUALLY' [line 19]

Category::ORDER_MAX_OFFERS

= 'OFFERS' [line 18]

Category::ORDER_MAX_SPECIAL

= 'MAX_SPECIAL' [line 22]

Category::ORDER_SPECIAL

= 'SPECIAL' [line 20]

Category::ORDER_SPECIAL_ALPHA

= 'SPECIAL_ALPHA' [line 21]

Category::ORDER_SPECIAL_MANUALLY

= 'SPECIAL_MANUALLY' [line 23]

Page 262 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 302: Manual

Category::$cachedCategories

mixed = [line 38]

cached table

Static Access private

Category::$cachedCategoriesLang

mixed = [line 39]

Static Access private

Category::$_active

mixed = [line 30]

Access private

Category::$_id

mixed = [line 28]

class properties

Access private

Category::$_name

Page 263 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 303: Manual

mixed = [line 31]

Access private

Category::$_order

mixed = [line 32]

Access private

Category::$_parent

mixed = [line 29]

Access private

Category::$_special

mixed = [line 33]

Access private

Constructor void function Category::__construct() [line 44]constructor

Access public

Page 264 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 304: Manual

void function Category::addName($language, $name) [line 89]Function Parameters:

$language $name

Function to add name for a particular language

Access public

void function Category::deleteFromDB($DB) [line 478]Function Parameters:

MyPDO $DB

Function to delete categories

Access public

int function Category::discoverCatId($DB, $s, $lang) [line 244]Function Parameters:

MyPDO $DB Database instancestring $s category path the string should be someCat/subCat formatstring $lang language language id

Discover id function to seach category id

Page 265 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 305: Manual

Static Access public

void function Category::discoverId($DB, $s) [line 214]Function Parameters:

MyPDO $DB $s

Given a string, verify if it's category id or category name or nothing.

Static Access public

void function Category::getCachedCategories($DB) [line 188]Function Parameters:

MyPDO $DB

Get the cached categories table, and populate it if it's the first time it's called

Static Access private

void function Category::getCachedCategoriesLang($DB, $lang) [line 202]Function Parameters:

MyPDO $DB $lang

Page 266 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 306: Manual

Get the cached categories table, and populate it if it's the first time it's called

Static Access private

void function Category::getInstanceFromDB($DB, $id) [line 106]Function Parameters:

MyPDO $DB $id

Static Access public

void function Category::getListFromDB($DB, [$restrictions = '']) [line 131]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Category::getName($language) [line 97]Function Parameters:

$language

Page 267 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 307: Manual

Function to retrieve name for a particular language

Access public

array function Category::getOrderedListFromDB($DB, [$restrictions = ''], [$sortingType =self::ORDER_ALPHABETICALLY]) [line 430]

Function Parameters:

MyPDO $DB database instance$restrictions $restrictions optional$sortingType $sortingType order list by this option

function to return sorted list of categories depending upon sorting type

Access public

void function Category::getParentAndChildID($DB, $catId) [line 326]Function Parameters:

MyPDO $DB database objectint $catId

function to return parent and all childs of a given category

Static Access public

void function Category::getSortedListFromDB($DB, [$restrictions = '']) [line 375]

Page 268 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 308: Manual

Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Category::getSubcatsFromDB($DB, $id) [line 310]Function Parameters:

MyPDO $DB $id

Static Access public

bool function Category::hasSubcats($DB, $id, $catId) [line 290]Function Parameters:

MyPDO $DB MyPDO instanceint $catId id of the category to be checked $id

Check if it is a category with sub cats

Static Access public

Page 269 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 309: Manual

array function Category::makeCatBreadCrumb($DB, $catId, $lang, $existing, $addCat) [line 350]Function Parameters:

string $existing existing breadcrumb trailstring $addCat category to be addedstring $lang language parameterMyPDO $DB $catId

function to construct breadcrumb for Categories

Static Access public

void function Category::saveToDB($DB) [line 140]Function Parameters:

MyPDO $DB

Access public

void function Category::__get($property) [line 55]Function Parameters:

$property

interceptors

Access public

Page 270 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 310: Manual

void function Category::__set($property, $value) [line 66]Function Parameters:

$property $value

Access public

Class Core_PresentationData [line 14]

Core_PresentationDataJust retrieves needed common data for all pages

Basically header, menu and footer dinamic data.

Package general

void function Core_PresentationData::getCustomPagesData($DB, $lang) [line 56]Function Parameters:

MyPDO $DB $lang

Page 271 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 311: Manual

Static Access public

void function Core_PresentationData::getData($DB, $context) [line 16]Function Parameters:

MyPDO $DB Core_Context $context

Static Access public

void function Core_PresentationData::getGoogleAnalyticsCode($context) [line 125]Function Parameters:

Core_Context $context

Function to return Google Analytics code

Static Access public

void function Core_PresentationData::getLanguageDirection([$lang = 'en_US'], $availableLanguages) [line 107]Function Parameters:

$lang $availableLanguages

Function to retrieve language orientation

Page 272 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 312: Manual

Static Access public

void function Core_PresentationData::getLanguages($DB) [line 64]Function Parameters:

MyPDO $DB

Static Access public

void function Core_PresentationData::getMetaInfo($DB, [$lang = 'en_US']) [line 88]Function Parameters:

MyPDO $DB $lang

Function to retrieve meta

Static Access public

void function Core_PresentationData::getStatistics($DB) [line 72]Function Parameters:

MyPDO $DB

Page 273 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 313: Manual

get message statistics

Static Access public

Class Country [line 9]

Country

Package general

Country::DB_TABLE

= 'V5_countries' [line 11]

Country::$_active

mixed = [line 15]

Access private

Country::$_id

mixed = [line 13]

Access private

Page 274 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 314: Manual

Country::$_name

mixed = [line 14]

Access private

void function Country::getInstanceFromDB($DB, $id) [line 44]Function Parameters:

MyPDO $DB $id

Static Access public

void function Country::getListFromDB($DB, [$restrictions = '']) [line 59]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Country::getListOfCountriesWithUsers($DB) [line 65]Function Parameters:

MyPDO $DB

Page 275 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 315: Manual

Static Access public

void function Country::saveToDB($DB) [line 80]Function Parameters:

MyPDO $DB

Access public

void function Country::__get($property) [line 17]Function Parameters:

$property

Access public

void function Country::__set($property, $value) [line 27]Function Parameters:

$property $value

Access public

Page 276 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 316: Manual

Class Cron [line 12]

Cron closes open auctions.It is called in Core_Action::run(), before the code of the requested action is executed.

Package general

void function Cron::closeExpiredOffers($DB, $context) [line 34]Function Parameters:

MyPDO $DB Core_Context $context

Static Access public

void function Cron::openDatePendingOffers($DB, $context) [line 21]Function Parameters:

MyPDO $DB Core_Context $context

Static Access public

Page 277 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 317: Manual

void function Cron::relistOffers($DB, $context) [line 169]Function Parameters:

MyPDO $DB Core_Context $context

Static Access public

void function Cron::run($DB, $context) [line 14]Function Parameters:

MyPDO $DB Core_Context $context

Static Access public

Class Currency [line 9]

Currency class

Package general

Page 278 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 318: Manual

Currency::DB_TABLE

= 'V5_currencies' [line 14]

Database table

Currency::$_id

mixed = [line 15]

Access private

Currency::$_name

mixed = [line 16]

Access private

string function Currency::getConverterURL($defaultCurrency, [$amount = 0]) [line 104]Function Parameters:

$defaultCurrency $defaultCurrency string 3 letter code for default currency$amount $amount float default amount of money to convert

Returns an URL where you get displayed a currency converterIn case of USD as default currency, it shows by default the exchange USD -> EUR,

otherwise displays defaultCurrency -> USD

Static Access public

Page 279 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 319: Manual

void function Currency::getInstanceFromDB($DB, $id) [line 56]Function Parameters:

MyPDO $DB $id

Static Access public

void function Currency::getListFromDB($DB, [$restrictions = '']) [line 50]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Currency::saveToDB($DB) [line 74]Function Parameters:

MyPDO $DB

Access public

void function Currency::__get($property) [line 18]Function Parameters:

Page 280 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 320: Manual

$property

Access public

void function Currency::__set($property, $value) [line 28]Function Parameters:

$property $value

Access public

Class CustomField [line 9]

CustomField

Package general

CustomField::DB_LANGUAGE_TABLE

= 'V5_userFields_languages' [line 15]

CustomField::DB_TABLE

= 'V5_userFields' [line 14]

Page 281 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 321: Manual

db tables

CustomField::TYPE_INPUT

= 'INPUT' [line 21]

custom field type inputinput type="text"

CustomField::TYPE_TEXTAREA

= 'TEXTAREA' [line 26]

custom field type textarea

CustomField::$_active

mixed = [line 34]

Access private

CustomField::$_id

mixed = [line 31]

member variables

Access private

CustomField::$_mandatory

mixed = [line 32]

Access private

Page 282 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 322: Manual

CustomField::$_name

mixed = [line 35]

Access private

CustomField::$_showInProfile

mixed = [line 33]

Access private

CustomField::$_type

mixed = [line 36]

Access private

Constructor void function CustomField::__construct() [line 38]

Access public

void function CustomField::addName($lang, $name) [line 228]Function Parameters:

string $lang Language ID to add name forstring $name name for the field

Function to add custom field name to name array

Page 283 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 323: Manual

Access public

void function CustomField::deleteFromDB($DB) [line 175]Function Parameters:

MyPDO $DB

Access public

bool function CustomField::fieldExists($DB, $fieldName, [$restrictions = '']) [line 189]Function Parameters:

MyPDO $DB database instancestring $fieldName name of custom field to checkstring $restrictions optional restriction

Function to check if specified custom user field already exist

Static Access public

void function CustomField::getInstanceFromDB($DB, $id) [line 78]Function Parameters:

MyPDO $DB $id

Page 284 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 324: Manual

Static Access public

void function CustomField::getListFromDB($DB, [$restrictions = '']) [line 108]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function CustomField::getName($lang) [line 236]Function Parameters:

$lang

Function to retrieve custom field name for the language

Access public

bool function CustomField::isActive($DB, $fieldId) [line 209]Function Parameters:

MyPDO $DB database instanceint $fieldId field to check

Function to check if specified field is active

Page 285 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 325: Manual

Static Access public

void function CustomField::saveToDB($DB) [line 117]Function Parameters:

MyPDO $DB

Saving the records to database

Access public

void function CustomField::__get($property) [line 50]Function Parameters:

$property

interceptors

Access public

void function CustomField::__set($property, $value) [line 60]Function Parameters:

$property $value

Page 286 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 326: Manual

Access public

Class CustomOfferField [line 9]

CustomOfferField

Package general

CustomOfferField::DB_LANGUAGE_TABLE

= 'V5_offersFields_languages' [line 15]

CustomOfferField::DB_TABLE

= 'V5_offersFields' [line 14]

db tables

CustomOfferField::$_active

mixed = [line 23]

Access private

CustomOfferField::$_id

mixed = [line 20]

member variables

Page 287 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 327: Manual

Access private

CustomOfferField::$_mandatory

mixed = [line 21]

Access private

CustomOfferField::$_name

mixed = [line 24]

Access private

CustomOfferField::$_showInAuctionDetails

mixed = [line 22]

Access private

CustomOfferField::$_type

mixed = [line 25]

Access private

Page 288 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 328: Manual

Constructor void function CustomOfferField::__construct() [line 27]

Access public

void function CustomOfferField::addName($lang, $name, [$defaultLang = 'en_US']) [line 215]Function Parameters:

string $lang Language ID to add name forstring $name name for the field $defaultLang

Function to add custom auction field name to name array

Access public

void function CustomOfferField::deleteFromDB($DB) [line 163]Function Parameters:

MyPDO $DB

Access public

bool function CustomOfferField::fieldExists($DB, $fieldName, [$restrictions = '']) [line 177]Function Parameters:

MyPDO $DB database instancestring $fieldName name of custom auction field to checkstring $restrictions optional restriction

Page 289 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 329: Manual

Function to check if specified custom user field already exist

Static Access public

void function CustomOfferField::getInstanceFromDB($DB, $id) [line 67]Function Parameters:

MyPDO $DB $id

Static Access public

void function CustomOfferField::getListFromDB($DB, [$restrictions = '']) [line 96]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function CustomOfferField::getName($lang) [line 226]Function Parameters:

$lang

Page 290 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 330: Manual

Function to retrieve custom auction field name for the language

Access public

bool function CustomOfferField::isActive($DB, $fieldId) [line 197]Function Parameters:

MyPDO $DB database instanceint $fieldId field to check

Function to check if specified custom auction field is active

Static Access public

void function CustomOfferField::saveToDB($DB) [line 109]Function Parameters:

MyPDO $DB

Saving the records to database

Access public

void function CustomOfferField::__get($property) [line 38]Function Parameters:

$property

Page 291 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 331: Manual

interceptors

Access public

void function CustomOfferField::__set($property, $value) [line 48]Function Parameters:

$property $value

Access public

Class CustomPage [line 9]

CustomPage

Package general

CustomPage::CUSTOM_PAGE_LANGUAGE_TABLE

= 'V5_customPages_languages' [line 15]

CustomPage::DB_TABLE

Page 292 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 332: Manual

= 'V5_customPages' [line 14]

Database tables

CustomPage::$_active

mixed = [line 23]

Access private

CustomPage::$_date

mixed = [line 22]

Access private

CustomPage::$_id

mixed = [line 20]

member variables

Access private

CustomPage::$_text

mixed = [line 24]

Access private

CustomPage::$_thematicId

Page 293 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 333: Manual

mixed = [line 21]

Access private

CustomPage::$_title

mixed = [line 25]

Access private

Constructor void function CustomPage::__construct() [line 28]

Access public

void function CustomPage::addText($language, $text) [line 199]Function Parameters:

$language $text

Functions to add new page data

Access public

void function CustomPage::addTitle($language, $title) [line 204]Function Parameters:

$language

Page 294 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 334: Manual

$title

Access public

void function CustomPage::deleteFromDB($DB) [line 190]Function Parameters:

MyPDO $DB

deleting the page from database

Access public

void function CustomPage::discoverId($DB, $s) [line 101]Function Parameters:

MyPDO $DB $s

Static Access public

void function CustomPage::getInstanceFromDB($DB, $id) [line 60]Function Parameters:

MyPDO $DB $id

Page 295 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 335: Manual

Static Access public

void function CustomPage::getListFromDB($DB, [$restrictions = '']) [line 92]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function CustomPage::getText($language) [line 219]Function Parameters:

$language

Access public

void function CustomPage::getTitle($language) [line 212]Function Parameters:

$language

function to retrieve

Page 296 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 336: Manual

Access public

bool function CustomPage::pageExists($DB, $pageName, [$restrictions = '']) [line 233]Function Parameters:

MyPDO $DB database instancestring $pageName Page name $restrictions

Function to check if a page already exists

Static Access public

void function CustomPage::saveToDB($DB) [line 124]Function Parameters:

MyPDO $DB

Saving changes to database

Access public

void function CustomPage::__get($property) [line 40]Function Parameters:

$property

Page 297 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 337: Manual

Interceptors

Access public

void function CustomPage::__set($property, $value) [line 50]Function Parameters:

$property $value

Access public

Class DBReadable [line 10]

Interface for reading data from DB

Package general

void function DBReadable::getInstanceFromDB($DB, $id) [line 15]Function Parameters:

MyPDO $DB $id

Page 298 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 338: Manual

Get one instance, based on id

Static Access public

void function DBReadable::getListFromDB($DB, [$restrictions = '']) [line 19]Function Parameters:

MyPDO $DB $restrictions

Get a list, based on restrictions

Static Access public

Class DBSearchable [line 14]

Interface for searching register ID from DB starting with a name.Given some input data, try to discover which register in DB is this data referring to. For

example, data can include real Id number, name, or some descriptive.

Package general

Page 299 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 339: Manual

void function DBSearchable::discoverId($DB, $s) [line 19]Function Parameters:

MyPDO $DB $s

Get the id of the register with name=$s

Static Access public

Class DBWritable [line 10]

Interface for writing data to DB

Package general

void function DBWritable::saveToDB($DB) [line 15]Function Parameters:

MyPDO $DB

Save current object to DB and return object's id or false.

Page 300 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 340: Manual

Access public

Class Favourite [line 10]

Favourite

Package general

Favourite::DB_TABLE

= 'V5_favourites' [line 15]

database table

Favourite::TYPE_OFFER

= 'OFFER' [line 27]

Favourite type constants, Favourite Offer

Favourite::TYPE_STORE

= 'STORE' [line 19]

Favourite type constants, Favourite Store

Favourite::TYPE_USER

= 'USER' [line 23]

Favourite type constants, Favourite User

Favourite::$_focusId

<mix> = [line 41]

Page 301 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 341: Manual

Var favourite focus objectAccess private

Favourite::$_id

mixed = [line 29]

Access private

Favourite::$_offers

<array> = [line 45]

Var list of offers under this favouriteAccess private

Favourite::$_type

<string> = [line 37]

Var type of favouriteAccess private

Favourite::$_user

<User> = [line 33]

Var favourite of userAccess private

Page 302 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 342: Manual

void function Favourite::deleteFromDB($DB) [line 165]Function Parameters:

MyPDO $DB

remove record from database

Access public

array function Favourite::getFavouriteOffers($DB, $focusId, $type) [line 181]Function Parameters:

MyPDO $DB database objectstring $focusId offers for this focus idstring $type favourite type

function to return list of favorite offers

Static Access public

void function Favourite::getInstanceFromDB($DB, $id) [line 97]Function Parameters:

MyPDO $DB $id

Static

Page 303 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 343: Manual

Access public

void function Favourite::getListFromDB($DB, [$restrictions = '']) [line 84]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Favourite::saveToDB($DB) [line 135]Function Parameters:

MyPDO $DB

Access public

void function Favourite::__get($property) [line 47]Function Parameters:

$property

Access public

void function Favourite::__set($property, $value) [line 57]Function Parameters:

Page 304 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 344: Manual

$property $value

Access public

Class Fee [line 11]

Fee class,this class is used to calculate and charge fee from user for a particular buy or sell

Package general

Fee::BIDPACKFEE

= 'BIDPACKFEE' [line 32]

Fee::DB_TABLE

= 'V5_fees' [line 16]

Table

Fee::DIRECT_FEE

= 'DIRECTFEE' [line 26]

Fee::FEES_LANG_TABLE

= 'V5_fees_languages' [line 19]

Fee::FEES_RANGE_TABLE

Page 305 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 345: Manual

= 'V5_feesRanges' [line 18]

Fee::FEES_USERS_TABLE

= 'V5_fees_users' [line 17]

Fee::FEE_NOTPAID

= 'NOTPAID' [line 37]

User Fee status constants

Fee::FEE_PAID

= 'PAID' [line 39]

Fee::FEE_PAYMENT_IN_PROCESS

= 'PAYMENT_IN_PROCESS' [line 38]

Fee::FINALFEE

= "FINALVALUEFEE" [line 30]

Fee::FROZEN_TABLE

= 'V5_frozenFees' [line 20]

Fee::INVOICE_FEE

= 'INVOCIE' [line 25]

Fees constants

Fee::OTEHR_FEE

= 'OTHERFEE' [line 28]

Fee::RELISTING_FEE

= 'RELISTINGFEE' [line 29]

Fee::SIGNUP_FEE

= 'SIGNUPFEE' [line 27]

Fee::STOREFEE

= 'STOREFEE' [line 31]

Fee::$_action

mixed = [line 41]

Page 306 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 346: Manual

Access private

Fee::$_active

mixed = [line 45]

Access private

Fee::$_baseField

mixed = [line 42]

Access private

Fee::$_chargeAtCreation

mixed = [line 44]

Access private

Fee::$_description

mixed = [line 47]

Access private

Fee::$_feeRangeContainer

mixed = [line 52]

Page 307 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 347: Manual

local FeeRange Object

Access private

Fee::$_fixed

mixed = [line 43]

Access private

Fee::$_title

mixed = [line 46]

Access private

lastInsertId function Fee::chargeFee($user, $DB, $base, [$offerId = null], [$comment = '']) [line 98]Function Parameters:

User $user user to charge the feePDO $DB the database objectfloat $base base value (usually start price in auction) to calculate the feeint $offerId in case of fees affecting a offer, the offer idstring $comment some text to describe the details of the charge

method to store the amount charged in the V5_fees_users table

Access public

Page 308 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 348: Manual

bool function Fee::freeze($user, $DB, $base, [$offerId = null], [$comment = '']) [line 135]Function Parameters:

User $user user to charge the feePDO $DB the database objectfloat $base base value (usually start price in auction) to calculate the feeint $offerId in case of fees affecting a offer, the offer idstring $comment some text to describe the details of the charge

Method to save some fees that are not charged now, but when an action takes place.It is saved in V5_frozenFees table on DB

Access public

array function Fee::getBidPackFeeData($DB, $id) [line 558]Function Parameters:

MyPDO $DB database instanceint $id user fees id

Return bid pack fee data

Static Access public

string function Fee::getDescription($lang) [line 367]Function Parameters:

string $lang language id

Page 309 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 349: Manual

function to retrieve description of fee

Access public

array() function Fee::getFeeList($DB, $lang, [$restrictions = ''], $restriction) [line 261]Function Parameters:

MyPDO $DB database instancestring $lang language constantstring $restriction additional parameters (use third parameter to get exactly what you want) $restrictions

Retrieve list of fee, unlike self::getListFromDB, which does not include a fee if it doesnot have a corresponding row in self::FEES_LANG_TABLEthis method first retrieve the list of all fee, it then fetch fee title and description of each fee

from self::FEES_LANG_TABLE, and if a fee does not have row in the table forcorresponding language, it add a empty('') string, this way you get list of all the fees in table,even they do not have a row in langauge table

Static Access public

void function Fee::getInstanceFromDB($DB, $id) [line 195]Function Parameters:

MyPDO $DB $id

Methods from DBReadable and DBWritable

Page 310 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 350: Manual

Static Access public

void function Fee::getListForOffer($DB, $offer) [line 391]Function Parameters:

MyPDO $DB Offer $offer

Access public

void function Fee::getListForStore($DB, $store) [line 403]Function Parameters:

MyPDO $DB Store $store

Access public

void function Fee::getListFromDB($DB, [$restrictions = '']) [line 228]Function Parameters:

MyPDO $DB $restrictions

DBReadable getListFromDB implementation

Page 311 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 351: Manual

Static Access public

string function Fee::getTitle($lang) [line 382]Function Parameters:

string $lang language id

function to retrieve title of fee

Access public

array function Fee::getUserFee($DB, $user, [$offerId = 0], [$status = Fee::FEE_NOTPAID]) [line 497]Function Parameters:

MyPDO $DB database instanceUser $user User instanceint $offerId offer id (default 0)string $status fee status to check for

function to retrieve list of user fee from Fee::FEES_USERS_TABLE with a particularstatus

Static Access public

void function Fee::listFrozenFromDB($DB, [$restrictions = ""]) [line 159]Function Parameters:

MyPDO $DB $restrictions

Page 312 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 352: Manual

retrieves an array with data from frozen fees

Static Access public

bool function Fee::removeBidPackFee($DB, $user, $bidPack, [$status = self::FEE_NOTPAID]) [line 544]Function Parameters:

MyPDO $DB database objectUser $user $user instanceBidPAck $bidPack bid pack instancestring $status Payment status

function to remove bidpack fee amount from self::FEES_USERS_TABLE with particularstatus

Static Access public

bool function Fee::removeStoreFee($DB, $user, $storeId, [$status = self::FEE_NOTPAID]) [line 481]Function Parameters:

MyPDO $DB database objectUser $user $user instanceint $storeId storeidstring $status Payment status

function to remove store fee amount from self::FEES_USERS_TABLE with particularstatus

Page 313 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 353: Manual

Static Access public

bool function Fee::removeUserFee($DB, $offerId, [$status = self::FEE_NOTPAID]) [line 465]Function Parameters:

MyPDO $DB database objectint $offerId Offer IDstring $status Payment status

function to remove fee amount from self::FEES_USERS_TABLE with particular status

Static Access public

void function Fee::saveToDB($DB) [line 287]Function Parameters:

MyPDO $DB

saveToDB function from DBWritable interface

Access public

void function Fee::setDescription($lang, $description, [$defaultLang = 'en_US']) [line 339]Function Parameters:

$lang $description $defaultLang

Page 314 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 354: Manual

Access public

void function Fee::setTitle($lang, $title, [$defaultLang = 'en_US']) [line 350]Function Parameters:

$lang $title $defaultLang

Access public

void function Fee::simulateFee($user, $base) [line 60]Function Parameters:

User $user user to be chargedfloat $base base value (usually start price in auction) to calculate the fee

function to simulate a fee charged over a user, without saving it on DB.

Access public

bool function Fee::updateBidPackFeeStatus($DB, $bidPack, $user, [$status = Fee::FEE_NOTPAID]) [line 527]Function Parameters:

MyPDO $DB database instanceBidPack $bidPack bid pack instancestring $status fee status

Page 315 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 355: Manual

User $user

Update status of a bid pack fee in users_fees table

Static Access public

void function Fee::updateFeeStatus($DB, $feeId, [$status = self::FEE_NOTPAID]) [line 448]Function Parameters:

MyPDO $DB $feeId $status

Static Access public

void function Fee::updateStoreFeeStatus($DB, $store, [$status = self::FEE_NOTPAID]) [line 440]Function Parameters:

MyPDO $DB Store $store $status

Static Access public

bool function Fee::updateUserFeeStatus($DB, $offerId, [$status = self::FEE_NOTPAID], [$oldStatus =self::FEE_NOTPAID], [$feeId = ''], [$extra = ''], $olStatus) [line 425]

Page 316 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 356: Manual

Function Parameters:

MyPDO $DB database objectint $offerId Offer IDstring $status Payment statusstring $olStatus old payment statusstring $feeId change status of this fee $oldStatus $extra

function to update user fee status

Static Access public

void function Fee::__get($property) [line 169]Function Parameters:

$property

Interceptor : the getter

Access public

void function Fee::__set($property, $value) [line 182]Function Parameters:

$property $value

Interceptor : the setter

Page 317 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 357: Manual

Access public

Class FeeRangeContainer [line 12]

FeeRangeContainer class,this class is used to store Range charges for a partucular range

Package general

FeeRangeContainer::DB_TABLE

= 'V5_feesRanges' [line 14]

FeeRangeContainer::$_action

mixed = [line 18]

FeeRange properties

Access private

FeeRangeContainer::$_endRange

mixed = [line 21]

Page 318 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 358: Manual

Access private

FeeRangeContainer::$_feeRange

mixed = [line 19]

Access private

FeeRangeContainer::$_startRange

mixed = [line 20]

Access private

void function FeeRangeContainer::addRange([$start = 0], [$end = PHP_INT_MAX], [$fixedCharge = 0],[$percentCharge = 0.0]) [line 157]

Function Parameters:

numeric $start start valuenumeric $end end valuenumeric $fixedCharge fixed charge for this rangenumeric $percentCharge percent charge for this range

function to add new range for this fee

Access public

numeric function FeeRangeContainer::getAllCharges($amount) [line 61]Function Parameters:

numeric $amount amount to retrieve percent charge for

Page 319 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 359: Manual

function to retrieve percent charge

Access private

numeric function FeeRangeContainer::getFixedCharge($amount) [line 45]Function Parameters:

numeric $amount amount to retrieve fixed charge for

function to retrieve percent charge

Access public

array() function FeeRangeContainer::getInstanceFromDB($DB, $id) [line 115]Function Parameters:

string $id fee actionMyPDO $DB PDO instance

creating instance from values in the databasethis method works little diffent from other implementations of the method it query the

table for given action (id) and if there is only one record it returns an object or FeeRange typewith all values initialized, otherwise, it returns a empty Containing

Static Access public

Page 320 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 360: Manual

void function FeeRangeContainer::getListFromDB($DB, [$restrictions = '']) [line 144]Function Parameters:

MyPDO $DB $restrictions

Static Access public

numeric function FeeRangeContainer::getPercentCharge($amount) [line 29]Function Parameters:

numeric $amount amount to retrieve percent charge for

function to retrieve percent charge

Access public

void function FeeRangeContainer::saveToDB($DB) [line 171]Function Parameters:

MyPDO $DB

saveToDB function from DBWritable interface

Access public

Page 321 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 361: Manual

bool function FeeRangeContainer::valueExistsInRange($start, $end, $value, $rangeType) [line 213]Function Parameters:

numeric $value value to checkstring $rangeType (in which range you want to check for this value 'start' or 'end' $start $end

function to check if a value can be added in the range

Access private

void function FeeRangeContainer::__get($property) [line 80]Function Parameters:

$property

Interceptor : the getter

Access public

void function FeeRangeContainer::__set($property, $value) [line 93]Function Parameters:

$property $value

Interceptor : the setter

Page 322 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 362: Manual

Access public

Class FixedAuction [line 9]

FixedAuction

Package general

Constructor void function FixedAuction::__construct() [line 11]

Access public

void function FixedAuction::calculateNextBid() [line 66]

Access public

void function FixedAuction::finishOffer() [line 32]

Access public

void function FixedAuction::getBidButtonText() [line 135]

Page 323 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 363: Manual

Access public

void function FixedAuction::getExtendedDataFromDB($DB) [line 94]Function Parameters:

MyPDO $DB

retrieves data needed for concrete child

Access public

void function FixedAuction::getInstanceFromDB($DB, $id) [line 81]Function Parameters:

MyPDO $DB $id

Static Access public

void function FixedAuction::getListFromDB($DB, [$restrictions = '']) [line 100]Function Parameters:

MyPDO $DB $restrictions

Page 324 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 364: Manual

Static Access public

void function FixedAuction::getListOnOneCategory($DB, $categoryId) [line 111]Function Parameters:

MyPDO $DB $categoryId

Static Access public

void function FixedAuction::getWinners() [line 47]

Access public

void function FixedAuction::makeBid($b) [line 16]Function Parameters:

Bid $b

Access public

void function FixedAuction::removeUserBids($DB, $userToExclude) [line 140]Function Parameters:

MyPDO $DB User $userToExclude

Page 325 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 365: Manual

Access public

void function FixedAuction::saveToDB($DB) [line 122]Function Parameters:

MyPDO $DB

Access public

void function FixedAuction::type() [line 56]

Access public

void function FixedAuction::typeName() [line 61]

Access public

void function FixedAuction::__get($property) [line 71]Function Parameters:

$property

Access public

Page 326 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 366: Manual

void function FixedAuction::__set($property, $value) [line 76]Function Parameters:

$property $value

Access public

Class Image [line 9]

Image

Package general

Image::DB_TABLE

= 'V5_images' [line 11]

Image::DEFAULT_IMAGE_ID

= 1 [line 27]

Image::UPLOAD_PATH

= 'uploaded/img/' [line 12]

Image::$id

mixed = [line 14]

Access protected

Page 327 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 367: Manual

Image::$references

mixed = [line 17]

Access protected

Image::$size

mixed = [line 16]

Access protected

Image::$url

mixed = [line 15]

Access protected

Constructor void function Image::__construct() [line 19]

Access public

Image function Image::copyAsNewImage($DB, $currentOfferId, $newOfferId) [line 301]Function Parameters:

MyPDO $DB database instanceint $currentOfferId the prefix image file is having currentlyint $newOfferId the prefix image file should have after copy

Page 328 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 368: Manual

function to copy image as new image

Access public

void function Image::createImage($url) [line 213]Function Parameters:

$url

Function to create image

Static Access private

string function Image::createNewName($fileName) [line 270]Function Parameters:

string $fileName existing file name

Function to create new file name for suffixing some random characters at the end offile name

Static Access public

void function Image::deletefromDB($DB) [line 103]Function Parameters:

Page 329 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 369: Manual

MyPDO $DB

Function to remove image for V5 (db and disk)

Access public

void function Image::deleteFromDBOnly($DB) [line 122]Function Parameters:

MyPDO $DB

Access public

void function Image::doUpload($tmpFile, $finalName) [line 199]Function Parameters:

string $tmpFile tmp file pathstring $finalName name of the file

Function to do the upload by moving the file to upload/img/ directory

Static Access private

void function Image::getInstanceFromDB($DB, $id) [line 47]Function Parameters:

Page 330 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 370: Manual

MyPDO $DB $id

Static Access public

void function Image::getListFromDB($DB, [$restrictions = '']) [line 67]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Image::isRemoteFile($fileName) [line 259]Function Parameters:

$fileName

function to check if the file is a remote file

Static Access public

void function Image::removeFile($fileName) [line 131]Function Parameters:

Page 331 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 371: Manual

$fileName

Static Access public

void function Image::renameFile($oldName, $prefix) [line 282]Function Parameters:

$oldName $prefix

Static Access public

void function Image::saveToDB($DB) [line 72]Function Parameters:

MyPDO $DB

Access public

Image function Image::uploadFile($tmpFile, $finalName, [$maxUploadSize = 1024], [$overwrite = false], [$prefix ='']) [line 162]

Function Parameters:

string $tmpFile path of tmp filestring $finalName the file name that u want to give this filebool $overwrite optional parameter to specify if existing file should be over writtenstring $prefix optional file prefix

Page 332 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 372: Manual

$maxUploadSize

function to upload images

Static Access public

void function Image::uploadRemoteFile($url) [line 136]Function Parameters:

$url

Static Access public

bool function Image::validFile($tmpFile, $maxUploadSize) [line 235]Function Parameters:

string $tmpFile tmp file pathint $maxUploadSize maximum file size that can be uploaded

function to check if this file is a valid file

Static Access private

void function Image::__get($property) [line 29]Function Parameters:

Page 333 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 373: Manual

$property

Access public

void function Image::__set($property, $value) [line 38]Function Parameters:

$property $value

Access public

Class Invoice [line 9]

Invoice

Package general

Invoice::DB_TABLE

= 'V5_invoices' [line 14]

DB Tables

Page 334 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 374: Manual

Invoice::DIRECTPAY

= 'DIRECT' [line 31]

Invoice::INVOICE

= 'INVOICE' [line 30]

pay method

Invoice::INVOICE_LINES_TABLE

= 'V5_invoices_lines' [line 15]

Invoice::NOT_PAID

= 'NOTPAID' [line 23]

Invoice::PAID

= 'PAID' [line 22]

Invoice::PAYMENT_PENDING

= 'PAYMENT_PENDING' [line 25]

Invoice::PAYMENT_VERIFIED

= 'PAYMENT_VERIFIED' [line 24]

Invoice::PENDING

= 'PENDING' [line 20]

Invoice status constants

Invoice::SENT

= 'SENT' [line 21]

Invoice::$_adminMail

mixed = [line 55]

Access private

Invoice::$_date

Page 335 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 375: Manual

mixed = [line 37]

Access private

Invoice::$_defaultCurrency

mixed = [line 49]

Access private

Invoice::$_defaultLanguage

mixed = [line 58]

Access private

Invoice::$_fromMail

mixed = [line 56]

Access private

Invoice::$_id

mixed = [line 36]

invoice variables

Access private

Page 336 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 376: Manual

Invoice::$_invoiceCopyToAdmin

mixed = [line 45]

Access private

Invoice::$_invoiceFooter

mixed = [line 48]

Access private

Invoice::$_invoiceHeader

mixed = [line 47]

Access private

Invoice::$_invoiceLimit

mixed = [line 46]

Access private

Invoice::$_invoiceLines

mixed = [line 41]

Access private

Page 337 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 377: Manual

Invoice::$_invoiceTaxName

mixed = [line 44]

Access private

Invoice::$_invoiceTaxPercent

mixed = [line 43]

Access private

Invoice::$_siteName

mixed = [line 57]

Access private

Invoice::$_status

mixed = [line 38]

Access private

Invoice::$_tax

mixed = [line 40]

Page 338 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 378: Manual

Access private

Invoice::$_total

mixed = [line 39]

Access private

Invoice::$_user

mixed = [line 53]

Access private

Invoice::$_userEmail

mixed = [line 52]

Access private

Invoice::$_userId

mixed = [line 51]

Access private

Constructor void function Invoice::__construct() [line 60]

Access private

Page 339 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 379: Manual

void function Invoice::calculateTotal($total, $tax) [line 430]Function Parameters:

$total $tax

method to calculate total (here total is sum + tax

Static Access public

string function Invoice::createMail() [line 595]Function to create the invoice mail

Access public

void function Invoice::deleteFromDB($DB) [line 547]Function Parameters:

MyPDO $DB

Access public

int function Invoice::generateInvoice($DB) [line 262]Function Parameters:

Page 340 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 380: Manual

MyPDO $DB database instance

Function to generate invoice.this function first fetch all the 'userFeesId' values from V5_invoices_lines, then query

V5_fees_users for user fees records, except those already in V5_invoices_lines

Static Access public

void function Invoice::getInstanceFromDB($DB, $id) [line 109]Function Parameters:

MyPDO $DB $id

Static Access public

array function Invoice::getInvoiceLinesFromDB($DB, $invoiceId) [line 187]Function Parameters:

MyPDO $DB database instanceint $invoiceId InvoiceId invoice id to get details of

Function to retrieve all the rows included in a invoice

Static Access public

Page 341 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 381: Manual

void function Invoice::getListFromDB($DB, [$restrictions = '']) [line 162]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Invoice::getStatsFromDB($DB) [line 623]Function Parameters:

MyPDO $DB

get some statistics for back-end home page

Static Access public

void function Invoice::saveToDB($DB) [line 199]Function Parameters:

MyPDO $DB

Access public

Page 342 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 382: Manual

int function Invoice::sendInvoices($DB, $context, [$status = self::PENDING]) [line 451]Function Parameters:

MyPDO $DB database instanceCore_Context $context context objectstring $status send invoice with this status (default PDENDING)

Function to mass send invoices,this function first generate invoices by making a call to generateInvoice method, it then

retrieve the list of invoices with stauts

Static Access public

bool function Invoice::sendMail($DB, $context) [line 502]Function Parameters:

MyPDO $DB Database instanceCore_Context $context context object

Function to send invoice mail

Access public

bool function Invoice::sendOneInvoice($DB, $invoiceId, $context) [line 486]Function Parameters:

MyPDO $DB database instanceint $invoiceId invoiceCore_Context $context context object

Page 343 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 383: Manual

Function to send one invoice

Static Access public

void function Invoice::updateInvoiceStatus($DB, [$status = self::SENT]) [line 568]Function Parameters:

MyPDO $DB $status

function to update invoice status

Access public

void function Invoice::__get($property) [line 83]Function Parameters:

$property

interceptors

Access public

void function Invoice::__set($property, $value) [line 97]Function Parameters:

Page 344 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 384: Manual

$property $value

Access public

Class Item [line 9]

Item

Package general

Item::DB_TABLE

= 'V5_items' [line 14]

DB Tables

Item::ITEM_IMAGES_TABLE

= 'V5_Items_Images' [line 15]

Item::$description

mixed = [line 20]

Access protected

Item::$id

Page 345 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 385: Manual

mixed = [line 17]

Access protected

Item::$image

mixed = [line 21]

Access protected

Item::$images

mixed = [line 28]

hold multiple images for item

Access protected

Item::$name

mixed = [line 19]

Access protected

Item::$user

mixed = [line 18]

Access protected

Page 346 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 386: Manual

Item::$youtubeVideo

mixed = [line 23]

Access protected

Constructor void function Item::__construct() [line 30]

Access public

void function Item::addImage($image) [line 285]Function Parameters:

Image $image

Access public

Item function Item::copyItem($DB) [line 365]Function Parameters:

MyPDO $DB database instance

function to copy Item as a new item

Access public

Page 347 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 387: Manual

void function Item::deleteFromDB($DB) [line 273]Function Parameters:

MyPDO $DB

function to delete the current record from database

Access public

void function Item::deleteImage($image) [line 308]Function Parameters:

Image $image

function to delete particular image

Access public

void function Item::emptyImages() [line 300]

Access public

void function Item::getInstanceFromDB($DB, $id) [line 96]Function Parameters:

MyPDO $DB $id

Page 348 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 388: Manual

Static Access public

void function Item::getItemImages($DB, $id) [line 147]Function Parameters:

MyPDO $DB database instanceint $id item id

method to retrieve list of images for particular item

Static Access private

void function Item::getListFromDB($DB, [$restrictions = '']) [line 158]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Item::imageExist($image) [line 327]Function Parameters:

Image $image Image object to check

Page 349 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 389: Manual

Function to check it the specified image already exist in this item

Access private

void function Item::saveToDB($DB) [line 193]Function Parameters:

MyPDO $DB

Access public

bool function Item::verifyYoutubeVideo($url) [line 349]Function Parameters:

string $url

function to verify youtube video link

Static Access private

void function Item::__get($property) [line 38]Function Parameters:

$property

Page 350 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 390: Manual

Access public

void function Item::__set($property, $value) [line 48]Function Parameters:

$property $value

Access public

Class Language [line 9]

Language

Package general

Language::DB_TABLE

= 'V5_languages' [line 14]

database constants

Language::$_active

mixed = [line 21]

Page 351 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 391: Manual

Access private

Language::$_id

mixed = [line 19]

member variables

Access private

Language::$_name

mixed = [line 20]

Access private

Language::$_orientation

mixed = [line 22]

Access private

Constructor void function Language::__construct() [line 24]

Access public

bool function Language::changeLanguage($lang) [line 166]

Page 352 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 392: Manual

Function Parameters:

string $lang language

Function to change the system language$lang should be present in /usr/lib/locale in the server!!

Static Access public

void function Language::deteleFromDB($DB) [line 80]Function Parameters:

MyPDO $DB

Access public

void function Language::getInstanceFromDB($DB, $id) [line 63]Function Parameters:

MyPDO $DB $id

Static Access public

void function Language::getListFromDB($DB, [$restrictions = '']) [line 54]

Page 353 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 393: Manual

Function Parameters:

MyPDO $DB $restrictions

Static Access public

bool function Language::languageAvailable($lang, $defaultLanguage) [line 126]Function Parameters:

string $lang language to be checkedstring $defaultLanguage default language of the site

Function to check if a language is installed on the server$lang should be present in /usr/lib/locale in the server!!

Static Access public

string function Language::localeInit($lang, $defaultLang) [line 144]Function Parameters:

$lang $defaultLang

Prepares enviroment for gettext traduction.There must be a .mo file located in the directory /locale/language/LC_MESSAGES

Page 354 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 394: Manual

Static Access public

void function Language::saveToDB($DB) [line 91]Function Parameters:

MyPDO $DB

Saving

Access public

void function Language::__get($property) [line 34]Function Parameters:

$property

interceptors

Access public

void function Language::__set($property, $value) [line 44]Function Parameters:

$property $value

Page 355 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 395: Manual

Access public

Class LotAuction [line 11]

LotAuction

Package general

LotAuction::DB_TABLE

= 'V5_lots' [line 16]

database table

LotAuction::$quantity

mixed = [line 18]

Access protected

Constructor void function LotAuction::__construct() [line 20]

Access public

void function LotAuction::calculateNextBid() [line 301]

Page 356 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 396: Manual

Access public

void function LotAuction::finishOffer() [line 162]

Access public

void function LotAuction::getBidButtonText() [line 296]

Access public

void function LotAuction::getExtendedDataFromDB($DB) [line 63]Function Parameters:

MyPDO $DB

Access public

void function LotAuction::getInstanceFromDB($DB, $id) [line 53]Function Parameters:

MyPDO $DB $id

Static Access public

Page 357 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 397: Manual

void function LotAuction::getListFromDB($DB, [$restrictions = '']) [line 79]Function Parameters:

MyPDO $DB $restrictions

Static Access public

array function LotAuction::getOffersWon($DB, $userId, [$owner = '']) [line 238]Function Parameters:

MyPDO $DB database instancestring $userId auctions won by this userstring $owner auctions owned by this user

Return list of LotAuction won by any user

Static Access public

void function LotAuction::getQuantity($b) [line 221]Function Parameters:

Bid $b

Access public

Page 358 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 398: Manual

void function LotAuction::getWinners() [line 208]this function returns a list of winner for the auction, in LotAuction it return list of user

who bid for the auction

Access public

void function LotAuction::makeBid($b) [line 120]Function Parameters:

Bid $b

Access public

void function LotAuction::removeUserBids($DB, $userToExclude) [line 306]Function Parameters:

MyPDO $DB User $userToExclude

Access public

void function LotAuction::saveToDB($DB) [line 90]Function Parameters:

MyPDO $DB

Page 359 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 399: Manual

Access public

void function LotAuction::type() [line 286]

Access public

void function LotAuction::typeName() [line 291]

Access public

void function LotAuction::__get($property) [line 25]Function Parameters:

$property

Access public

void function LotAuction::__set($property, $value) [line 34]Function Parameters:

$property $value

Access public

Page 360 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 400: Manual

Class Message [line 9]

Message class

Package general

Message::ALL_MESSAGES

= 0 [line 19]

message type constants

Message::DB_TABLE

= 'V5_messages' [line 14]

DB Tables for the class

Message::READ_MESSAGES

= 2 [line 21]

Message::SENT_MESSAGES

= 3 [line 22]

Message::UNREAD_MESSAGES

= 1 [line 20]

Message::VISIBLE_BOTH

= 'both' [line 27]

Message visibility constants

Message::VISIBLE_RECEIVER

= 'receiver' [line 29]

Page 361 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 401: Manual

Message::VISIBLE_SENDER

= 'sender' [line 28]

Message::$_fromUser

mixed = [line 35]

Access private

Message::$_id

mixed = [line 34]

Message class variables

Access private

Message::$_message

mixed = [line 38]

Access private

Message::$_messageTime

mixed = [line 39]

Access private

Message::$_status

mixed = [line 40]

Page 362 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 402: Manual

Access private

Message::$_subject

mixed = [line 37]

Access private

Message::$_toUser

mixed = [line 36]

Access private

Message::$_visibility

mixed = [line 41]

Access private

Constructor void function Message::__construct() [line 43]

Access public

void function Message::deleteFromDB($DB) [line 314]Function Parameters:

Page 363 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 403: Manual

MyPDO $DB

Access private

bool function Message::deleteMessage($DB, $user, $message) [line 278]Function Parameters:

MyPDO $DB the database objectMessage $message Message to deleteUser $user user who is deleting this message

function to delete particular message

Access public

void function Message::getInstanceFromDB($DB, $id) [line 102]Function Parameters:

MyPDO $DB $id

Static Access public

void function Message::getListFromDB($DB, [$restrictions = '']) [line 140]Function Parameters:

MyPDO $DB

Page 364 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 404: Manual

$restrictions

Static Access public

array() function Message::listInboxMessages($DB, $user) [line 214]Function Parameters:

MyPDO $DB the database objectUser $user the user id

Function to return messages in the inbox (the messages user has recieved) of the user

Static Access private

array('inbox'=> function Message::listMessages($DB, $user, $type) [line 201]Function Parameters:

MyPDO $DB the database objectstring $user user idint $type message type to retrieve such as sent, all etc

function to list messages of a particular user

Static Access public

Page 365 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 405: Manual

array() function Message::listSentMessages($DB, $user) [line 236]Function Parameters:

MyPDO $DB the database objectstring $user the user id

Function to return messages in the outbox[sent] (the messages user has sent) of theuser

Static Access private

Message function Message::readMessage($DB, $messageID) [line 260]Function Parameters:

MyPDO $DB the database objectint $messageID then

function to read content of a particular message

Static Access public

void function Message::saveToDB($DB) [line 146]Function Parameters:

MyPDO $DB

Access public

Page 366 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 406: Manual

bool function Message::updateStatus($DB, $user, $status, $messaage) [line 303]Function Parameters:

MyPDO $DB the database objectMessage $messaage the Message to updateint $status new stausUser $user

function to change status of a message

Access public

void function Message::__get($property) [line 55]Function Parameters:

$property

Interceptor : the getter

Access public

void function Message::__set($property, $value) [line 68]Function Parameters:

$property $value

Interceptor : the setter

Page 367 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 407: Manual

Access public

Class MetaTag [line 10]

MetaTag

Package general

MetaTag::DB_TABLE

= 'V5_metaTags' [line 15]

Database table

MetaTag::$_id

mixed = [line 17]

Access private

MetaTag::$_languageId

mixed = [line 20]

Access private

Page 368 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 408: Manual

MetaTag::$_metaDescription

mixed = [line 19]

Access private

MetaTag::$_metaKeywords

mixed = [line 18]

Access private

void function MetaTag::getInstanceFromDB($DB, $id) [line 50]Function Parameters:

MyPDO $DB $id

Static Access public

void function MetaTag::getListFromDB($DB, [$restrictions = '']) [line 69]Function Parameters:

MyPDO $DB $restrictions

Static

Page 369 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 409: Manual

Access public

void function MetaTag::saveToDB($DB) [line 75]Function Parameters:

MyPDO $DB

Access public

void function MetaTag::__get($property) [line 23]Function Parameters:

$property

Access public

void function MetaTag::__set($property, $value) [line 33]Function Parameters:

$property $value

Access public

Page 370 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 410: Manual

Class Offer [line 12]

OfferThis class is an abstract class, the base class to extend different kind of auctions (like

Standard or Fixed price).

Package generalAbstract Element

Offer::DB_TABLE

= 'V5_offers' [line 14]

Offer::FIXED_PRICE

= 'FIXED_PRICE' [line 55]

Offer::LOT

= 'LOT' [line 57]

Offer::OFFERS_CATEGORIES_TABLE

= 'V5_offers_categories' [line 15]

Offer::OFFERS_CUSTOM_FIELD_TABLE

= 'V5_offers_offersFields' [line 17]

Offer::OFFERS_PAYMETHODS_TABLE

= 'V5_offers_payMethods' [line 16]

Offer::OFFERS_TYPES_TABLE

= 'V5_offersTypes' [line 18]

Offer::PENNY

= 'PENNY' [line 58]

Offer::REVERSE

= 'REVERSE' [line 56]

Offer::SHIP_CONDITIONS_BUYER

Page 371 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 411: Manual

= 'BUYER' [line 59]

Offer::SHIP_CONDITIONS_SELLER

= 'SELLER' [line 60]

Offer::STANDARD

= 'STANDARD' [line 54]

Offer::$active

mixed = [line 40]

Access protected

Offer::$bids

mixed = [line 42]

Access protected

Offer::$categories

mixed = [line 38]

Access protected

Offer::$currentPrice

mixed = [line 25]

Access protected

Page 372 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 412: Manual

Offer::$customFields

mixed = [line 47]

Access protected

Offer::$datePending

mixed = [line 27]

Access protected

Offer::$draft

mixed = [line 45]

Access protected

Offer::$endDate

mixed = [line 23]

Access protected

Offer::$featured

mixed = [line 44]

Access protected

Page 373 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 413: Manual

Offer::$file

mixed = [line 48]

Access protected

Offer::$fileSize

mixed = [line 49]

Access protected

Offer::$id

mixed = [line 20]

Access protected

Offer::$inWebstore

mixed = [line 29]

Access protected

Offer::$item

mixed = [line 21]

Access protected

Page 374 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 414: Manual

Offer::$payMethods

mixed = [line 37]

Access protected

Offer::$relisting

mixed = [line 26]

Access protected

Offer::$shipConditions

mixed = [line 32]

Access protected

Offer::$shipCosts

mixed = [line 33]

Access protected

Offer::$shipInternational

mixed = [line 34]

Access protected

Page 375 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 415: Manual

Offer::$shipTerms

mixed = [line 35]

Access protected

Offer::$startDate

mixed = [line 22]

Access protected

Offer::$startPrice

mixed = [line 24]

Access protected

Offer::$types

mixed = [line 52]

Static Access protected

Offer::$views

mixed = [line 50]

Page 376 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 416: Manual

Access protected

Offer::$winner

mixed = [line 39]

Access protected

Constructor void function Offer::__construct() [line 62]

Abstract Element Access public

bool function Offer::addFieldValue($fieldId, $value, [$name = ''], [$mandatory = 0]) [line 803]Function Parameters:

int $fieldId field id to add value forstring $value $name $mandatory

function to add custom field value

Access public

int function Offer::calculateNextBid() [line 88]Verify bid increments table to calculate next bid value

Abstract Element

Page 377 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 417: Manual

Access public

Offer function Offer::copyAsDraft($DB) [line 884]Function Parameters:

MyPDO $DB database instance

Function to copy auction as a new draft auction

Access public

void function Offer::deleteFromDB($DB) [line 870]Function Parameters:

MyPDO $DB

remove auction and all related files (images, documents uploaded).

Access public

void function Offer::discoverId($DB, $s) [line 1022]Function Parameters:

MyPDO $DB $s

Static

Page 378 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 418: Manual

Access public

bool function Offer::finishOffer() [line 72]

Abstract Element Access public

string function Offer::getBidButtonText() [line 102]function to return text to be displayed on the Bid button in templates

Abstract Element Access public

array function Offer::getCustomOfferData($DB, $offerId) [line 787]Function Parameters:

MyPDO $DB database instanceint $offerId offerId

function to retrieve offer custom data

Static Access public

void function Offer::getExtendedDataFromDB($DB) [line 362]Function Parameters:

MyPDO $DB

Page 379 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 419: Manual

retrieves data needed for concrete childreturns same object with the extended properties, or false

Abstract Element

void function Offer::getFieldValue($fieldId) [line 814]Function Parameters:

$fieldId

function to retrieve the value of a particular field

Access public

void function Offer::getInstance($type) [line 104]Function Parameters:

$type

Access public

void function Offer::getInstanceFromDB($DB, $id) [line 244]Function Parameters:

MyPDO $DB $id

Page 380 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 420: Manual

creates an instance of the concrete child class

Static Access public

void function Offer::getListForThisParent($DB, $categoryId, [$onlyActives = false], [$catFeatured = false]) [line 611]Function Parameters:

MyPDO $DB database objectint $categoryId category id to $onlyActives $catFeatured

function to retrieve the list of offers for all childs

Static Access public

void function Offer::getListForThisParentInStore($DB, $categoryId, [$onlyActives = false], [$catFeatured = false])[line 627]

Function Parameters:

MyPDO $DB database instanceint $categoryId bool $onlyActives only active categoriesarray $catFeatured

function to retrieve the list of offers in web store for this parent and all its

Page 381 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 421: Manual

Static Access public

void function Offer::getListFromDB($DB, [$restrictions = '']) [line 365]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Offer::getListOnOneCategory($DB, $categoryId, [$onlyActives = false]) [line 419]Function Parameters:

MyPDO $DB $categoryId $onlyActives

Static Access public

array function Offer::getOfferCount($DB, $categories, [$onlyActives = false], [$inWebstore = false], [$storeId = 0])[line 660]

Function Parameters:

MyPDO $DB database instancearray $categories categories array, each item as $id=>$namebool $onlyActives flagbool $inWebstore flag $storeId

Page 382 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 422: Manual

function to retrieve number of offers availabe for each category

Static Access public

array function Offer::getStatsFromDB($DB) [line 764]Function Parameters:

MyPDO $DB

retrieves some useful stats

Static Access public

void function Offer::getTypesFromDB($DB) [line 826]Function Parameters:

MyPDO $DB

It stores in Offer::$types an array, with the types available

Static Access public

array function Offer::getUserBuyers($DB, $user) [line 741]Function Parameters:

Page 383 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 423: Manual

MyPDO $DB database instanceUser $user user instance, is used to specify offer owner

Return list of users who won auction created by the User

Static Access public

array function Offer::getUserSells($DB, $user, $inWebstore, [$winner = '']) [line 707]Function Parameters:

MyPDO $DB database instanceUser $user offers owned by this userbolean $inWebstore sells made from webstorestring $winner auction won by this user

function to return user sold items

Static Access public

array() function Offer::getWinners() [line 95]function to return the winner of the auction

Abstract Element Access public

bool function Offer::makeBid($b) [line 67]Function Parameters:

Page 384 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 424: Manual

Bid $b

Abstract Element Access public

void function Offer::relist($DB) [line 999]Function Parameters:

MyPDO $DB database instance

Prepare the offer values for a relistChange dates, reset price, and delete all bids

Access public

bool function Offer::removeUserBids($DB, $userToExclude) [line 967]Function Parameters:

MyPDO $DB database instanceUser $userToExclude user who's bids should be excluded in the process of bid remake

function to adjust the bids for the offer in case any bid is being removed

Access public

void function Offer::saveToDB($DB) [line 426]

Page 385 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 425: Manual

Function Parameters:

MyPDO $DB

Access public

string function Offer::type() [line 77]

Abstract Element Access public

string function Offer::typeName() [line 82]

Abstract Element Access public

bool function Offer::updateTypesToDB($DB, $types) [line 851]Function Parameters:

array $types MyPDO $DB

Updates DB with new details for each type

Static Access public

void function Offer::__get($property) [line 130]

Page 386 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 426: Manual

Function Parameters:

$property

Access public

void function Offer::__set($property, $value) [line 142]Function Parameters:

$property $value

Access public

Class OffersQuestion [line 11]

OffersQuestionsclass to manage offer question and answer

Package general

OffersQuestion::DB_TABLE

= 'V5_offersQuestions' [line 16]

Page 387 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 427: Manual

DB Table

OffersQuestion::$_answer

mixed = [line 25]

Access private

OffersQuestion::$_date

mixed = [line 26]

Access private

OffersQuestion::$_id

mixed = [line 21]

member variables

Access private

OffersQuestion::$_offerId

mixed = [line 22]

Access private

OffersQuestion::$_question

Page 388 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 428: Manual

mixed = [line 24]

Access private

OffersQuestion::$_user

mixed = [line 23]

Access private

Constructor void function OffersQuestion::__construct() [line 28]

Access public

void function OffersQuestion::getInstanceFromDB($DB, $id) [line 75]Function Parameters:

MyPDO $DB $id

Static Access public

void function OffersQuestion::getListFromDB($DB, [$restrictions = '']) [line 107]Function Parameters:

MyPDO $DB $restrictions

Page 389 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 429: Manual

Static Access public

bool function OffersQuestion::questionExists($DB, $question, $offerId) [line 174]Function Parameters:

MyPDO $DB database instancestring $question questionint $offerId offer id

function to check if the specified question already exist for this offer

Static Access public

void function OffersQuestion::saveToDB($DB) [line 127]Function Parameters:

MyPDO $DB

Access public

void function OffersQuestion::__get($property) [line 37]Function Parameters:

$property

Page 390 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 430: Manual

Access public

void function OffersQuestion::__set($property, $value) [line 47]Function Parameters:

$property $value

Access public

Class PayMethod [line 9]

PayMethod

Package general

PayMethod::DB_TABLE

= 'V5_payMethods' [line 11]

PayMethod::LANG_TABLE

= 'V5_payMethods_languages' [line 12]

PayMethod::$active

mixed = [line 17]

Page 391 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 431: Manual

Access protected

PayMethod::$gatewayId

mixed = [line 15]

Access protected

PayMethod::$id

mixed = [line 14]

Access protected

PayMethod::$isGateway

mixed = [line 18]

Access protected

PayMethod::$name

mixed = [line 16]

Access protected

Constructor void function PayMethod::__construct() [line 20]

Page 392 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 432: Manual

Access public

void function PayMethod::addName($lang, $name, [$defaultLang = 'en_US']) [line 86]Function Parameters:

string $lang Language ID to add name forstring $name name for the field $defaultLang

Function to add custom auction field name to name array

Access public

void function PayMethod::deleteFromDB($DB) [line 160]Function Parameters:

MyPDO $DB

Access public

void function PayMethod::discoverId($DB, $s) [line 171]Function Parameters:

MyPDO $DB $s

Static Access public

Page 393 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 433: Manual

void function PayMethod::getInstanceFromDB($DB, $id) [line 45]Function Parameters:

MyPDO $DB $id

Static Access public

void function PayMethod::getListFromDB($DB, [$restrictions = '']) [line 72]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function PayMethod::getName($lang) [line 97]Function Parameters:

$lang

Function to retrieve custom auction field name for the language

Access public

Page 394 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 434: Manual

void function PayMethod::saveToDB($DB) [line 106]Function Parameters:

MyPDO $DB

Access public

void function PayMethod::__get($property) [line 27]Function Parameters:

$property

Access public

void function PayMethod::__set($property, $value) [line 36]Function Parameters:

$property $value

Access public

Page 395 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 435: Manual

Class Paypal [line 9]

Paypal class

Package general

Paypal::DB_TABLE

= 'V5_paypalTransactions' [line 11]

Paypal::IPN_ACCEPTED

= 'ACCEPTED' [line 24]

Paypal::IPN_COMPLETED

= 'COMPLETED' [line 20]

Paypal::IPN_DENIED

= 'DENIED' [line 19]

Paypal::IPN_FAILED

= 'FAILED' [line 22]

Paypal::IPN_INVALID

= 'INVALID' [line 17]

Paypal::IPN_PENDING

= 'PENDING' [line 18]

Paypal::IPN_SUCCESS

= 'SUCCESS' [line 23]

Paypal::IPN_UNKNOWN

= 'UNKNOWN' [line 21]

Paypal::IPN_VERIFIED

= 'VERIFIED' [line 16]

IPN Response

Paypal::$_bussiness

Page 396 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 436: Manual

mixed = [line 66]

reciever email

Access private

Paypal::$_cancelURL

mixed = [line 51]

cancel url

Access private

Paypal::$_errorMessage

mixed = [line 26]

Access private

Paypal::$_fields

mixed = [line 31]

Data to be submited to paypal

Access private

Paypal::$_ipnData

Page 397 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 437: Manual

mixed = [line 36]

post values for IPN

Access private

Paypal::$_ipnResponse

mixed = [line 41]

IPN response

Access private

Paypal::$_notifyURL

mixed = [line 56]

notify url

Access private

Paypal::$_returnURL

mixed = [line 46]

paypal return url

Access private

Page 398 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 438: Manual

Paypal::$_url

mixed = [line 61]

paypal url

Access private

Constructor void function Paypal::__construct([$paymentEmulation = 1]) [line 68]Function Parameters:

$paymentEmulation

Access public

void function Paypal::addFields($field, $value) [line 95]Function Parameters:

$field $value

Access public

self function Paypal::configureOptions($amount, $type, $id, $itemDesc, $context, $DB) [line 201]Function Parameters:

float $amount amountstring $type payment type

Page 399 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 439: Manual

varible $id id of the offer/invoice/user/etc for which payment is being madestring $itemDesc item descriptionContext $context Context objectMyPDO $DB MyPDO object

function to configure paypal options for different uses

Static Access public

IPN function Paypal::validateIPN() [line 105]method to validate transaction from paypal

Access public

void function Paypal::__get($property) [line 75]Function Parameters:

$property

Access public

void function Paypal::__set($property, $value) [line 85]Function Parameters:

$property $value

Page 400 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 440: Manual

Access public

Class PennyAuction [line 9]

PennyAuction

Package general

PennyAuction::EXTENDED_DB_TABLE

= 'V5_pennyAuctions' [line 11]

PennyAuction::$bidIncrementValue

mixed = [line 13]

Access protected

Constructor void function PennyAuction::__construct() [line 15]

Access public

void function PennyAuction::calculateNextBid() [line 174]

Access public

Page 401 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 441: Manual

void function PennyAuction::finishOffer() [line 141]

Access public

void function PennyAuction::getBidButtonText() [line 317]

Access public

void function PennyAuction::getExtendedDataFromDB($DB) [line 234]Function Parameters:

MyPDO $DB

retrieves data needed for concrete child

Access public

void function PennyAuction::getInstanceFromDB($DB, $id) [line 221]Function Parameters:

MyPDO $DB $id

Static Access public

Page 402 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 442: Manual

void function PennyAuction::getListFromDB($DB, [$restrictions = '']) [line 251]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function PennyAuction::getListOnOneCategory($DB, $categoryId) [line 262]Function Parameters:

MyPDO $DB $categoryId

Static Access public

void function PennyAuction::getWinners() [line 155]

Access public

void function PennyAuction::makeBid($b) [line 21]Function Parameters:

Bid $b

Page 403 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 443: Manual

Access public

void function PennyAuction::removeUserBids($DB, $userToExclude) [line 322]Function Parameters:

MyPDO $DB User $userToExclude

Access public

void function PennyAuction::saveToDB($DB) [line 273]Function Parameters:

MyPDO $DB

Access public

void function PennyAuction::type() [line 164]

Access public

void function PennyAuction::typeName() [line 169]

Access public

void function PennyAuction::__get($property) [line 184]

Page 404 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 444: Manual

Function Parameters:

$property

Access public

void function PennyAuction::__set($property, $value) [line 194]Function Parameters:

$property $value

Access public

Class ReverseAuction [line 9]

ReverseAuction

Package general

Constructor void function ReverseAuction::__construct() [line 11]

Access public

Page 405 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 445: Manual

int function ReverseAuction::calculateNextBid() [line 79]Calculates next correct bid value

Access public

bool function ReverseAuction::finishOffer() [line 46]

Access public

void function ReverseAuction::getBidButtonText() [line 150]

Access public

void function ReverseAuction::getExtendedDataFromDB($DB) [line 108]Function Parameters:

MyPDO $DB

Access public

void function ReverseAuction::getInstanceFromDB($DB, $id) [line 98]Function Parameters:

MyPDO $DB $id

Page 406 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 446: Manual

Static Access public

void function ReverseAuction::getListFromDB($DB, [$restrictions = '']) [line 113]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function ReverseAuction::getListOnOneCategory($DB, $categoryId) [line 124]Function Parameters:

MyPDO $DB $categoryId

Static Access public

void function ReverseAuction::getWinners() [line 66]

Access public

bool function ReverseAuction::makeBid($b) [line 19]

Page 407 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 447: Manual

Function Parameters:

Bid $b

Access public

void function ReverseAuction::saveToDB($DB) [line 135]Function Parameters:

MyPDO $DB

Access public

void function ReverseAuction::type() [line 88]

Access public

void function ReverseAuction::typeName() [line 93]

Access public

Class SiteOptions [line 10]

Page 408 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 448: Manual

SiteOptionsclass to manage general options

Package general

SiteOptions::DB_TABLE

= 'V5_siteOptions' [line 15]

General Options table

SiteOptions::SSL_IN_LOGIN

= 'SSL_ON_LOGIN' [line 20]

constant for ssl on login page only

SiteOptions::$_generalOption

mixed = [line 22]

Access private

SiteOptions::$_keys

mixed = [line 23]

Access private

Constructor void function SiteOptions::__construct() [line 25]

Access private

Page 409 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 449: Manual

void function SiteOptions::getInstanceFromDB($DB, $id) [line 57]Function Parameters:

MyPDO $DB $id

Static Access public

void function SiteOptions::getListFromDB($DB, [$restrictions = '']) [line 78]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function SiteOptions::getThemeList() [line 103]Function to list of themes

Static Access public

void function SiteOptions::saveToDB($DB) [line 87]Function Parameters:

MyPDO $DB

Page 410 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 450: Manual

saving changes to database

Access public

void function SiteOptions::__get($property) [line 29]Function Parameters:

$property

Access public

void function SiteOptions::__set($property, $value) [line 43]Function Parameters:

$property $value

Access public

Class StandardAuction [line 9]

StandardAuction

Page 411 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 451: Manual

Package general

StandardAuction::BID_INCREMENTS_DB_TABLE

= 'V5_bidIncrements' [line 12]

StandardAuction::BID_INCREMENT_FIXED

= "FIXED" [line 21]

StandardAuction::BID_INCREMENT_TABLE

= "TABLE" [line 20]

StandardAuction::EXTENDED_DB_TABLE

= 'V5_standardAuctions' [line 11]

StandardAuction::$bidIncrements

mixed = [line 18]

Access protected

StandardAuction::$bidIncrementType

mixed = [line 16]

Access protected

StandardAuction::$bidIncrementValue

mixed = [line 17]

Access protected

Page 412 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 452: Manual

StandardAuction::$buyNowPrice

mixed = [line 15]

Access protected

StandardAuction::$reservePrice

mixed = [line 14]

Access protected

Constructor void function StandardAuction::__construct() [line 23]

Access public

void function StandardAuction::calculateNextBid() [line 185]

Access public

void function StandardAuction::finishOffer() [line 137]

Access public

void function StandardAuction::getBidButtonText() [line 368]

Page 413 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 453: Manual

Access public

void function StandardAuction::getExtendedDataFromDB($DB) [line 279]Function Parameters:

MyPDO $DB

retrieves data needed for concrete child

Access public

void function StandardAuction::getInstanceFromDB($DB, $id) [line 266]Function Parameters:

MyPDO $DB $id

Static Access public

void function StandardAuction::getListFromDB($DB, [$restrictions = '']) [line 308]Function Parameters:

MyPDO $DB $restrictions

Static Access public

Page 414 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 454: Manual

void function StandardAuction::getListOnOneCategory($DB, $categoryId) [line 319]Function Parameters:

MyPDO $DB $categoryId

Static Access public

void function StandardAuction::getWinners() [line 166]

Access public

void function StandardAuction::makeBid($b) [line 32]Function Parameters:

Bid $b

Access public

void function StandardAuction::removeUserBids($DB, $userToExclude) [line 373]Function Parameters:

MyPDO $DB User $userToExclude

Page 415 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 455: Manual

Access public

void function StandardAuction::saveToDB($DB) [line 330]Function Parameters:

MyPDO $DB

Access public

void function StandardAuction::type() [line 175]

Access public

void function StandardAuction::typeName() [line 180]

Access public

void function StandardAuction::__get($property) [line 215]Function Parameters:

$property

Access public

void function StandardAuction::__set($property, $value) [line 226]

Page 416 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 456: Manual

Function Parameters:

$property $value

Access public

Class Store [line 9]

web store class

Package general

Store::DB_TABLE

= 'V5_stores' [line 14]

database tables

Store::STORE_BIG

= 'BIG' [line 22]

Store::STORE_MEDIUM

= 'MEDIUM' [line 21]

Store::STORE_SIZE_TABLE

= 'V5_storesSize' [line 15]

Store::STORE_SMALL

Page 417 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 457: Manual

= 'SMALL' [line 20]

store size constants

Store::$_active

mixed = [line 30]

Access private

Store::$_description

mixed = [line 26]

Access private

Store::$_featured

mixed = [line 29]

Access private

Store::$_id

mixed = [line 24]

Access private

Store::$_logo

mixed = [line 32]

Page 418 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 458: Manual

Access private

Store::$_name

mixed = [line 25]

Access private

Store::$_offers

mixed = [line 33]

Access private

Store::$_owner

mixed = [line 27]

Access private

Store::$_size

mixed = [line 28]

Access private

Store::$_test

mixed = [line 31]

Page 419 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 459: Manual

Access private

Constructor void function Store::__construct() [line 35]

Access public

bool function Store::deleteFromDB($DB) [line 319]Function Parameters:

MyPDO $DB database instance

function to delete store

Access public

void function Store::discoverId($DB, $s) [line 199]Function Parameters:

MyPDO $DB $s

Given a string, verify if it's webstore id or webstore name or nothing.

Static Access public

Page 420 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 460: Manual

void function Store::getInstanceFromDB($DB, $id) [line 101]Function Parameters:

MyPDO $DB $id

Static Access public

void function Store::getListFromDB($DB, [$restrictions = '']) [line 153]Function Parameters:

MyPDO $DB $restrictions

Static Access public

array function Store::getOffersInStore($DB) [line 138]Function Parameters:

MyPDO $DB database instance

function to return offers in the webstore

Access public

Page 421 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 461: Manual

void function Store::getStatsFromDB($DB) [line 340]Function Parameters:

MyPDO $DB

return webstore stats

Static Access public

Store function Store::getUserStore($DB, $user) [line 179]Function Parameters:

MyPDO $DB database instanceUser $user store owner

function to return specified users store

Static Access public

bool function Store::offerAllowedInStore($DB, $user) [line 228]Function Parameters:

MyPDO $DB database instanceUser $user user

check if more offers can be added to the user store or not(Store::size)

Page 422 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 462: Manual

Static Access public

bool function Store::offerAvailableInStore($offerObj) [line 249]Function Parameters:

Offer $offerObj offer to search for

function to check if specified offer already exists in the store

Access public

void function Store::saveToDB($DB) [line 263]Function Parameters:

MyPDO $DB

Access public

void function Store::__get($property) [line 46]Function Parameters:

$property

interceptors

Page 423 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 463: Manual

Access public

void function Store::__set($property, $value) [line 56]Function Parameters:

$property $value

Access public

Class StoreSize [line 9]

web store size class

Package general

StoreSize::DB_TABLE

= 'V5_storesSize' [line 14]

database tables

StoreSize::STORE_LANGUAGE_TABLE

= 'V5_storesSize_languages' [line 15]

StoreSize::$_active

mixed = [line 19]

Page 424 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 464: Manual

Access private

StoreSize::$_id

mixed = [line 17]

Access private

StoreSize::$_name

mixed = [line 20]

Access private

StoreSize::$_size

mixed = [line 18]

Access private

Constructor void function StoreSize::__construct() [line 22]

Access public

void function StoreSize::deleteFromDB($DB) [line 168]Function Parameters:

MyPDO $DB

Page 425 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 465: Manual

Access public

void function StoreSize::getInstanceFromDB($DB, $id) [line 63]Function Parameters:

MyPDO $DB $id

Static Access public

void function StoreSize::getListFromDB($DB, [$restrictions = '']) [line 93]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function StoreSize::getName($languageId) [line 186]Function Parameters:

$languageId

Page 426 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 466: Manual

Access public

void function StoreSize::saveToDB($DB) [line 117]Function Parameters:

MyPDO $DB

Access public

void function StoreSize::setName($name, $languageId, [$defaultLang = 'en_US']) [line 178]Function Parameters:

$name $languageId $defaultLang

setter and getter for name

Access public

void function StoreSize::__get($property) [line 27]Function Parameters:

$property

Access public

Page 427 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 467: Manual

void function StoreSize::__set($property, $value) [line 37]Function Parameters:

$property $value

Access public

Class Thematic [line 9]

Thematic

Package general

Thematic::DB_TABLE

= 'V5_customThematics' [line 14]

database tables

Thematic::THEMATIC_LANGUAGE_TABLE

= 'V5_customThematics_languages' [line 15]

Thematic::$_active

mixed = [line 25]

Page 428 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 468: Manual

Access private

Thematic::$_id

mixed = [line 21]

Access private

Thematic::$_inFooter

mixed = [line 23]

Access private

Thematic::$_inHomeColumn

mixed = [line 24]

Access private

Thematic::$_inMenu

mixed = [line 22]

Access private

Thematic::$_name

mixed = [line 20]

Page 429 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 469: Manual

member variables

Access private

Constructor void function Thematic::__construct() [line 27]

Access public

void function Thematic::addName($language, $name) [line 190]Function Parameters:

string $language language language idstring $name name name to add

Function to add and retrive thematic name

Access public

void function Thematic::deleteFromDB($DB) [line 179]Function Parameters:

MyPDO $DB

Deleting record from database

Access public

Page 430 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 470: Manual

void function Thematic::discoverId($DB, $s) [line 96]Function Parameters:

MyPDO $DB $s

Static Access public

void function Thematic::getInstanceFromDB($DB, $id) [line 56]Function Parameters:

MyPDO $DB $id

Static Access public

void function Thematic::getListFromDB($DB, [$restrictions = '']) [line 87]Function Parameters:

MyPDO $DB $restrictions

Static Access public

Page 431 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 471: Manual

void function Thematic::getName($language) [line 195]Function Parameters:

$language

Access public

void function Thematic::saveToDB($DB) [line 118]Function Parameters:

MyPDO $DB

Saving changes to database

Access public

bool function Thematic::thematicExists($DB, $thematicName, [$restrictions = ''], $name) [line 209]Function Parameters:

MyPDO $DB database instancestring $name Thematic name $thematicName $restrictions

Function to check if a thematic already exists

Static Access public

Page 432 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 472: Manual

void function Thematic::__get($property) [line 36]Function Parameters:

$property

Access public

void function Thematic::__set($property, $value) [line 46]Function Parameters:

$property $value

Access public

Class Timezone [line 9]

Timezone class

Package general

Timezone::DB_TABLE

Page 433 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 473: Manual

= 'V5_timezones' [line 14]

Database table

Timezone::$_id

mixed = [line 15]

Access private

void function Timezone::getInstanceFromDB($DB, $id) [line 32]Function Parameters:

MyPDO $DB $id

Static Access public

void function Timezone::getListFromDB($DB, [$restrictions = '']) [line 50]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function Timezone::__get($property) [line 17]Function Parameters:

Page 434 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 474: Manual

$property

Access public

void function Timezone::__set($property, $value) [line 27]Function Parameters:

$property $value

Access public

Class User [line 10]

User

Package general

User::ADMIN

= 'ADMIN' [line 67]

User::DB_TABLE

= 'V5_users' [line 15]

Page 435 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 475: Manual

DB Tables

User::DB_USER_FIELD_TABLE

= 'V5_users_userFields' [line 17]

User::DB_USER_TRUST_REQUEST_TABLE

= 'V5_users_trustStatusRequest' [line 18]

User::EMAIL_VERIFIED

= 'EMAIL_VERIFIED_BUT_ACCOUNT_NOT_ACTIVATED' [line 68]

User::INACTIVE

= 'INACTIVE' [line 64]

User Status constants

User::NEVER_ACTIVATED

= 'NEVER_ACTIVATED' [line 65]

User::SELLER

= 'SELLER' [line 66]

User::TRUST_REQUEST_ACCEPTED

= 'ACCEPTED' [line 73]

trust user status request status

User::TRUST_REQUEST_DENIED

= 'DENIED' [line 75]

User::TRUST_REQUEST_PENDING

= 'PENDING' [line 74]

User::USER_IP_TABLE

= 'V5_usersIP' [line 16]

User::$active

mixed = [line 33]

Access protected

Page 436 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 476: Manual

User::$address

mixed = [line 25]

Access protected

User::$admin

mixed = [line 37]

Access protected

User::$balance

mixed = [line 35]

Access protected

User::$bidCredit

mixed = [line 36]

Access protected

User::$birthdate

mixed = [line 31]

Page 437 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 477: Manual

Access protected

User::$city

mixed = [line 26]

Access protected

User::$countryId

mixed = [line 29]

Access protected

User::$customFields

mixed = [line 50]

variable for custom Fields

Access protected

User::$email

mixed = [line 23]

Access protected

User::$id

Page 438 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 478: Manual

mixed = [line 20]

Access protected

User::$name

mixed = [line 24]

Access protected

User::$password

mixed = [line 21]

Access protected

User::$passwordEncripted

mixed = [line 22]

Access protected

User::$phone

mixed = [line 30]

Access protected

User::$prestige

Page 439 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 479: Manual

mixed = [line 32]

Access protected

User::$registerDate

mixed = [line 34]

Access protected

User::$seller

mixed = [line 39]

Access protected

User::$sessionCookie

mixed = [line 38]

Access protected

User::$state

mixed = [line 27]

Access protected

Page 440 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 480: Manual

User::$trustSeller

mixed = [line 40]

Access protected

User::$trustUserRequestStatus

mixed = [line 59]

Access protected

User::$trustUserStatusRequested

mixed = [line 58]

variable to identify if user has requested for trust user status

Access protected

User::$userLanguage

mixed = [line 46]

User language for his received mails

Access protected

User::$userPayMethods

mixed = [line 54]

Page 441 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 481: Manual

variable to store user pay method details

Access protected

User::$validEmail

mixed = [line 41]

Access protected

User::$zip

mixed = [line 28]

Access protected

Constructor void function User::__construct() [line 82]Constructor of the User class is private to allow future child use

Access private

bool function User::addFieldValue($fieldId, $value, [$mandatory = 1], [$name = '']) [line 490]Function Parameters:

int $fieldId field id to add value forstring $value $mandatory $name

Page 442 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 482: Manual

function to add custom field value

Access public

void function User::addUserIP($DB, $userId) [line 634]Function Parameters:

MyPDO $DB $userId

Function to add User IP to userIP table

Static Access public

void function User::deleteFromDB($DB) [line 421]Function Parameters:

MyPDO $DB

Access public

void function User::deleteIP($DB, $IP, $userId) [line 691]Function Parameters:

MyPDO $DB $IP

Page 443 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 483: Manual

$userId

function to remove particular IP from the database

Static Access public

void function User::deleteSession() [line 623]

Static Access public

bool function User::deleteUserInvoices($DB) [line 929]Function Parameters:

MyPDO $DB database instance

function to delete user invoices

Access public

void function User::getBidsStatsFromDB($DB) [line 767]Function Parameters:

MyPDO $DB

Page 444 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 484: Manual

Access public

void function User::getCustomUserData($DB, $userId) [line 473]Function Parameters:

MyPDO $DB $userId

function to retrieve users custom data

Static Access public

void function User::getDefaultUserType($DB) [line 456]Function Parameters:

MyPDO $DB

get the default new user type

Static Access public

void function User::getFieldValue($fieldId) [line 501]Function Parameters:

$fieldId

function to retrieve the value of a particular field

Page 445 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 485: Manual

Access public

array function User::getFilteredListFromDB($DB, [$keyword = ''], [$type = '']) [line 536]Function Parameters:

MyPDO $DB database instancestring $keyword search keywordstring $type type of filter to use on list

Function returns a filtered list of users

Static Access public

void function User::getFiltersNames() [line 512]

Static Access public

void function User::getGeneralStatsFromDB($DB) [line 714]Function Parameters:

MyPDO $DB

get some statistics about all website users (for back-end home page)

Page 446 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 486: Manual

Static Access public

void function User::getInstance() [line 97]

Static Access public

void function User::getInstanceFromDB($DB, $id) [line 191]Function Parameters:

MyPDO $DB $id

Static Access public

void function User::getListFromDB($DB, [$restrictions = '']) [line 240]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function User::getMessageStats($DB) [line 835]Function Parameters:

MyPDO $DB

Page 447 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 487: Manual

Access public

array function User::getOffersStatsFromDB($DB) [line 736]Function Parameters:

MyPDO $DB database instance

retrieves user's offers statistics

Access public

void function User::getPublicData() [line 911]

Access public

array function User::getStatsFromDB($DB) [line 808]Function Parameters:

MyPDO $DB

Returns detailed user statistics from database

offersInvolved: offers the user created or have wonoffersStats: some stats that getOffersStatsFromDB returnbidsfeedbacksTotal: total amount of feedbacks received and sentfeedbacksStats: detail of feedbacks statsinvoicesTotal: total amount of invoices

Page 448 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 488: Manual

Access public

array function User::getUserFavourite($DB, [$type = '']) [line 871]Function Parameters:

MyPDO $DB database objectstring $type type of favourite

Function to return list of user favourites

Access public

array function User::getUserFeedbacksStatsFromDB($DB) [line 780]Function Parameters:

MyPDO $DB database instance

retrieves user's bids statistics

Access public

void function User::getUserIPList($DB, $userId) [line 673]Function Parameters:

MyPDO $DB

Page 449 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 489: Manual

$userId

function to retrieve list of ips for this user

Access public

bool function User::isUserFavourite($DB, $focusId, $type) [line 851]Function Parameters:

MyPDO $DB database instancestring $focusId look for this idstring $type type of favourite

Access public

bool function User::recalculateFeedbacks($DB) [line 951]Function Parameters:

MyPDO $DB database instance

function to recalculate each users prestige, if it's being affected due to removal of anyuser

Access public

void function User::renewSession($DB) [line 609]Function Parameters:

Page 450 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 490: Manual

MyPDO $DB

Access public

void function User::saveToDB($DB) [line 283]Function Parameters:

MyPDO $DB

Access public

void function User::setDefaultType($DB, $seller) [line 438]Function Parameters:

MyPDO $DB $seller

function to change default type of seller column

Static Access public

void function User::toggleIPStatus($DB, $IP, $userId, [$block = 1]) [line 701]Function Parameters:

MyPDO $DB $IP

Page 451 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 491: Manual

$userId $block

function to block/unblock ip

Static Access public

void function User::verifyPassword($DB, $id, $password) [line 581]Function Parameters:

MyPDO $DB $id $password

Static Access public

void function User::verifySession($DB, $id, $cookie) [line 570]Function Parameters:

MyPDO $DB $id $cookie

Function to verify the session

Static Access public

Page 452 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 492: Manual

void function User::verifyUserIP($DB, $ip) [line 681]Function Parameters:

MyPDO $DB $ip

function to verify the IP

Static Access private

void function User::__get($property) [line 102]Function Parameters:

$property

Access public

void function User::__set($property, $value) [line 116]Function Parameters:

$property $value

Access public

Page 453 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 493: Manual

Class UserFeedback [line 9]

UserFeedback

Package general

UserFeedback::DB_TABLE

= 'V5_userFeedbacks' [line 14]

DB Table

UserFeedback::$comment

mixed = [line 21]

Access protected

UserFeedback::$date

mixed = [line 22]

Access protected

UserFeedback::$fromUser

mixed = [line 17]

Page 454 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 494: Manual

Access protected

UserFeedback::$id

mixed = [line 16]

Access protected

UserFeedback::$offer

mixed = [line 19]

Access protected

UserFeedback::$toUser

mixed = [line 18]

Access protected

UserFeedback::$value

mixed = [line 20]

Access protected

void function UserFeedback::deleteFromDB($DB) [line 175]Function Parameters:

MyPDO $DB

Page 455 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 495: Manual

function to delete the current record from database

Access public

void function UserFeedback::getInstanceFromDB($DB, $id) [line 63]Function Parameters:

MyPDO $DB $id

Static Access public

void function UserFeedback::getListFromDB($DB, [$restrictions = '']) [line 93]Function Parameters:

MyPDO $DB $restrictions

Static Access public

void function UserFeedback::getTypesCount($DB, $userId) [line 112]Function Parameters:

MyPDO $DB $userId

Page 456 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 496: Manual

returns positive, negative and neutral votes for an user

Static Access public

void function UserFeedback::saveToDB($DB) [line 133]Function Parameters:

MyPDO $DB

Access public

void function UserFeedback::__get($property) [line 24]Function Parameters:

$property

Access public

void function UserFeedback::__set($property, $value) [line 34]Function Parameters:

$property $value

Page 457 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 497: Manual

Access public

Class UserPayMethod [line 9]

UserPayMethods

Package general

UserPayMethod::DB_TABLE

= 'V5_users_paymethods' [line 14]

DB tables

UserPayMethod::$_active

mixed = [line 18]

Access private

UserPayMethod::$_details

mixed = [line 20]

Access private

Page 458 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 498: Manual

UserPayMethod::$_id

mixed = [line 16]

Access private

UserPayMethod::$_paymethodId

mixed = [line 17]

Access private

UserPayMethod::$_userId

mixed = [line 19]

Access private

Constructor void function UserPayMethod::__construct() [line 22]

Access public

void function UserPayMethod::deleteFromDB($DB) [line 170]Function Parameters:

MyPDO $DB

Access public

Page 459 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 499: Manual

void function UserPayMethod::getInstanceFromDB($DB, $id) [line 60]Function Parameters:

MyPDO $DB $id

Static Access public

array function UserPayMethod::getListFromDB($DB, [$restrictions = '']) [line 113]Function Parameters:

MyPDO $DB database instance $restrictions

function to return array of users paymethod data available

Static Access public

void function UserPayMethod::saveToDB($DB) [line 130]Function Parameters:

MyPDO $DB

Access public

Page 460 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 500: Manual

void function UserPayMethod::__get($property) [line 26]Function Parameters:

$property

Access public

void function UserPayMethod::__set($property, $value) [line 36]Function Parameters:

$property $value

Access public

Page 461 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 501: Manual

Appendices

Page 462 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 502: Manual

Appendix A - Class Trees

Package enuukAuction

ResponseHandler

ResponseHandler

Package general

BannedEmail

BannedEmail

Banner

Banner

Bid

Bid

BidIncrement

BidIncrement

BidPack

BidPack

Page 463 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 503: Manual

Category

Category

Core_PresentationData

Core_PresentationData

Country

Country

Cron

Cron

Currency

Currency

CustomField

CustomField

CustomOfferField

CustomOfferField

CustomPage

Page 464 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 504: Manual

CustomPage

DBReadable

DBReadable

DBSearchable

DBSearchable

DBWritable

DBWritable

Favourite

Favourite

Fee

Fee

FeeRangeContainer

FeeRangeContainer

Image

Image

Page 465 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 505: Manual

Invoice

Invoice

Item

Item

Language

Language

Message

Message

MetaTag

MetaTag

Offer

OfferFixedAuctionLotAuctionPennyAuctionReverseAuctionStandardAuction

Page 466 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 506: Manual

OffersQuestion

OffersQuestion

PayMethod

PayMethod

Paypal

Paypal

SiteOptions

SiteOptions

Store

Store

StoreSize

StoreSize

Thematic

Thematic

Timezone

Page 467 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 507: Manual

Timezone

User

User

UserFeedback

UserFeedback

UserPayMethod

UserPayMethod

Package upgrader

Upgrader

Upgrader

Package utils

Date

Date

DB

DB

Page 468 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 508: Manual

Error

Error

GoogleCheckout

GoogleCheckout

MailNotificator

MailNotificator

MyPDO

PDOMyPDO

String

String

SystemInspector

SystemInspector

SystemInstaller

SystemInstaller

Package Core

Page 469 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 509: Manual

Core_Action

Core_ActionAction_AdminAction_Admin_BannerAction_Admin_BidPackAction_Admin_CategoryAction_Admin_CountryAction_Admin_CurrencyAction_Admin_CustomAuctionFieldsAction_Admin_CustomFieldsAction_Admin_CustomPagesAction_Admin_FeeAction_Admin_IndexAction_Admin_InvoicesAction_Admin_OffersAction_Admin_PayMethodAction_Admin_SettingsAction_Admin_StoreAction_Admin_StoreSizeAction_Admin_ThematicsAction_Admin_UserAction_BidPackAction_CategoryAction_CustomPageAction_FeeAction_IndexAction_InvoicepayAction_MessageAction_OfferAction_PaypalDirectPayAction_ResponseHandlerAction_SearchAction_StoreAction_UserAction_UserPayMethod

Core_Context

Core_Context

Page 470 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 510: Manual

Core_Controller

Core_Controller

Core_View

Core_ViewView_CSVView_EchoView_HTMLView_JSONView_PHPView_Rss

Package Action

Action_Admin

Core_Action (Different package)Action_Admin

Action_Admin_BidPack

Core_Action (Different package)Action_Admin_BidPack

Action_Admin_StoreSize

Core_Action (Different package)Action_Admin_StoreSize

Page 471 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 511: Manual

Action_BidPack

Core_Action (Different package)Action_BidPack

Action_Category

Core_Action (Different package)Action_Category

Action_CustomPage

Core_Action (Different package)Action_CustomPage

Action_Fee

Core_Action (Different package)Action_Fee

Action_Index

Core_Action (Different package)Action_Index

Action_Invoicepay

Core_Action (Different package)

Page 472 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 512: Manual

Action_Invoicepay

Action_Message

Core_Action (Different package)Action_Message

Action_Offer

Core_Action (Different package)Action_Offer

Action_PaypalDirectPay

Core_Action (Different package)Action_PaypalDirectPay

Action_ResponseHandler

Core_Action (Different package)Action_ResponseHandler

Action_Search

Core_Action (Different package)Action_Search

Action_Store

Page 473 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 513: Manual

Core_Action (Different package)Action_Store

Action_User

Core_Action (Different package)Action_User

Action_UserPayMethod

Core_Action (Different package)Action_UserPayMethod

Package Action_Admin

Action_Admin_Banner

Core_Action (Different package)Action_Admin_Banner

Action_Admin_Category

Core_Action (Different package)Action_Admin_Category

Action_Admin_Country

Core_Action (Different package)Action_Admin_Country

Page 474 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 514: Manual

Action_Admin_Currency

Core_Action (Different package)Action_Admin_Currency

Action_Admin_CustomAuctionFields

Core_Action (Different package)Action_Admin_CustomAuctionFields

Action_Admin_CustomFields

Core_Action (Different package)Action_Admin_CustomFields

Action_Admin_CustomPages

Core_Action (Different package)Action_Admin_CustomPages

Action_Admin_Fee

Core_Action (Different package)Action_Admin_Fee

Action_Admin_Index

Core_Action (Different package)

Page 475 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 515: Manual

Action_Admin_Index

Action_Admin_Invoices

Core_Action (Different package)Action_Admin_Invoices

Action_Admin_Offers

Core_Action (Different package)Action_Admin_Offers

Action_Admin_PayMethod

Core_Action (Different package)Action_Admin_PayMethod

Action_Admin_Settings

Core_Action (Different package)Action_Admin_Settings

Action_Admin_Store

Core_Action (Different package)Action_Admin_Store

Action_Admin_Thematics

Page 476 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 516: Manual

Core_Action (Different package)Action_Admin_Thematics

Action_Admin_User

Core_Action (Different package)Action_Admin_User

Package Views

View_CSV

Core_View (Different package)View_CSV

View_Echo

Core_View (Different package)View_Echo

View_HTML

Core_View (Different package)View_HTML

View_JSON

Core_View (Different package)View_JSON

Page 477 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 517: Manual

View_PHP

Core_View (Different package)View_PHP

View_Rss

Core_View (Different package)View_Rss

Package migrator

Migrator

Migrator

Page 478 of 478Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 518: Manual

Index

AAction_Admin_Invoices::paymentType() 162

payment type actionAction_Admin_Invoices::invoiceDetails() 162

invoice details actionAction_Admin_Invoices::headerFooter() 161

Invoice Header Footer update actionAction_Admin_Invoices::resendInvoice() 162

re-send invoice actionAction_Admin_Invoices::sendInvoices() 162

Send invoice ActionAction_Admin_Invoices::settings() 163

Invoice settings actionAction_Admin_Invoices::sentInvoices() 163

sent invoices actionAction_Admin_Invoices::deleteInvoice() 161

delete invoice actionAction_Admin_Invoices::defaultAction() 161Action_Admin_Fee::suspend() 160Action_Admin_Fee::general() 160Action_Admin_Fee::feeLangList() 159

Action to display fee list for editing fee description and titleAction_Admin_Fee::verifyOptionalParams() 160

Function to verify optional parametersAction_Admin_Index 160

Action for Admin homepageAction_Admin_Invoices 161

InvoiceAction_Admin_Index::defaultAction() 161

Default actionAction_Admin_Invoices::updateStatus() 163

invoice status toggle actionAction_Admin_Invoices::verifyHeaderFooter() 163Action_Admin_Offers::publishOffer() 166Action_Admin_Offers::processOfferForm() 165

saves all data from the offerForm, and save it as draftAction_Admin_Offers::edit() 165

edit detailsAction_Admin_Offers::types() 166Action_Admin_PayMethod 166

Action for Admin backend Pay method pagesAction_Admin_PayMethod::add() 167Action_Admin_PayMethod::activate() 166Action_Admin_Offers::delete() 165Action_Admin_Offers::defaultAction() 165

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 519: Manual

Action_Admin_Offers 164Action for Admin backend Offers

Action_Admin_Invoices::verifyInvoiceSettings() 163Action_Admin_Offers::activate() 164Action_Admin_Offers::auctionAutoExtension() 164

action auction auto extensionAction_Admin_Offers::deactivate() 165Action_Admin_Offers::bidIncrementSetting() 164Action_Admin_Fee::feeLangEdit() 159

action to edit fee title and description of particular feeAction_Admin_Fee::details() 159Action_Admin_CustomFields 154

CustomFieldAction_Admin_CustomAuctionFields::verifyOptionalParams() 153

Function to verify optional parametersAction_Admin_CustomAuctionFields::suspend() 153

suspend of de-activate actionAction_Admin_CustomFields::activate() 154

Activate actionAction_Admin_CustomFields::add() 154Action_Admin_CustomFields::delete() 154

delete field actionAction_Admin_CustomFields::defaultAction() 154Action_Admin_CustomAuctionFields::edit() 153Action_Admin_CustomAuctionFields::delete() 153

delete field actionAction_Admin_Currency::edit() 152Action_Admin_Currency::defaultAction() 151Action_Admin_Currency::add() 151Action_Admin_CustomAuctionFields 152

CustomOfferFieldAction_Admin_CustomAuctionFields::activate() 152

Activate actionAction_Admin_CustomAuctionFields::defaultAction() 152Action_Admin_CustomAuctionFields::add() 152Action_Admin_CustomFields::edit() 155Action_Admin_CustomFields::suspend() 155

suspend of de-activate actionAction_Admin_CustomPages::verifyOptionalParams() 158

function to verify optional parametersAction_Admin_CustomPages::suspend() 157

suspend of de-activate actionAction_Admin_CustomPages::maxListedPages() 157

max Custom Pages actionAction_Admin_CustomPages::verifyParameters() 158

function to verify parametersAction_Admin_Fee 158

Action for Admin backend Fee settings pagesAction_Admin_Fee::defaultAction() 159Action_Admin_Fee::activate() 159Action_Admin_CustomPages::edit() 157

page edit actionAction_Admin_CustomPages::delete() 157

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 520: Manual

delete page actionAction_Admin_CustomFields::verifyParameters() 155

function to verify parametersAction_Admin_CustomFields::verifyOptionalParams() 155

Function to verify optional parametersAction_Admin_CustomPages 156

CustomPagesAction_Admin_CustomPages::activate() 156

Activate actionAction_Admin_CustomPages::defaultAction() 157

default actionAction_Admin_CustomPages::add() 156

page Add actionAction_Admin_PayMethod::deactivate() 167Action_Admin_PayMethod::defaultAction() 167

Default actionAction_Admin_User::ban() 178Action_Admin_User::activate() 178

reactivate actionAction_Admin_User 177

Action for Admin backend Settings pagesAction_Admin_User::bannedEmails() 178Action_Admin_User::bids() 178

user bid actionAction_Admin_User::delete() 179

Delete ActionAction_Admin_User::defaultAction() 178

Default actionAction_Admin_Thematics::verifyParameters() 177

function to verify parametersAction_Admin_Thematics::verifyOptionalParams() 177

Function to verify optional parametersAction_Admin_Thematics::add() 176

page Add actionAction_Admin_Thematics::activate() 175

activate actionAction_Admin_Thematics 175

CustomPagesAction_Admin_Thematics::defaultAction() 176Action_Admin_Thematics::delete() 176Action_Admin_Thematics::suspend() 176Action_Admin_Thematics::edit() 176

page edit actionAction_Admin_User::deleteConfirm() 179

delete confirm actionAction_Admin_User::displayUserOffers() 179

display user offersAction_Admin_User::unban() 181Action_Admin_User::suspendConfirm() 181

suspend actionAction_Admin_User::suspend() 181

suspendAction_Admin_User::verifyCustomParameters() 182

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 521: Manual

function to verify custom fieldsAction_Admin_User::verifyUserParameters() 182

test each parameter for correct inputAction.php 184Action_Admin_User::viewip() 182

View IP actionAction_Admin_User::search() 181

Search actionAction_Admin_User::offers() 181

Offers ActionAction_Admin_User::feedback() 179

User feedback actionAction_Admin_User::edit() 179

export actionAction_Admin_User::filter() 180

filter actionAction_Admin_User::invoice() 180

invoice ActionAction_Admin_User::newUserType() 180

default new user type actionAction_Admin_User::invoiceDetails() 180

invoiceDetail ActionAction_Admin_Store::doDelete() 175Action_Admin_Store::doDeactivate() 174

action specific functionsAction_Admin_Settings::defaultCurrency() 169

default currency actionAction_Admin_Settings::defaultAction() 169

Default actionAction_Admin_Settings::captchaSetting() 169Action_Admin_Settings::defaultLanguage() 170Action_Admin_Settings::editLanguage() 170

Function to updating the languageAction_Admin_Settings::googleAnalytics() 170

function to setup google analytics idAction_Admin_Settings::feedbackSetting() 170Action_Admin_Settings::bannerSettings() 169

Banner actionAction_Admin_Settings::auctionRelisting() 169

action function for max auction relistingAction_Admin_PayMethod::edit() 167Action_Admin_PayMethod::delete() 167Action_Admin_PayMethod::verifyOptionalParams() 167

Function to verify optional parametersAction_Admin_Settings 168

Action for Admin backend Settings pagesAction_Admin_Settings::addThisSetting() 168Action_Admin_Settings::addLanguage() 168

Function to add new languageAction_Admin_Settings::homeRefresh() 170Action_Admin_Settings::imageGallerySetting() 171Action_Admin_Settings::verifyLanguageParams() 173

Function to verify

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 522: Manual

Action_Admin_Settings::verifyBannerSettings() 173function to verify

Action_Admin_Settings::timezone() 172action to setup a default timezone

Action_Admin_Settings::verifyMetaTags() 173function to verify meta

Action_Admin_Store 174Store

Action_Admin_Store::doActivate() 174Action_Admin_Store::defaultAction() 174Action_Admin_Settings::sslSetting() 172Action_Admin_Settings::siteDesign() 172Action_Admin_Settings::languages() 171

Language settingsAction_Admin_Settings::itemsListing() 171Action_Admin_Settings::maxImageUploadSize() 171

maxImageUploadSizeAction_Admin_Settings::metaTags() 171

function to update metatagsAction_Admin_Settings::signupConfirmation() 172

action for user Signup ConfirmationAction_Admin_Settings::paypalSettings() 172

Paypal settings actionAction_Admin_Currency 151

Action for Admin backend Currency pagesAction_Admin_Country::edit() 151Action_Offer 109

Action OfferAction_Message::view() 108

viewAction_Message::submit() 108Action_Offer::add() 109

addAction_Offer::calculateFees() 110

calculate feesAction_Offer::defaultAction() 110

Default actionAction_Offer::copyAuction() 110

function to copy auction as a new draft auctionAction_Message::markAll() 108Action_Message::mark() 108Action_Message 106

Action MessageAction_Invoicepay::paypalReturn() 106

After user return from paypal after paying for InvoiceAction_Invoicepay::paypalPay() 106

Left for future usageAction_Message::compose() 106

addAction_Message::defaultAction() 107

Default actionAction_Message::deleteAll() 107

deleteAll

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 523: Manual

Action_Message::delete() 107delete

Action_Offer::delete() 110delete

Action_Offer::details() 111details

Action_PaypalDirectPay::paypalCancel() 114User is sent to this url if he cancels payment of direct fee for Offer

Action_PaypalDirectPay::defaultAction() 114Action_PaypalDirectPay 113

Action for Payments other then Invoice for direct payment of offer paypalReturn,paypalNotify,paypalCancel is used for rest of payments Paypap*Other is used

Action_PaypalDirectPay::paypalCancelOther() 114paypal return url for other actions

Action_PaypalDirectPay::paypalNotify() 114function for receiving notification for direct payment of Offer

Action_PaypalDirectPay::paypalPay() 115Action_PaypalDirectPay::paypalNotifyOther() 114

function for receiving notification for all other types of paymentAction_Offer::wanted() 113

wantedAction_Offer::qa() 113

action for processing offer question and answersAction_Offer::edit() 111

edit detailsAction_Offer::draftOffers() 111

draftOffers action, this action is used when PayMethod is set to Direct,Action_Offer::fees() 112

offer feesAction_Offer::isLoggedUserASeller() 112Action_Offer::publishOffer() 112Action_Offer::processOfferForm() 112

saves all data from the offerForm, and save it as draftAction_Invoicepay::paypalNotify() 105

Notification url for receiving notification from paypal regarding status of payment.Action_Invoicepay::paypalCancel() 105

User cancel payment of invoiceAction_Admin_BidPack::initialBids() 99Action_Admin_BidPack::edit() 99Action_Admin_BidPack::delete() 99Action_Admin_StoreSize 99

Action StoreSizeAction_Admin_StoreSize::changeStatus() 100

toggle store size statusAction_Admin_StoreSize::doEdit() 100

edit existing store sizeAction_Admin_StoreSize::defaultAction() 100Action_Admin_BidPack::defaultAction() 98Action_Admin_BidPack::deactivate() 98Action_Admin::defaultAction() 97

Default actionAction_Admin 97

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 524: Manual

Action AdminAction_Admin::verifyLoggedAdmin() 97Action_Admin_BidPack 98

Action BidPackAction_Admin_BidPack::add() 98Action_Admin_BidPack::activate() 98Action_Admin_StoreSize::processStoreSizeForm() 100Action_Admin_StoreSize::verifyOptionalParameters() 101Action_Fee::defaultAction() 104Action_Fee 104

Action for displaying a fee summaryAction_CustomPage::initThematic() 103Action_Index 104

Action for homepageAction_Index::defaultAction() 104

Default actionAction_Invoicepay::defaultAction() 105Action_Invoicepay 105

Action for InvoicepaymentAction_CustomPage::initPage() 103Action_CustomPage::defaultAction() 103

Default actionAction_BidPack::buy() 101

buy a bid pack: show the price to confirmAction_BidPack 101

Action BidPackAction_BidPack::defaultAction() 101

Default actionAction_Category 102

Action CategoryAction_CustomPage 102

Action for CustomPageAction_Category::defaultAction() 102

Default actionAction_PaypalDirectPay::paypalReturn() 115

user return to this URL after paying direct fee for creating offerAction_PaypalDirectPay::paypalReturnOther() 115

paypal return url for other actionsAction_UserPayMethod::defaultAction() 128Action_UserPayMethod 128

Action UserPayMethodAction_User::wonAuctions() 128

wonAuctionsAction_Admin_Banner 146

Action for Admin backend Banner pagesAction_Admin_Banner::activation() 146Action_Admin_Banner::changeStatus() 146

function to toggle status of bannerAction_Admin_Banner::add() 146Action_User::welcome() 127

welcomeAction_User::verifyUserParameters() 127

test each parameter for correct input

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 525: Manual

Action_User::receivedFeedback() 126received feedback

Action_User::profile() 126profile

Action_User::logout() 125logout

Action_User::recoverPassword() 126recoverPassword

Action_User::register() 126register

Action_User::userFees() 127user fees

Action_User::soldItems() 127usersold items action

Action_Admin_Banner::defaultAction() 147Default action

Action_Admin_Banner::deleteBanner() 147function to delete banner

Action_Admin_Category::verifyParameters() 150function to verify

Action_Admin_Category::verifyOptionalParams() 149Function to verify optional parameters

Action_Admin_Category::special() 149special action

Action_Admin_Country 150Action for Admin backend Country pages

Action_Admin_Country::activate() 150Action_Admin_Country::defaultAction() 151Action_Admin_Country::deactivate() 150Action_Admin_Category::order() 149

order actionAction_Admin_Category::edit() 149

Edit category ActionAction_Admin_Banner::processBannerForm() 147Action_Admin_Banner::editBanner() 147Action_Admin_Category 148

Action for Admin Category managementAction_Admin_Category::add() 148

Add category actionAction_Admin_Category::delete() 148

Delete category actionAction_Admin_Category::defaultAction() 148

Default actionAction_User::login() 125

loginAction_User::leftFeedback() 125

left feedbackAction_Store::defaultAction() 119Action_Store::create() 118

store add ActionAction_Store::category() 118

store category actionAction_Store::delete() 119

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 526: Manual

webstore delete actionAction_Store::details() 119Action_Store::fees() 120

store fees actionAction_Store::edit() 119

edit Store detailsAction_Store::calculateFees() 118

calculate feesAction_Store 117

Action StoreAction_ResponseHandler::defaultAction() 116

Action to handle GoogleCheckout notifications, GoogleCheckout sends all payment statusrelated notifications to this url

Action_ResponseHandler 116Action for Google Checkout Response Handler Processing of Invoices and for fees of other types of payments in done in ResponseHandlerclass other payments are processes in this Action

Action_ResponseHandler::googleCheckoutReturn() 116forwards user to respective page when user returns back from google checkout aftercompleting any transaction

Action_ResponseHandler::offerDetails() 116offerDetails action

Action_Search::defaultAction() 117Action_Search 117

Action for searchAction_Store::isLoggedUserASeller() 120Action_Store::processStoreForm() 120Action_User::draftOffers() 124

show list of draft offersAction_User::defaultAction() 123

Default actionAction_User::confirm() 123

confirmAction_User::edit() 124

edit profileAction_User::favourites() 124

user favourite actionAction_User::invoiceDetails() 125

invoice details actionAction_User::invoice() 124

user invoice actionAction_User::configureSellerPaypalOptions() 123

configuring pay pal for sells between usersAction_User::configureSellerGoogleCheckoutOptions() 122

configuring Google checkout buttonAction_User 121

Action UserAction_Store::testStore() 120

testStore action, this action is used when PayMethod is set to Direct,Action_User::activeOffers() 121

force to close an active offerAction_User::bids() 121

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 527: Manual

bidsAction_User::closedOffers() 122

show closed offers and process action for relist an offerAction_User::bulkUpload() 122

Function for creating Draft Auction by bulk uploading themAdmin.php 80

BBidIncrement::$_bottom 255BidIncrement::DB_TABLE 255

DB TablesBidIncrement 254

BidIncrementBidIncrement::$_id 255BidIncrement::$_increment 255BidIncrement::addIncrementRange() 256

Function to add new increment rangeBidIncrement::$_top 256BidIncrement::$_ranges 255Bid::__set() 254Bid::__get() 254Bid::$user 252Bid::$offer 252Bid::$id 251Bid::$value 252Bid::deleteFromDB() 252

remove bid from DBBid::saveToDB() 253Bid::getListFromDB() 253Bid::getInstanceFromDB() 253BidIncrement::getBidIncrement() 256

function to retrieve percent chargeBidIncrement::getInstanceFromDB() 256BidPack::deleteFromDB() 260

Remove record from databaseBidPack::$_price 259BidPack::$_number 259BidPack::getInstanceFromDB() 260BidPack::getListFromDB() 260BidPack::__set() 261BidPack::__get() 261BidPack::saveToDB() 261BidPack::$_id 259BidPack::$_active 259BidIncrement::saveToDB() 257BidIncrement::rangeValueExists() 257

function to check overlapping increment rangesBidIncrement::getListFromDB() 257BidIncrement::__get() 258BidIncrement::__set() 258BidPack::DB_TABLE 259

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 528: Manual

Database tableBidPack 258

BidPack classBid::$date 251Bid::$comment 251BannedEmail::getInstanceFromDB() 245BannedEmail::deleteFromDB() 244BannedEmail::$_email 244BannedEmail::getListFromDB() 245BannedEmail::saveToDB() 245Banner 246

Banner classBannedEmail::__set() 246BannedEmail::__get() 246BannedEmail::DB_TABLE 244

DB TablesBannedEmail 244

BannedEmailBannedEmail.php 202Banner.php 130BidPack.php 83Banner.php 203Bid.php 204BidPack.php 206BidIncrement.php 205Banner::BANNER_HTML 247Banner::BANNER_IMAGE 247Banner::saveToDB() 249Banner::getListFromDB() 249Banner::getInstanceFromDB() 249Banner::validURL() 250Banner::__get() 250Bid::DB_TABLE 251Bid 251

Bid classBanner::__set() 250Banner::getBanner() 248Banner::deleteFromDB() 248Banner::$_bannerHTML 247Banner::$_active 247Banner::DB_TABLE 247

database tableBanner::$_id 247Banner::$_image 247Banner::$_url 248Banner::$_type 248BidPack.php 81

CCustomField::$_type 283CustomField::$_showInProfile 283

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 529: Manual

constructor CustomField::__construct() 283CustomField::addName() 283

Function to add custom field name to name arrayCustomField::deleteFromDB() 284CustomField::$_name 283CustomField::$_mandatory 282CustomField::TYPE_INPUT 282

custom field type inputCustomField::DB_TABLE 281

db tablesCustomField::TYPE_TEXTAREA 282

custom field type textareaCustomField::$_active 282CustomField::$_id 282

member variablesCustomField::fieldExists() 284

Function to check if specified custom user field already existCustomField::getInstanceFromDB() 284CustomOfferField::DB_TABLE 287

db tablesCustomOfferField::DB_LANGUAGE_TABLE 287CustomOfferField::$_active 287CustomOfferField::$_id 287

member variablesCustomOfferField::$_mandatory 288CustomOfferField 287

CustomOfferFieldCustomField::__set() 286CustomField::getName() 285

Function to retrieve custom field name for the languageCustomField::getListFromDB() 285CustomField::isActive() 285

Function to check if specified field is activeCustomField::saveToDB() 286

Saving the records to databaseCustomField::__get() 286

interceptorsCustomField::DB_LANGUAGE_TABLE 281CustomField 281

CustomFieldCountry::saveToDB() 276Country::getListOfCountriesWithUsers() 275Country::__get() 276Country::__set() 276Cron 277

Cron closes open auctions.Country::getListFromDB() 275Country::getInstanceFromDB() 275Country::DB_TABLE 274Country 274

CountryCountry::$_active 274Country::$_id 274

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 530: Manual

Country::$_name 275Cron::closeExpiredOffers() 277Cron::openDatePendingOffers() 277Currency::getListFromDB() 280Currency::getInstanceFromDB() 280Currency::saveToDB() 280Currency::__get() 280Currency::__set() 281Currency::getConverterURL() 279

Returns an URL where you get displayed a currency converterCurrency::$_name 279Cron::run() 278Cron::relistOffers() 278Currency 278

Currency classCurrency::DB_TABLE 279

Database tableCurrency::$_id 279CustomOfferField::$_name 288CustomOfferField::$_showInAuctionDetails 288constructor Invoice::__construct() 339constructor Image::__construct() 328constructor Item::__construct() 347constructor Language::__construct() 352constructor LotAuction::__construct() 356constructor FixedAuction::__construct() 323CustomPage::__set() 298CustomPage::getTitle() 296

function to retrieveCustomPage::getText() 296CustomPage::pageExists() 297

Function to check if a page already existsCustomPage::saveToDB() 297

Saving changes to databaseCustomPage::__get() 297

Interceptorsconstructor Message::__construct() 363constructor Offer::__construct() 377constructor StoreSize::__construct() 425constructor Store::__construct() 420constructor Thematic::__construct() 430constructor User::__construct() 442

Constructor of the User class is private to allow future child useconstructor UserPayMethod::__construct() 459constructor StandardAuction::__construct() 413constructor SiteOptions::__construct() 409constructor PayMethod::__construct() 392constructor OffersQuestion::__construct() 389constructor Paypal::__construct() 399constructor PennyAuction::__construct() 401constructor ReverseAuction::__construct() 405CustomPage::getListFromDB() 296CustomPage::getInstanceFromDB() 295

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 531: Manual

CustomOfferField::isActive() 291Function to check if specified custom auction field is active

CustomOfferField::getName() 290Function to retrieve custom auction field name for the language

CustomOfferField::saveToDB() 291Saving the records to database

CustomOfferField::__get() 291interceptors

CustomOfferField::__set() 292CustomOfferField::getListFromDB() 290CustomOfferField::getInstanceFromDB() 290constructor CustomOfferField::__construct() 289CustomOfferField::$_type 288CustomOfferField::addName() 289

Function to add custom auction field name to name arrayCustomOfferField::deleteFromDB() 289CustomOfferField::fieldExists() 289

Function to check if specified custom user field already existCustomPage 292

CustomPageCustomPage::CUSTOM_PAGE_LANGUAGE_TABLE 292CustomPage::addText() 294

Functions to add new page dataconstructor CustomPage::__construct() 294CustomPage::addTitle() 294CustomPage::deleteFromDB() 295

deleting the page from databaseCustomPage::discoverId() 295CustomPage::$_title 294CustomPage::$_thematicId 294CustomPage::$_active 293CustomPage::DB_TABLE 293

Database tablesCustomPage::$_date 293CustomPage::$_id 293

member variablesCustomPage::$_text 293Core_PresentationData::getStatistics() 273

get message statisticsCore_PresentationData::getMetaInfo() 273

Function to retrieve metaCore_Context::$_relativePath 194

Path of the web within the server.Core_Context::$_parameters 194

Array for the user request parametersCore_Context::$_siteOptions 194

Array with general options for the site, loaded from DBCore_Context::$_status 194

Flag to show if request was processed without errorsconstructor Core_Context::__construct() 195

Public constructorCore_Context::$_message 193

Feedback message, to show to the user in case of success

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 532: Manual

Core_Context::$_loggedUser 193Object User with data for logged user

Core_Context::$_data 192Array containing the data after the execution of the model

Core_Context 191Core_Context

Core_Context::$_errorMessage 192Error message, to show to the user

Core_Context::$_HTTPHost 192Server domain.

Core_Context::$_language 193Language selected by user

Core_Context::addData() 195merge new data with existing data

Core_Context::toArray() 195Creates an array for the View with the needed data.

Core_Controller::processParameters() 198Get the URL called and the REQUEST parameters, to resolve $_actionToCall and parameters in the Context object.

Core_Controller::getParameters() 198Return the properties $_actionToCall and $_parameters.

Core_Controller::run() 198Call the chosen Action, get the data returned and call the chosen View

Core_Controller::verifyInputAgainstHacks() 199Check the request input against a list of filters, for trying to detect HACK attacks

Core_View 199Core_View

constructor Core_Controller::__construct() 197Public constructor.

Core_Controller::$_viewToCall 197Name of the View defined in the URL request by the parameter "v".

Core_Context::__set() 196Core_Context::__get() 195Core_Controller 196

Core_Controller manage user request thru concrete Action and View.Core_Controller::$_actionToCall 197

Variable to store the name of the Action defined in the URL request.Core_Controller::$_context 197

Storage of all needed data for the Action and the View.Core_Action::__destruct() 191

Public destructorCore_Action::verifyLoggedUser() 191

Checks if there is a currently logged in userCountry.php 132Category.php 131Currency.php 133CustomAuctionFields.php 134CustomFields.php 135CustomPage.php 85Category.php 84constructor SystemInstaller::__construct() 47

SystemInstaller constructorconstructor GoogleCheckout::__construct() 31

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 533: Manual

CSV.php 53config.php 66

DB access config fileconstructor ResponseHandler::__construct() 74CustomPages.php 136Context.php 185Core_Action::getContext() 190

Returns object contextCore_Action::filterInputStrings() 189

Removes slashes from input strings,Core_Action::preprocessContext() 190

Preprocess user parameters.Core_Action::run() 190

Executes method defined if it exists, otherwise defaultAction is called.

Core_Action::setContext() 191Core_Action::defaultAction() 189

Default action to call if no user parameters received.constructor Core_Action::__construct() 189

Public constructorCore_Action 188

Core_ActionController.php 186Core_Action::$context 188

Object Core_Context with all dataCore_Action::$db 188

Reference to DB conectionCore_Action::$requestedMethod 189

Method to callCore_View::$context 199

Data to showCore_View::display() 200

Executes View.Category::getInstanceFromDB() 267Category::getCachedCategoriesLang() 266

Get the cached categories table, and populate it if it's the first time it's calledCategory::getListFromDB() 267Category::getName() 267

Function to retrieve name for a particular languageCategory::getOrderedListFromDB() 268

function to return sorted list of categories depending upon sorting typeCategory::getCachedCategories() 266

Get the cached categories table, and populate it if it's the first time it's calledCategory::discoverId() 266

Given a string, verify if it's category id or category name or nothing.

constructor Category::__construct() 264constructor

Category::$_special 264Category::addName() 265

Function to add name for a particular languageCategory::deleteFromDB() 265

Function to delete categories

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 534: Manual

Category::discoverCatId() 265Discover id function to seach category id

Category::getParentAndChildID() 268function to return parent and all childs of a given category

Category::getSortedListFromDB() 268Core_PresentationData::getData() 272Core_PresentationData::getCustomPagesData() 271Core_PresentationData::getGoogleAnalyticsCode() 272

Function to return Google Analytics codeCore_PresentationData::getLanguageDirection() 272

Function to retrieve language orientationCore_PresentationData::getLanguages() 273Core_PresentationData 271

Core_PresentationDataCategory::__set() 271Category::hasSubcats() 269

Check if it is a category with sub catsCategory::getSubcatsFromDB() 269Category::makeCatBreadCrumb() 270

function to construct breadcrumb for CategoriesCategory::saveToDB() 270Category::__get() 270

interceptorsCategory::$_parent 264Category::$_order 264constructor Banner::__construct() 248CustomPage.php 214constructor Bid::__construct() 252Category 262

Categories of itemsCategory::CAT_LANG_TABLE 262CustomOfferField.php 213CustomField.php 212Category.php 207Core_View::setContext() 200

Receives data to paintCountry.php 209Cron.php 210Currency.php 211Category::DB_TABLE 262Category::ORDER_ALPHABETICALLY 262

category order constantsCategory::$cachedCategoriesLang 263Category::$cachedCategories 263

cached tableCategory::$_active 263Category::$_id 263

class propertiesCategory::$_name 264Category::ORDER_SPECIAL_MANUALLY 262Category::ORDER_SPECIAL_ALPHA 262Category::ORDER_MANUALLY 262Category::ORDER_MAX_OFFERS 262

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 535: Manual

Category::ORDER_MAX_SPECIAL 262Category::ORDER_SPECIAL 262constructor Upgrader::__construct() 11

DDBWritable.php 217DBReadable 298

Interface for reading data from DBDBSearchable.php 216DBReadable.php 215DB::getInstance() 27

Action to get the DB objectDBReadable::getInstanceFromDB() 298

Get one instance, based on idDBReadable::getListFromDB() 299

Get a list, based on restrictionsDBWritable::saveToDB() 300

Save current object to DB and return object's id or false.DBWritable 300

Interface for writing data to DBDBSearchable::discoverId() 300

Get the id of the register with name=$sDBSearchable 299

Interface for searching register ID from DB starting with a name.DB::createArrayFromDBResult() 27

Creates an array taking the keys and values from defined parameters.DB::$db 26

Contains DB resourceDate::invertDate() 23

Changes dd/mm/yyyy for yyyy/mm/dd, and oppositeDate::javascriptFormated() 24

Creates a string for javascript Date object initiation.Date::check() 23

Verifies a date in the format yyyy/mm/ddDate 23

Date utilities.DB.php 16

Database classes file.Date::secondsDifference() 24

returns the number of seconds from now to $dateDate::showTimeDifference() 25

returns a string with the days, hours, etc that there are from now to $dateDB 26

Creates a DB object instance, acording config.php file parameters.Date::yearDifference() 26

returns year difference between two datesDate::toLocaleShortString() 25

Shows data in format regarding locale.Date::toLocaleLongString() 25Date.php 15

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 536: Manual

EError::BY_USER 28Echo.php 54Error::BY_UNKNOWN 28Error::BY_CODE 28Error 28

Error utilities.Error.php 17

FFee::updateUserFeeStatus() 316

function to update user fee statusFee::__get() 317

Interceptor : the getterFee::updateStoreFeeStatus() 316Fee::updateFeeStatus() 316Fee::updateBidPackFeeStatus() 315

Update status of a bid pack fee in users_fees tableFee::__set() 317

Interceptor : the setterFeeRangeContainer 318

FeeRangeContainer class,FeeRangeContainer::$_feeRange 319FeeRangeContainer::$_startRange 319FeeRangeContainer::$_endRange 318FeeRangeContainer::$_action 318

FeeRange propertiesFeeRangeContainer::DB_TABLE 318Fee::simulateFee() 315

function to simulate a fee charged over a user, without saving it on DB.Fee::setTitle() 315Fee::getTitle() 312

function to retrieve title of feeFee::getUserFee() 312

function to retrieve list of user fee from Fee::FEES_USERS_TABLE with a particular statusFee::getListFromDB() 311

DBReadable getListFromDB implementationFee::getListForStore() 311Fee::getListForOffer() 311Fee::listFrozenFromDB() 312

retrieves an array with data from frozen feesFee::removeBidPackFee() 313

function to remove bidpack fee amount from self::FEES_USERS_TABLE with particular statusFee::setDescription() 314Fee::saveToDB() 314

saveToDB function from DBWritable interfaceFee::removeUserFee() 314

function to remove fee amount from self::FEES_USERS_TABLE with particular statusFee::removeStoreFee() 313

function to remove store fee amount from self::FEES_USERS_TABLE with particular status

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 537: Manual

FeeRangeContainer::addRange() 319function to add new range for this fee

FeeRangeContainer::getAllCharges() 319function to retrieve percent charge

FixedAuction::getWinners() 325FixedAuction::makeBid() 325FixedAuction::getListOnOneCategory() 325FixedAuction::getListFromDB() 324FixedAuction::getInstanceFromDB() 324FixedAuction::removeUserBids() 325FixedAuction::saveToDB() 326FixedAuction::__set() 327FixedAuction::__get() 326FixedAuction::typeName() 326FixedAuction::type() 326FixedAuction::getExtendedDataFromDB() 324

retrieves data needed for concrete childFixedAuction::getBidButtonText() 323FeeRangeContainer::getPercentCharge() 321

function to retrieve percent chargeFeeRangeContainer::saveToDB() 321

saveToDB function from DBWritable interfaceFeeRangeContainer::getListFromDB() 321FeeRangeContainer::getInstanceFromDB() 320

creating instance from values in the databaseFeeRangeContainer::getFixedCharge() 320

function to retrieve percent chargeFeeRangeContainer::valueExistsInRange() 322

function to check if a value can be added in the rangeFeeRangeContainer::__get() 322

Interceptor : the getterFixedAuction::finishOffer() 323FixedAuction::calculateNextBid() 323FixedAuction 323

FixedAuctionFeeRangeContainer::__set() 322

Interceptor : the setterFee::getInstanceFromDB() 310

Methods from DBReadable and DBWritableFee::getFeeList() 310

Retrieve list of fee, unlike self::getListFromDB, which does not include a fee if it does not havea corresponding row in self::FEES_LANG_TABLE

Favourite::getFavouriteOffers() 303function to return list of favorite offers

Favourite::getInstanceFromDB() 303Favourite::deleteFromDB() 303

remove record from databaseFavourite::$_user 302Favourite::$_type 302Favourite::getListFromDB() 304Favourite::saveToDB() 304Fee::BIDPACKFEE 305Fee::DB_TABLE 305

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 538: Manual

TableFee 305

Fee class,Favourite::__set() 304Favourite::__get() 304Favourite::$_offers 302Favourite::$_id 302FeeRangeContainer.php 220FixedAuction.php 221Fee.php 219Favourite.php 218Fee.php 137Favourite 301

FavouriteFavourite::DB_TABLE 301

database tableFavourite::$_focusId 301Favourite::TYPE_USER 301

Favourite type constants, Favourite UserFavourite::TYPE_STORE 301

Favourite type constants, Favourite StoreFavourite::TYPE_OFFER 301

Favourite type constants, Favourite OfferFee::DIRECT_FEE 305Fee::FEES_LANG_TABLE 305Fee::$_description 307Fee::$_feeRangeContainer 307

local FeeRange ObjectFee::$_chargeAtCreation 307Fee::$_baseField 307Fee::$_active 307Fee::$_fixed 308Fee::$_title 308Fee::getDescription() 309

function to retrieve description of feeFee::getBidPackFeeData() 309

Return bid pack fee dataFee::freeze() 309

Method to save some fees that are not charged now, but when an action takes place.Fee::chargeFee() 308

method to store the amount charged in the V5_fees_users tableFee::$_action 306Fee::STOREFEE 306Fee::FEE_PAID 306Fee::FEE_PAYMENT_IN_PROCESS 306Fee::FEE_NOTPAID 306

User Fee status constantsFee::FEES_USERS_TABLE 306Fee::FEES_RANGE_TABLE 306Fee::FINALFEE 306Fee::FROZEN_TABLE 306Fee::SIGNUP_FEE 306Fee::RELISTING_FEE 306

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 539: Manual

Fee::OTEHR_FEE 306Fee::INVOICE_FEE 306

Fees constantsFee.php 86

GGoogleCheckout::$_merchantId 30

class variablesGoogleCheckout::$_lang 30GoogleCheckout::$_currency 30GoogleCheckout::$_country 29GoogleCheckout::$_merchantKey 30GoogleCheckout::$_serverType 30GoogleCheckout::__set() 32GoogleCheckout::__get() 32GoogleCheckout::getOrderDataFromDB() 32

function to retrieve item name from databaseGoogleCheckout::configureOptions() 31

function to configure Google check out buttonGoogleCheckout::$_cart 29GoogleCheckout::STOREFEE 29GoogleCheckout::DIRECTPAY 29GoogleCheckout::DB_TABLE 28

DB TableGoogleCheckout::BIDPACKFEE 28GoogleCheckout 28

Google Checkout classGoogleCheckout::FINALFEE 29GoogleCheckout::INVOICE 29

Payment identifier constantsGoogleCheckout::SIGNUPFEE 29GoogleCheckout::RELISTINGFEE 29GoogleCheckout::OTHERFEE 29GoogleCheckout.php 18

HhandleException() 67

Handles a root fatal exception, displaying a general error pageHTML.php 55

IInvoice::getInstanceFromDB() 341Invoice::getInvoiceLinesFromDB() 341

Function to retrieve all the rows included in a invoiceInvoice::generateInvoice() 340

Function to generate invoice.Invoice::deleteFromDB() 340

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 540: Manual

Invoice::createMail() 340Function to create the invoice mail

Invoice::getListFromDB() 342Invoice::getStatsFromDB() 342

get some statistics for back-end home pageInvoice::sendOneInvoice() 343

Function to send one invoiceInvoice::sendMail() 343

Function to send invoice mailInvoice::sendInvoices() 343

Function to mass send invoices,Invoice::saveToDB() 342Invoice::calculateTotal() 340

method to calculate total (here total is sum + taxInvoice::$_userId 339Invoice::$_invoiceTaxName 338Invoice::$_invoiceTaxPercent 338Invoice::$_invoiceLines 337Invoice::$_invoiceLimit 337Invoice::$_invoiceHeader 337Invoice::$_siteName 338Invoice::$_status 338Invoice::$_userEmail 339Invoice::$_user 339Invoice::$_total 339Invoice::$_tax 338Invoice::updateInvoiceStatus() 344

function to update invoice statusInvoice::__get() 344

interceptorsItem::getInstanceFromDB() 348Item::getItemImages() 349

method to retrieve list of images for particular itemItem::emptyImages() 348Item::deleteImage() 348

function to delete particular imageItem::deleteFromDB() 348

function to delete the current record from databaseItem::getListFromDB() 349Item::imageExist() 349

Function to check it the specified image already exist in this itemItem::__set() 351Item::__get() 350Item::verifyYoutubeVideo() 350

function to verify youtube video linkItem::saveToDB() 350Item::copyItem() 347

function to copy Item as a new itemItem::addImage() 347Item::ITEM_IMAGES_TABLE 345Item::$description 345Item::DB_TABLE 345

DB Tables

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 541: Manual

Item 345Item

Invoice::__set() 344Item::$id 346Item::$image 346Item::$youtubeVideo 347Item::$user 346Item::$name 346Item::$images 346

hold multiple images for itemInvoice::$_invoiceFooter 337Invoice::$_invoiceCopyToAdmin 337Image::copyAsNewImage() 328

function to copy image as new imageImage::createImage() 329

Function to create imageImage::$url 328Image::$size 328Image::$references 328Image::createNewName() 329

Function to create new file name for suffixing some random characters at the end of file nameImage::deletefromDB() 329

Function to remove image for V5 (db and disk)Image::getListFromDB() 331Image::getInstanceFromDB() 330Image::doUpload() 330

Function to do the upload by moving the file to upload/img/ directoryImage::deleteFromDBOnly() 330Image::$id 327Image::UPLOAD_PATH 327Index.php 138Invoices.php 139Invoicepay.php 88Index.php 87install.php 69

enuuk Instalation script.Image.php 222Invoice.php 223Image::DEFAULT_IMAGE_ID 327Image::DB_TABLE 327Image 327

ImageItem.php 224Image::isRemoteFile() 331

function to check if the file is a remote fileImage::removeFile() 331Invoice::PENDING 335

Invoice status constantsInvoice::SENT 335Invoice::PAYMENT_VERIFIED 335Invoice::PAYMENT_PENDING 335Invoice::PAID 335Invoice::$_adminMail 335

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 542: Manual

Invoice::$_date 336Invoice::$_id 336

invoice variablesInvoice::$_fromMail 336Invoice::$_defaultLanguage 336Invoice::$_defaultCurrency 336Invoice::NOT_PAID 335Invoice::INVOICE_LINES_TABLE 335Image::uploadRemoteFile() 333Image::validFile() 333

function to check if this file is a valid fileImage::uploadFile() 332

function to upload imagesImage::saveToDB() 332Image::renameFile() 332Image::__get() 333Image::__set() 334Invoice::INVOICE 335

pay methodInvoice::DIRECTPAY 335Invoice::DB_TABLE 334

DB TablesInvoice 334

Invoiceindex.php 67

enuuk Auction index

JJSON.php 56

LLotAuction::getInstanceFromDB() 357LotAuction::getListFromDB() 358LotAuction::getOffersWon() 358

Return list of LotAuction won by any userLotAuction::getExtendedDataFromDB() 357LotAuction::getBidButtonText() 357LotAuction::$quantity 356LotAuction::calculateNextBid() 356LotAuction::finishOffer() 357LotAuction::getQuantity() 358LotAuction::getWinners() 359

this function returns a list of winner for the auction, in LotAuction it return list of user who bidfor the auction

LotAuction::typeName() 360LotAuction::__get() 360LotAuction::__set() 360LotAuction::type() 360LotAuction::saveToDB() 359

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 543: Manual

LotAuction::makeBid() 359LotAuction::removeUserBids() 359LotAuction::DB_TABLE 356

database tableLotAuction 356

LotAuctionLanguage::$_id 352

member variablesLanguage::$_name 352Language::$_orientation 352Language::$_active 351Language::DB_TABLE 351

database constantsLotAuction.php 226Language 351

LanguageLanguage::changeLanguage() 352

Function to change the system languageLanguage::deteleFromDB() 353Language::saveToDB() 355

SavingLanguage::__get() 355

interceptorsLanguage::__set() 355Language::localeInit() 354

Prepares enviroment for gettext traduction.Language::languageAvailable() 354

Function to check if a language is installed on the serverLanguage::getInstanceFromDB() 353Language::getListFromDB() 353Language.php 225

MMessage::VISIBLE_RECEIVER 361Message::VISIBLE_SENDER 362Message::VISIBLE_BOTH 361

Message visibility constantsMessage::UNREAD_MESSAGES 361Message::SENT_MESSAGES 361Message::$_fromUser 362Message::$_id 362

Message class variablesMessage::$_subject 363Message::$_status 362Message::$_messageTime 362Message::$_message 362Message::READ_MESSAGES 361Message::DB_TABLE 361

DB Tables for the classMyPDO::prepare() 40MyPDO::query() 40

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 544: Manual

MyPDO::exec() 39MyPDO::$count 39MyPDO 39

Class extended from PDO.migration.php 70Message.php 89Message::ALL_MESSAGES 361

message type constantsMessage 361

Message classMetaTag.php 228Message.php 227Message::$_toUser 363Message::$_visibility 363MetaTag::$_languageId 368MetaTag::$_metaDescription 369MetaTag::$_id 368MetaTag::DB_TABLE 368

Database tableMetaTag 368

MetaTagMetaTag::$_metaKeywords 369MetaTag::getInstanceFromDB() 369MetaTag::__set() 370MetaTag::__get() 370MetaTag::saveToDB() 370MetaTag::getListFromDB() 369Message::__set() 367

Interceptor : the setterMessage::__get() 367

Interceptor : the getterMessage::getListFromDB() 364Message::getInstanceFromDB() 364Message::deleteMessage() 364

function to delete particular messageMessage::deleteFromDB() 363Message::listInboxMessages() 365

Function to return messages in the inbox (the messages user has recieved) of the userMessage::listMessages() 365

function to list messages of a particular userMessage::updateStatus() 367

function to change status of a messageMessage::saveToDB() 366Message::readMessage() 366

function to read content of a particular messageMessage::listSentMessages() 366

Function to return messages in the outbox[sent] (the messages user has sent) of the userMailNotificator::__get() 39

Getter MethodMailNotificator::sendOneMail() 38

Function to send one mailMigrator::migrateUsers() 7

get old user data and populate new DB tables

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 545: Manual

MailNotificator.php 19Mail Notificator.

Migrator::migrateCategories() 7get old categories and populate new DB tables

Migrator::migrateAuctions() 7get old user data and populate new DB tables

Migrator::migrate() 6do all steps for migration

MailNotificator 33Mail Notificator.

MailNotificator::AUCTIONMAIL 33when A new auction has been created by user

MailNotificator::FILE_PATH 33mail content directory

MailNotificator::AUCTIONMAIL_REVERSE 33when A new REVERSE auction has been created by user

MailNotificator::AUCTIONMAIL_LOT 33when A new LOT auction has been created by user

MailNotificator::AUCTIONMAIL_FIXED 33when A new Fixed auction has been created by user

Migrator::getMessage() 6returns the message string

Migrator::createCountryMapper() 6Finds the country ISO ID based on the name, for each country in old DB

Migrator::$message 4Migrator::$idToNick 3

Maps the login name (old "nick") to old numeric id.Migrator::$countryMapper 3

Maps old countries to standard idsMigrator 3

Code to migrate some from old phpAuction productsMigrator::$newDB 4

PDO object for new DB connectionMigrator::$newPrefix 4

DB tables prefix (ie. "eA_")Migrator::convertToDate() 5

Converts strings in format "YYYYmmddHHiiss" to "YYYY/mm/ddHH:ii:ss",

Migrator::connectToDB() 5opens old DB and new DB

Migrator::$oldPrefix 5DB tables prefix (ie. "PHPAUCTIONXL_")

Migrator::$oldDB 4PDO object for old DB connection

MailNotificator::MAIL_BID 34when someone bids on a auction, inform the seller mail

MailNotificator::MAIL_BUY_FIXED_BUYER 34user have purchased the fixed price item

MailNotificator::$errorMessage 36MailNotificator::$hasError 36MailNotificator::USERMAIL_APPROVED 36

user registration is confirmedMailNotificator::REGISTRATION_MAIL 36

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 546: Manual

Registration mail constantMailNotificator::NEWPASSWD 35

New password mailMailNotificator::$language 36

default language is hard coded as fail safe measureMailNotificator::$_emailBody 36

variable to store email content: body and subjectMailNotificator::send() 38

Sends the notification mailMailNotificator::reFormatString() 37

Function to re-format the mail textMailNotificator::getData() 37

function to retrieve the text of a mailMailNotificator::$_emailSubject 37MailNotificator::MAIL_OFFER_QUESTION 35

a question has been askedMailNotificator::MAIL_OFFER_ANSWER 35

a question has been answeredMailNotificator::MAIL_DUE_FEE 34

user have some due fee to payMailNotificator::MAIL_BUY_LOT_SELLER 34

user have sold the fixed price itemMailNotificator::MAIL_BUY_LOT_BUYER 34

user have purchased an item from lotMailNotificator::MAIL_BUY_FIXED_SELLER 34

user have sold the fixed price itemMailNotificator::MAIL_ENDAUCTION_BIDDER 34

when an auction finish and there is a winner - mail for bidderMailNotificator::MAIL_ENDAUCTION_NOWINNER 34

when an auction finish but there is no winnerMailNotificator::MAIL_NO_LONGER_LEAD_BIDDER 35

when someone bids over a previous bidMailNotificator::MAIL_MESSAGE 35

someone sent a messageMailNotificator::MAIL_INVOICE 35

invoice mailMailNotificator::MAIL_ENDAUCTION_WINNER 35

when an auction finish and there is a winner - mail for ownerMigrator.php 2

Migrator class file.

OOffer::getStatsFromDB() 383

retrieves some useful statsOffer::getOfferCount() 382

function to retrieve number of offers availabe for each categoryOffer::getListOnOneCategory() 382Offer::getListFromDB() 382Offer::getTypesFromDB() 383

It stores in Offer::$types an array, with the types availableOffer::getUserBuyers() 383

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 547: Manual

Return list of users who won auction created by the UserOffer::makeBid() 384Offer::getWinners() 384

function to return the winner of the auctionOffer::getUserSells() 384

function to return user sold itemsOffer::getListForThisParentInStore() 381

function to retrieve the list of offers in web store for this parent and all itsOffer::getListForThisParent() 381

function to retrieve the list of offers for all childsOffer::getBidButtonText() 379

function to return text to be displayed on the Bid button in templatesOffer::finishOffer() 379Offer::discoverId() 378Offer::deleteFromDB() 378

remove auction and all related files (images, documents uploaded).Offer::getCustomOfferData() 379

function to retrieve offer custom dataOffer::getExtendedDataFromDB() 379

retrieves data needed for concrete childOffer::getInstanceFromDB() 380

creates an instance of the concrete child classOffer::getInstance() 380Offer::getFieldValue() 380

function to retrieve the value of a particular fieldOffer::relist() 385

Prepare the offer values for a relistOffer::removeUserBids() 385

function to adjust the bids for the offer in case any bid is being removedOffersQuestion::getInstanceFromDB() 389OffersQuestion::$_user 389OffersQuestion::$_question 389OffersQuestion::$_offerId 388OffersQuestion::getListFromDB() 389OffersQuestion::questionExists() 390

function to check if the specified question already exist for this offerOffersQuestion::__set() 391OffersQuestion::__get() 390OffersQuestion::saveToDB() 390OffersQuestion::$_id 388

member variablesOffersQuestion::$_date 388Offer::updateTypesToDB() 386

Updates DB with new details for each typeOffer::typeName() 386Offer::type() 386Offer::saveToDB() 385Offer::__get() 386Offer::__set() 387OffersQuestion::$_answer 388OffersQuestion::DB_TABLE 387

DB TableOffersQuestion 387

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 548: Manual

OffersQuestionsOffer::copyAsDraft() 378

Function to copy auction as a new draft auctionOffer::calculateNextBid() 377

Verify bid increments table to calculate next bid valueOffer::SHIP_CONDITIONS_SELLER 372Offer::SHIP_CONDITIONS_BUYER 372Offer::REVERSE 371Offer::PENNY 371Offer::STANDARD 372Offer::$active 372Offer::$currentPrice 372Offer::$categories 372Offer::$bids 372Offer::OFFERS_TYPES_TABLE 371Offer::OFFERS_PAYMETHODS_TABLE 371Offer 371

OfferOffersQuestion.php 230Offer.php 229Offers.php 140Offer::DB_TABLE 371Offer::FIXED_PRICE 371Offer::OFFERS_CUSTOM_FIELD_TABLE 371Offer::OFFERS_CATEGORIES_TABLE 371Offer::LOT 371Offer::$customFields 373Offer::$datePending 373Offer::$startDate 376Offer::$shipTerms 376Offer::$shipInternational 375Offer::$shipCosts 375Offer::$startPrice 376Offer::$types 376Offer::addFieldValue() 377

function to add custom field valueOffer::$winner 377Offer::$views 376Offer::$shipConditions 375Offer::$relisting 375Offer::$file 374Offer::$featured 373Offer::$endDate 373Offer::$draft 373Offer::$fileSize 374Offer::$id 374Offer::$payMethods 375Offer::$item 374Offer::$inWebstore 374Offer.php 90

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 549: Manual

PPaypal::configureOptions() 399

function to configure paypal options for different usesPaypal::addFields() 399Paypal::$_url 399

paypal urlPaypal::validateIPN() 400

method to validate transaction from paypalPaypal::__get() 400PennyAuction 401

PennyAuctionPaypal::__set() 400Paypal::$_returnURL 398

paypal return urlPaypal::$_notifyURL 398

notify urlPaypal::$_cancelURL 397

cancel urlPaypal::$_bussiness 397

reciever emailPaypal::$_errorMessage 397Paypal::$_fields 397

Data to be submited to paypalPaypal::$_ipnResponse 398

IPN responsePaypal::$_ipnData 398

post values for IPNPennyAuction::EXTENDED_DB_TABLE 401PennyAuction::$bidIncrementValue 401PennyAuction::saveToDB() 404PennyAuction::removeUserBids() 404PennyAuction::makeBid() 403PennyAuction::type() 404PennyAuction::typeName() 404PennyAuction::__set() 405PennyAuction::__get() 404PennyAuction::getWinners() 403PennyAuction::getListOnOneCategory() 403PennyAuction::finishOffer() 402PennyAuction::calculateNextBid() 401PennyAuction::getBidButtonText() 402PennyAuction::getExtendedDataFromDB() 402

retrieves data needed for concrete childPennyAuction::getListFromDB() 403PennyAuction::getInstanceFromDB() 402Paypal::IPN_VERIFIED 396

IPN ResponsePaypal::IPN_UNKNOWN 396PayMethod::$gatewayId 392PayMethod::$active 391PayMethod::LANG_TABLE 391PayMethod::$id 392

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 550: Manual

PayMethod::$isGateway 392PayMethod::addName() 393

Function to add custom auction field name to name arrayPayMethod::$name 392PayMethod::DB_TABLE 391PayMethod 391

PayMethodPayMethod.php 141PaypalDirectPay.php 91PresentationData.php 208PayMethod.php 231PennyAuction.php 233Paypal.php 232PayMethod::deleteFromDB() 393PayMethod::discoverId() 393Paypal::IPN_DENIED 396Paypal::IPN_COMPLETED 396Paypal::IPN_ACCEPTED 396Paypal::IPN_FAILED 396Paypal::IPN_INVALID 396Paypal::IPN_SUCCESS 396Paypal::IPN_PENDING 396Paypal::DB_TABLE 396Paypal 396

Paypal classPayMethod::getListFromDB() 394PayMethod::getInstanceFromDB() 394PayMethod::getName() 394

Function to retrieve custom auction field name for the languagePayMethod::saveToDB() 395PayMethod::__set() 395PayMethod::__get() 395PHP.php 57

RResponseHandler.php 92ReverseAuction.php 234ReverseAuction 405

ReverseAuctionReverseAuction::calculateNextBid() 406

Calculates next correct bid valueResponseHandler::__set() 78ResponseHandler::__get() 77ResponseHandler::getPaymentType() 76

function to retrieve type of payment for this item, item name for any item isPAYMENT_TYPE_CONSTANT#ID (invoice or offer)

ResponseHandler::newOrderNotification() 76ResponseHandler::processResponse() 77

Function to process Response receivedResponseHandler::updateInvoice() 77

retrieve invoice id from the description string passed to the function

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 551: Manual

ReverseAuction::finishOffer() 406ReverseAuction::getBidButtonText() 406ReverseAuction::makeBid() 407ReverseAuction::saveToDB() 408ReverseAuction::type() 408ReverseAuction::typeName() 408ReverseAuction::getWinners() 407ReverseAuction::getListOnOneCategory() 407ReverseAuction::getExtendedDataFromDB() 406ReverseAuction::getInstanceFromDB() 406ReverseAuction::getListFromDB() 407ResponseHandler::getItemName() 76

function to return item name (Googlecheckout item name)ResponseHandler::getInvoiceStatus() 76ResponseHandler::$_data 72ResponseHandler::$_gRequest 72ResponseHandler::$_gResponse 72ResponseHandler::$_itemName 72ResponseHandler::$_currency 71ResponseHandler::RESPONSE_HANDLER_LOG_FILE 71ResponseHandler.php 65ResponseHandler 71ResponseHandler::DB_TABLE 71

db tableResponseHandler::RESPONSE_HANDLER_ERROR_LOG_FILE 71

google response log filesResponseHandler::$_merchantId 72

class variablesResponseHandler::$_merchantKey 73ResponseHandler::getData() 74

retrieve Response dataResponseHandler::getDirectFeeStatus() 75

function to return direct fee statusResponseHandler::getGoogleOrderNumber() 75

function to return Order number (Googlecheckout item name)ResponseHandler::getId() 75

function to retrieve and return ID from Item nameResponseHandler::gcOrderStateChange() 74

This function updates the status of differnt fees accroding to the new-financial-order-statereceived in the status It first retrieves order data from GC transaction log table, convert the new-financial-order-state to respective Fee status value.

ResponseHandler::$_xmlResponse 73ResponseHandler::$_root 73ResponseHandler::$_serverType 73ResponseHandler::$_status 73Rss.php 58

SStandardAuction::__set() 416Store 417

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 552: Manual

web store classStore::DB_TABLE 417

database tablesStandardAuction::__get() 416StandardAuction::typeName() 416StandardAuction::saveToDB() 416StandardAuction::type() 416Store::STORE_BIG 417Store::STORE_MEDIUM 417Store::$_featured 418Store::$_id 418Store::$_description 418Store::$_active 418Store::STORE_SIZE_TABLE 417Store::STORE_SMALL 418

store size constantsStandardAuction::removeUserBids() 415StandardAuction::makeBid() 415StandardAuction::$buyNowPrice 413StandardAuction::$reservePrice 413StandardAuction::$bidIncrementValue 412StandardAuction::$bidIncrementType 412StandardAuction::EXTENDED_DB_TABLE 412StandardAuction::$bidIncrements 412StandardAuction::calculateNextBid() 413StandardAuction::finishOffer() 413StandardAuction::getListOnOneCategory() 415StandardAuction::getWinners() 415StandardAuction::getListFromDB() 414StandardAuction::getInstanceFromDB() 414StandardAuction::getBidButtonText() 413StandardAuction::getExtendedDataFromDB() 414

retrieves data needed for concrete childStore::$_logo 418Store::$_name 419StoreSize::$_id 425StoreSize::$_name 425StoreSize::$_size 425StoreSize::$_active 424StoreSize::STORE_LANGUAGE_TABLE 424StoreSize 424

web store size classStoreSize::DB_TABLE 424

database tablesStoreSize::deleteFromDB() 425StoreSize::getInstanceFromDB() 426StoreSize::__get() 427StoreSize::__set() 428StoreSize::setName() 427

setter and getter for nameStoreSize::saveToDB() 427StoreSize::getListFromDB() 426StoreSize::getName() 426

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 553: Manual

Store::__set() 424Store::__get() 423

interceptorsStore::deleteFromDB() 420

function to delete storeStore::discoverId() 420

Given a string, verify if it's webstore id or webstore name or nothing.

Store::$_test 419Store::$_size 419Store::$_offers 419Store::$_owner 419Store::getInstanceFromDB() 421Store::getListFromDB() 421Store::offerAvailableInStore() 423

function to check if specified offer already exists in the storeStore::saveToDB() 423Store::offerAllowedInStore() 422

check if more offers can be added to the user store or not(Store::size)Store::getUserStore() 422

function to return specified users storeStore::getOffersInStore() 421

function to return offers in the webstoreStore::getStatsFromDB() 422

return webstore statsStandardAuction::BID_INCREMENT_TABLE 412StandardAuction::BID_INCREMENT_FIXED 412SystemInstaller::GENERAL_OPTIONS_TABLE 45SystemInstaller::LANGUAGE_TABLE 45

language table variableSystemInstaller::$configFile 46SystemInstaller 45

System Installer.SystemInspector::verifySystem() 45

Verifies the Whole System and stores the result in a arraySystemInspector::verifyRewriteEngine() 44

function to check if URL Rewritting is Working or not.SystemInspector::verifySPLClasses() 45

Verifies if SPL module is loaded with PHP or notSystemInstaller::$configPath 46

Database config file pathSystemInstaller::$dbConfig 46

array to store database configuration detailsSystemInstaller::constructDB() 48

Constructs the databaseSystemInstaller::createAdmin() 48

function to setup admin user accountSystemInstaller::$pdoErrorMessage 47

variable to store database connection exception messageSystemInstaller::$hasError 47

variable to keep error status in the programSystemInstaller::$dbSqlScript 46

Variable to store SQL Script lines

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 554: Manual

SystemInstaller::$errorMessage 47variable to store the error messages

SystemInspector::verifyPHP() 44Verifies if the current php version is >=5.0.0

SystemInspector::verifyPdoMysql() 44Verifies if PDO-MySql driver is loaded with PHP

String::isEmail() 41Verifies if string is a valid email

SystemInspector 42System Inspector.

String::camelize() 41Remove spaces and othe punctuation characters, and uppercase first letter of every word.

String 40String utilities.

SystemInspector.php 21SystemInstaller.php 22SystemInspector::$errorMessage 42

variable to store Error MessagesSystemInspector::$isInstallable 42

Variable to identify if the system can be used to install the V5SystemInspector::verifyModRW() 43SystemInspector::verifyPDO() 43

Verifies if PDO is loaded with PHPSystemInspector::verifyLinux() 43

Verifies if system is LinuxSystemInspector::verifyGettext() 43

Verifies if the gettext extension is loaded with PHP.SystemInspector::$systemRequirements 42

Variable to store System Verification results, Like which test is pass or failSystemInspector::verifyGD() 43

Verifies if GD library is loaded with PHP or notSystemInstaller::getDBConfig() 48

Write the User Configuration to config.phpSystemInstaller::getLanguageName() 48

function to return language name for specified language idSiteOptions::$_generalOption 409SiteOptions::$_keys 409SiteOptions::SSL_IN_LOGIN 409

constant for ssl on login page onlySiteOptions::DB_TABLE 409

General Options tableStoreSize.php 238SiteOptions 408

SiteOptionsSiteOptions::getInstanceFromDB() 410SiteOptions::getListFromDB() 410StandardAuction 411

StandardAuctionStandardAuction::BID_INCREMENTS_DB_TABLE 412SiteOptions::__set() 411SiteOptions::__get() 411SiteOptions::getThemeList() 410

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 555: Manual

Function to list of themesSiteOptions::saveToDB() 410

saving changes to databaseStore.php 237StandardAuction.php 236SystemInstaller::setUpSiteOptions() 50

function to setup general options in V5_siteOptionsSystemInstaller::verifyDatabaseConfig() 50

Verifies the Database Configuration provided by UserSystemInstaller::setSQLScript() 50

setting the SQL dump dataSystemInstaller::setConfigPath() 49

Setting the config file pathSystemInstaller::getSiteLanguages() 49

Function to retrieve list of languagesSystemInstaller::installDB() 49

Installs the SQL script of V5 database...SystemInstaller::verifyDB() 51

Verifies Database Connection detail by attempting to connect to databaseSystemInstaller::verifySTR() 51

function to verify a string for validityStore.php 143SiteOptions.php 235Settings.php 142Store.php 94StoreSize.php 82Search.php 93String.php 20

TThematic::thematicExists() 432

Function to check if a thematic already existsThematic::__get() 433Thematic::saveToDB() 432

Saving changes to databaseThematic::getName() 432Thematic::getInstanceFromDB() 431Thematic::getListFromDB() 431Thematic::__set() 433Timezone 433

Timezone classTimezone::__get() 434Timezone::__set() 435Timezone::getListFromDB() 434Timezone::getInstanceFromDB() 434Timezone::DB_TABLE 434

Database tableTimezone::$_id 434Thematic::discoverId() 431Thematic::deleteFromDB() 430

Deleting record from database

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 556: Manual

Thematic::DB_TABLE 428database tables

Thematic::THEMATIC_LANGUAGE_TABLE 428Thematic 428

ThematicTimezone.php 240Thematics.php 144Thematic.php 239Thematic::$_active 428Thematic::$_id 429Thematic::$_name 429

member variablesThematic::addName() 430

Function to add and retrive thematic nameThematic::$_inMenu 429Thematic::$_inHomeColumn 429Thematic::$_inFooter 429TABLE_PREFIX 66

DB access config file

UUser::getUserFeedbacksStatsFromDB() 449

retrieves user's bids statisticsUser::getUserIPList() 449

function to retrieve list of ips for this userUser::getUserFavourite() 449

Function to return list of user favouritesUser::getStatsFromDB() 448

Returns detailed user statistics from databaseUser::getOffersStatsFromDB() 448

retrieves user's offers statisticsUser::getPublicData() 448User::isUserFavourite() 450User::recalculateFeedbacks() 450

function to recalculate each users prestige, if it's being affected due to removal of any userUser::verifyPassword() 452User::verifySession() 452

Function to verify the sessionUser::toggleIPStatus() 451

function to block/unblock ipUser::setDefaultType() 451

function to change default type of seller columnUser::renewSession() 450User::saveToDB() 451User::getMessageStats() 447User::getListFromDB() 447User::deleteUserInvoices() 444

function to delete user invoicesUser::getBidsStatsFromDB() 444User::deleteSession() 444User::deleteIP() 443

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 557: Manual

function to remove particular IP from the databaseUser::addUserIP() 443

Function to add User IP to userIP tableUser::deleteFromDB() 443User::getCustomUserData() 445

function to retrieve users custom dataUser::getDefaultUserType() 445

get the default new user typeUser::getInstance() 447User::getInstanceFromDB() 447User::getGeneralStatsFromDB() 446

get some statistics about all website users (for back-end home page)User::getFiltersNames() 446User::getFieldValue() 445

function to retrieve the value of a particular fieldUser::getFilteredListFromDB() 446

Function returns a filtered list of usersUser::verifyUserIP() 453

function to verify the IPUser::__get() 453UserPayMethod::$_details 458UserPayMethod::$_id 459UserPayMethod::$_active 458UserPayMethod::DB_TABLE 458

DB tablesUserFeedback::__set() 457UserPayMethod 458

UserPayMethodsUserPayMethod::$_paymethodId 459UserPayMethod::$_userId 459UserPayMethod::__get() 461UserPayMethod::__set() 461UserPayMethod::saveToDB() 460UserPayMethod::getListFromDB() 460

function to return array of users paymethod data availableUserPayMethod::deleteFromDB() 459UserPayMethod::getInstanceFromDB() 460UserFeedback::__get() 457UserFeedback::saveToDB() 457UserFeedback::$date 454UserFeedback::$fromUser 454UserFeedback::$comment 454UserFeedback::DB_TABLE 454

DB TableUser::__set() 453UserFeedback 454

UserFeedbackUserFeedback::$id 455UserFeedback::$offer 455UserFeedback::getListFromDB() 456UserFeedback::getTypesCount() 456

returns positive, negative and neutral votes for an userUserFeedback::getInstanceFromDB() 456

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 558: Manual

UserFeedback::deleteFromDB() 455function to delete the current record from database

UserFeedback::$toUser 455UserFeedback::$value 455User::addFieldValue() 442

function to add custom field valueUser::$zip 442User.php 241UserFeedback.php 242User.php 145UserPayMethod.php 96Upgrader::update18to20() 13User.php 95UserPayMethod.php 243User 435

UserUser::EMAIL_VERIFIED 436User::INACTIVE 436

User Status constantsUser::DB_USER_TRUST_REQUEST_TABLE 436User::DB_USER_FIELD_TABLE 436User::ADMIN 435User::DB_TABLE 435

DB TablesUpgrader::update17to18() 13Upgrader::update16to17() 13Upgrader::detectVersion() 11Upgrader::getMessage() 11

returns the message stringUpgrader::$versions 11Upgrader::$message 10Upgrader 10

Code to upgradeUpgrader::$DB 10

PDO object for DB connectionUpgrader::lastVersion() 11

returns last version avaiableUpgrader::update() 12Upgrader::update14to15() 13Upgrader::update15to16() 13Upgrader::update13to14() 12Upgrader::update12to13() 12Upgrader::update10to11() 12Upgrader::update11to12() 12User::NEVER_ACTIVATED 436User::SELLER 436User::$registerDate 440User::$seller 440User::$prestige 440User::$phone 439User::$password 439User::$passwordEncripted 439User::$sessionCookie 440

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 559: Manual

User::$state 440User::$userPayMethods 441

variable to store user pay method detailsUser::$validEmail 442User::$userLanguage 441

User language for his received mailsUser::$trustUserStatusRequested 441

variable to identify if user has requested for trust user statusUser::$trustSeller 441User::$trustUserRequestStatus 441User::$name 439User::$id 439User::$active 436User::$address 437User::USER_IP_TABLE 436User::TRUST_REQUEST_PENDING 436User::TRUST_REQUEST_ACCEPTED 436

trust user status request statusUser::TRUST_REQUEST_DENIED 436User::$admin 437User::$balance 437User::$customFields 438

variable for custom FieldsUser::$email 438User::$countryId 438User::$city 438User::$bidCredit 437User::$birthdate 437Upgrader.php 9

Upgrader class file.

VView_PHP 62

Flush out data in serialized PHP formView_JSON::jsEncode() 62

Converts a single item of a PHP array in JSON formatView_JSON::display() 62

Executes ViewView_PHP::display() 62

Executes ViewView_Rss 63

View for displaying RSS.View.php 187View_Rss::display() 63

Executes ViewView_JSON::array2json() 61

Converts a PHP array in JSON formatView_JSON 61

Flush out data with JSON notationView_Echo 59

Just flush out processed data, for testing issues.

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu

Page 560: Manual

View_CSV::display() 59Executes View

View_Echo::display() 60Executes View

View_HTML 60View for displaying HTML.

View_HTML::setContext() 61Retrieves context

View_HTML::display() 60Executes View

View_CSV 59View for exporting lists as csv file.

___autoload() 68

Classes "autoload"

Generated by phpDocumentor v1.4.3 http://www.phpdoc.org - http://pear.php.net/package/PhpDocumentor - http://www.sourceforge.net/projects/phpdocu