classes/php5_classes/ListingDisplay.class.php

Properties

Description

Holds the geoListingDisplay object.

Classes

geoListingDisplay

Properties

 
 
System  
No 
No 

Description

This is basically a container that is responsible for helping to display {listing .
..} tags. This class is not meant to be used outside of the template system.

Methods

_canBid, _dateDifference, _getLeveledFields, _initAdConfig, _initCatConfig, _isAnon, _listing_tags, _loadExtraQuestions, _url_links, _voteSummary, addSessionVars, additional_region_trees, all_region_trees, bid_history_link, buy_now_link, buy_now_price_adjusted, buyer_option_selections, category_breadcrumb, category_tree, contact_seller_form, extra_checkbox_name, extra_question_name, extra_question_value, extra_questions, favorites_link, feedback_link, full_images_link, getSessionVars, high_bidder, image_block, image_block_large, image_block_large_link, image_slideshow_link, lead_picture, listing_tags_links, listing_tags_list, make_bid_link, mapping_link, mapping_link_alternate, message_to_seller_link, multi_level_field_breadcrumb, multi_level_field_ul, next_ad_link, notify_friend_link, number_images, number_listing_tags, number_videos, offsite_videos_block, on_site_purchase_link, preParseAllTags, previous_ad_link, price_for_how_many, primary_region_tree, print_friendly_link, seller, seller_number_rates, seller_rating, sellers_other_ads_link, show_ad_vote_comments_link, sponsored_by, tell_a_friend_form, time_remaining, url_link_1, url_link_2, url_link_3, user_rating, verified_account, voteSummary_percent, voteSummary_text, voteSummary_total, voteSummary_votes, vote_on_ad_link, winning_dutch_bidders,

_canBid( \geoListing   $listing, ) : bool

Description

Figures out if the current browsing user can bid on the given listing or not.

Arguments

Name Type Description Default
$listing \geoListing

Return value

Type Description
bool

_dateDifference( string   $interval, int   $date1, int   $date2, ) : int

Description

Use to get difference of 2 times, but in specified interval

Arguments

Name Type Description Default
$interval string

w d h m or s

$date1 int
$date2 int

Return value

Type Description
int

_getLeveledFields( \geoListing   $listing, \unknown   $params, ) : \Ambigous

Description

Used by the tags that show leveled fields, to get leveled fields for a listing.

Arguments

Name Type Description Default
$listing \geoListing
$params \unknown

Return value

Type Description
\Ambigous <multitype:, multitype:Ambigous <> , boolean, string, unknown, Mixed>

_initAdConfig( ) : array

Description

Initializes ad configuration and returns array of ad config settings

Return value

Type Description
array

_initCatConfig( ) : array

Description

Initializes the category configuration and returns the cat settings

Return value

Type Description
array

_isAnon( \geoListing   $listing, ) : bool

Description

Figures out whether the listing is placed anonymously or not

Arguments

Name Type Description Default
$listing \geoListing

Return value

Type Description
bool

_listing_tags( \geoListing   $listing, string   $file, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Common method used by tag displaying thingies.

Arguments

Name Type Description Default
$listing \geoListing
$file string
$params array
$smarty \Smarty_Internal_Template

Return value

Type Description
string

_loadExtraQuestions( \geoListing   $listing, ) : n/a

Description

Loads the extra questions and values for the listing into the $listing->e_extra_questions var for use in the question tags.

Arguments

Name Type Description Default
$listing \geoListing

Return value

Type Description
n/a n/a

_url_links( \geoListing   $listing, int   $url_number, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Parent method for the common stuff that is done for the different URL link methods, to cut down on code duplication

Arguments

Name Type Description Default
$listing \geoListing
$url_number int
$params array
$smarty \Smarty_Internal_Template

Return value

Type Description
string

_voteSummary( \geoListing   $listing, ) : array

Description

Get the array of info used by vote summaries

Arguments

Name Type Description Default
$listing \geoListing

Return value

Type Description
array

addSessionVars( array   $session_vars, ) : n/a

Description

Used for listing details page, when previewing listing, to set values for session vars so we can fake display stuff.

Arguments

Name Type Description Default
$session_vars array

Return value

Type Description
n/a n/a

additional_region_trees( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Displays all the additional region trees (breadcrumbs) set for a listing not including the primary region, each one separated by an HTML line break.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

all_region_trees( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Combination of the primary region tree, and all additional region trees, each tree (region breadcrumb) seperated by an HTML line break.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

bid_history_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link text allowing the user to view the bid history of the current auction. You can turn off and on the visibility of this link while the auction is live within the admin. The link will be visible when the auction ends

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

buy_now_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link to buy now.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

buy_now_price_adjusted( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This shows the buy now price, and will adjust according to any buyer options selected (unlike buy_now_data which will show only base cost)

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

buyer_option_selections( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This displays the buyer options if there are any set for the auction.
It will allow the visitor to choose the various options the seller has created for the item (for instance, if it was selling a shirt, there might be shirt sizes or color options). This will let the visitor select the various options and it will update the price.

Arguments

Name Type Description Default
$listing \geoListing
$params array
$smarty \Smarty_Internal_Template

Return value

Type Description
string

category_breadcrumb( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

The current category as well as links to parent categories this listing is in, but using the breadcrumb format.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

category_tree( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

The current category as well as links to parent categories this listing is in.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

contact_seller_form(   $listing,   $params,   $smarty, ) : n/a

Arguments

Name Type Description Default
$listing n/a
$params n/a
$smarty n/a

Return value

Type Description
n/a n/a

extra_checkbox_name( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

The name attached to the data field.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category checkboxes

extra_question_name( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Shows the extra question names -- DEPRECATED / FOR BACK-COMPATIBILITY ONLY

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category questions
deprecated 7.3.2 use extra_questions() instead

extra_question_value( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Shows the extra question values -- DEPRECATED / FOR BACK-COMPATIBILITY ONLY

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category questions
deprecated 7.3.2 use extra_questions() instead

extra_questions( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Shows the extra question names and values together (replaces old split functions)

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category questions
since 7.3.2

favorites_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link text allowing the user to add the current listing to their favorites list in their user home page.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

feedback_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link to the feedback page.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

full_images_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link text allowing the user to view all images at their full size on the same page.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

getSessionVars( ) : array

Description

Method to get session vars that were previously set by the system on the main display page. If the array is empty, then the current page is not on the main display listing details page.

Return value

Type Description
array

high_bidder( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the high bidder's username.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

image_block( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Shows the \"Verified\" icon if the seller uses a verified account.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general,seller

image_block_large( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

The full-sized images block for this listing. Designed to be used in combination with the {$image_block_large_link} tag that you would place near the top of the template, then put this tag near the bottom.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

image_block_large_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This will display a link that looks similar to "See all ## Photos" where ## is automatically replaced with the number of images for the listing.
This is designed to be used right below the lead picture, then use the large photo block lower in the template somewhere.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

image_slideshow_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link to view image slideshow for the listing, starting from image 1.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

lead_picture( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Shows the lead picture in slot 1 for listing, if there is one

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

listing_tags_links( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

A list of all "listing tags", each one links to page showing listings that have that tag.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

listing_tags_list( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

A list of all "listing tags", without links. This is suitable for use in META tags if desired.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

make_bid_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This displays the link to make a bid on the auction. It is only displayed when the auction is live.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

mapping_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Google Maps link to create a map to the location entered for this listing.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

mapping_link_alternate( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Same as mapping_link, but uses Mapquest instead of Google Maps (not recommended for non-US addresses)

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

message_to_seller_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link allowing the client to send a message to the seller of the listing.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

multi_level_field_breadcrumb( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

For each multi-level field in the listing, shows a breadcrumb.
Can optionally show "only" values for specific field, by specifying only_field=# (replace # with the multi-level field number).

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category multi_level_fields

multi_level_field_ul( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

For each multi-level field in the listing, shows each level's label and value, using <ul> (unordered list), with CSS class of "info" like is used for other listing information.
Can optionally show "only" values for specific field, by specifying only_field=# (replace # with the multi-level field number).

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category multi_level_fields

next_ad_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Link that will display in the listing allowing the user to see the next listing within the category.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

notify_friend_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link allowing the client to send a notification to a friend about the current listing.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

number_images( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Displays the number of images for a listing. This is the "real" count, not the number purchased.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category stats

number_listing_tags( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Displays the number of listing tags attached to a listing.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category stats

number_videos( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Displays the number of external videos for a listing. This is the "real" count, not the number purchased.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category stats

offsite_videos_block( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Shows the offsite videos

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

on_site_purchase_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This displays a link to "Pay Now" to the winning bidder. This will only display something on auctions that are properly configured to use an on-site payment (such as Paypal), that are closed, and only to the winning bidder or admin user. Note that it displays to the admin user so that the admin can see what it looks like, for design customization purposes.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

preParseAllTags( ) : n/a

Description

Pre-parse every single possible tag and assign it to the global view class, to allow backwards compatibility with older templates that do not use the {listing} tag.

Return value

Type Description
n/a n/a

previous_ad_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Link that will display in the listing allowing the user to see the previous listing within the category.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

price_for_how_many( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Display "for 1 item" if price is for a single item, or there is only one item, or "for lot of #" if the price applies to the entire quantity, and there is more than one. Designed to be used directly after or below the current price, minimum bid, buy now price, or any other prices like optional field prices that add cost.

Arguments

Name Type Description Default
$listing \geoListing
$params array
$smarty \Smarty_Internal_Template

Return value

Type Description
string

primary_region_tree( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Displays the full primary region tree (breadcrumb) for the listing.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

print_friendly_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link text allowing the user to view the listing details page in a page that is more print friendly.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

seller( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Sellers username data.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

seller_number_rates( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the seller's feedback score.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

seller_rating( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the seller rating.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

sellers_other_ads_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link text allowing the user to view the current sellers other listings.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

show_ad_vote_comments_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link text allowing the user to view the votes and comments attached to the current listing.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

sponsored_by( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is where the sponsored by html is placed within sellers listings where that sellers group has "sponsered by" html has been placed. If none of your groups use the sponsored by html fields this tag does not need to be placed within the listing display template.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

tell_a_friend_form(   $listing,   $params,   $smarty, ) : n/a

Arguments

Name Type Description Default
$listing n/a
$params n/a
$smarty n/a

Return value

Type Description
n/a n/a

time_remaining( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the time left in the current auction.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

url_link_1( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Links to url link 1 on listing

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

url_link_2( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Links to url link 2 on listing

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

url_link_3( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Links to url link 1 on listing

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

user_rating(   $listing,   $params,   $smarty, ) : n/a

Arguments

Name Type Description Default
$listing n/a
$params n/a
$smarty n/a

Return value

Type Description
n/a n/a

verified_account( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Shows the \"Verified\" icon if the seller uses a verified account.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general,seller

voteSummary_percent( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Number of votes in the leading vote category, expressed as a percentage of the total number of votes

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

voteSummary_text( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Text (by default, a "thumbs up" or "thumbs down" image) used on the show votes page to describe the leading vote category

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

voteSummary_total( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Total number of votes in all vote categories for this listing

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

voteSummary_votes( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

Number of votes in the leading vote category for this listing

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

vote_on_ad_link( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the link text allowing the user to vote and leave comments about the current listing.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category general

winning_dutch_bidders( \geoListing   $listing, array   $params, \Smarty_Internal_Template   $smarty, ) : string

Description

This is the winning bidder's user id on a dutch auction.

Arguments

Name Type Description Default
$listing \geoListing

Listing object

$params array

Array of parameters passed in smarty tag

$smarty \Smarty_Internal_Template

Return value

Type Description
string

Tags

Name Description
category auctions

Properties

$_ad_configuration_data, $_configuration_data, $_session_vars,

array  private  static $_ad_configuration_data = array()

listing config settings stored internally so we only have to get once


array  private  static $_configuration_data = array()

config settings stored internally so we only have to get once


array  private  static $_session_vars = array()

Session vars


Documentation was generated by phpDocumentor 2.2.0 .

Namespaces

  • global

    Packages

    • Default
      • ExampleAddon
        • addon_example_admin
          In charge of doing stuff on the admin side, this is optional.
        • addon_example_info
          Required class for addons, this is the Addon information class, used by the addon system to determine what the addon can do. Also contains info about the addon that can be viewed in the addon management page in the admin.
        • addon_example_pages
          Addon page class, used by the addon system to display pages on the client side.
        • addon_example_setup
          This class is not required. If it, and the function for a particular routine exist, then that function will be called IN ADDITION TO the automated routines of the addon framework.
        • addon_example_tags
          Expects one function for each tag. Function name should be the same as the tag name. Can also have a constructor if anything needs to be constructed.
        • addon_example_util
          This is where to put functions that the main part of the addon will use.
        • eWidgetOrderItem
          This order item is designed to allow users on your site to purchase an eWidget.
      • System
        • DataAccess
          This is the main Database access object.
        • Singleton
          Singleton method class
        • _templateOrderItem
          Developers: use this file as a template to create a new order item.
        • _templatePaymentGateway
          This is the "developer template" payment gateway handler, a developer could use this file as a starting point for creating a new payment gateway in the system.
        • geoAPI
          The main system class for receiving and handling remote API calls, this acts as a translation layer between the communication with the "outside" and each API call.
        • geoAddon
          This is the class that handles anything and everything to do with addons.
        • geoArrayTools
          Utility functions for manipulating arrays
        • geoBrowse
          Contains functions common to browsing listings
        • geoBrowsingFilter
          System for activating, storing, and deactivating browsing filters.
        • geoCJAX
          Class that wraps the CJAX_FRAMEWORK, used to get the CJAX class.
        • geoCache
          This is the main part of the Geo cache system, it does all the "low level" stuff like writing files and escaping cache data.
        • geoCacheModule
          Part of Geo Cache system, specifically tuned to work best with cacheing module data (which will be an array).
        • geoCachePage
          Cache system specifically tuned to work best with cacheing output of pages and modules
        • geoCacheSetting
          Part of Geo Cache system, specifically tuned to work best with cacheing site-wide key=value type settings.
        • geoCacheText
          Part of Geo Cache system, this part specifically tuned to work best with cacheing language specific messages.
        • geoCalendar
          Holds utility method(s) for manipulating stuff dealing with calendar selector.
        • geoCart
          This class is behind the cart, loading all the order items and such and displaying, and processing all the different pages.
        • geoCategory
          Utility class that holds various methods to do stuff with categories in the system.
        • geoCombineResources
          This class helps to combine CSS and JS files, minify them, and optionally compress them.
        • geoCron
          This is the cron job backend, it handles all the communication and security and all that.
        • geoCrypt
          Class to use for encrypting information that needs to be able to be retrieved later.
        • geoDate
          Holds utility method(s) for manipulating stuff dealing with dates.
        • geoEmail
          Class that sends out e-mails.
        • geoFields
          Class that holds settings information for fields to use.
        • geoFieldsField
          A mini object to hold data about a specific field.
        • geoFile
          As the name implies, this is used for file-based utility methods.
        • geoFilter
          A few utility methods, good for filtering stuff.
        • geoFormatString
          Used to display a message nice and pretty, we'll probably be getting rid of this class though so don't go crazy using it.
        • geoHTML
          Class to generate chunks of HTML that are very common, used the most in the admin panel.
        • geoImage
          This class is responsible for a lot of the image processing, along with other aspects like generating the image tag for thumbnails.
        • geoInvoice
          This is the invoice object representing an invoice in the system.
        • geoLeveledField
          Class for doing common things with leveled fields.
        • geoListing
          A listing object, basically a container object for particular listing.
        • geoListingDisplay
          This is basically a container that is responsible for helping to display {listing .
        • geoListingFeed
          Class that helps to render RSS or other types of feeds based on list of listings.
        • geoMaster
          This is dedicated class for getting the value of, and setting, the various "master switches" within the software. Since this is meant as an easy way to get the values of master switches, most of the methods are static.
        • geoNumber
          Utility functions relating to number conversion/manipulation/validation ect.
        • geoOrder
          The geoOrder object, an object representation of an order in the system.
        • geoOrderItem
          The class that all order items must extend.
        • geoPC
          Used for login credential validation, password hashing, etc. along with software licensing.
        • geoPagination
          Utility functions useful for generating pagination of a results page such as when browing ads or searching
        • geoPaymentGateway
          This class should be extended by each different payment gateway, this will have some default functions that each gateway will inherit, and also has a few final static methods used by the system to affect all order items.
        • geoPlanItem
          A container to hold settings for a particular order item type, according to price plan ID, and optionally category ID for category specific settings.
        • geoRecurringBilling
          The geoRecurringBilling object, an object representation of a recurring billing in the system.
        • geoRegion
          Stuff for regions and sub-regions.
        • geoRegistry
          Handy little object, can be used to set registry type settings.
        • geoSearchUtils
          Class for search utilities.
        • geoSellerBuyer
          Handles back-end for the seller/buyer payment gateways, to allow the buyer to more easily pay the seller for a won auction. This handles the underlying system, but the actual work is done by individual seller/buyer gateways, for instance the Paypal buy-now functionality.
        • geoSession
          Manages session storage and session cookies for user sessions.
        • geoString
          Utility functions relating to languages and string manipulation.
        • geoStringData
          This class is to store accented chars, to be used by {@link geoString::removeAccents()}, mainly to keep the String.class.php file un-cluttered.
        • geoTable
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableRow
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableRowset
          NOT FULLY IMPLEMENTED! Do not use this class yet as it is not finished and may change drastically before we are done with it, or may even be removed.
        • geoTableSelect
          Class used to generate a select query, useful when multiple areas want to affect a single query, for instance when generating a search query and there are addons involved.
        • geoTables
          Used to hold database table names, used throughout the code.
        • geoTemplate
          Template object that extends the Smarty class (a 3rd party library) to enable using templates to display things.
        • geoTransaction
          This is the object used for a transaction in the order and invoice system.
        • geoUser
          An object representative of a certain user in the system.
        • geoUserRating
          Store, retrieve, and display inter-user ratings
        • geoUtil
          Misc utility functions
        • geoView
          As the name implies, this is used for creating the page view. It does take a little setup (like any class), the setup is normally done in the display_page method in geoSite, or display_page in geoAdmin if displaying a page in the admin.
        • iApiTransport
          Interface for API Transports, a transport must implement this interface for the system to use it.
        • iOrderItem
          You cannot have abstract static functions, so instead need to have an interface to force the given static functions to be defined.
        • metaDbTables
          Used so that old locations that use the old name geoTables will still work.