classes/php5_classes/Browse.class.php

Properties

Description

Holds the geoBrowse class.

Classes

geoBrowse

Properties

 
 
System  
No 
No 

Description

Contains functions common to browsing listings

Methods

__construct, browse_error, categoryBrowsing, categoryColumnSort, classified_exists, commonBrowseData, getCurrentBrowseView, getOrderByString, getSortOptions, pageNotFound, whereCategory,

__construct( int   $category_id = 0, ) : n/a

Description

Creates a geoBrowse object and merges category-specific settings together

Arguments

Name Type Description Default
$category_id int

If set, will be used to set site_category. {@since Version 7.2.2}

0

Return value

Type Description
n/a n/a

browse_error(   $error = '', ) : n/a

Description

Displays an error message, then exits the script.
If no message is provided, attempts to find one in the site class Failing that, displays a generic error message

Arguments

Name Type Description Default
$error n/a

String An error message to show

''

Return value

Type Description
n/a n/a

categoryBrowsing( array   $text = array(), string   $cacheNamePrefix = '', bool   $isHomePage = false, ) : string

Description

Populates category browsing information, according to $this->site_category, using category cache if available. Currently it returns the navigation contents, but that could change once we ge around to re-doing it so that the category data is cached using the geoCache system instead of just saving category browsing to DB.

Arguments

Name Type Description Default
$text array

Associative array of text to use in template, with following indexes: back_to_normal_link, tree_label, main_category, no_subcats

array()
$cacheNamePrefix string

The DB column prefix for the category cache

''
$isHomePage bool

If true, will bypass normal check of whether displaying category navigation is on, since home page has it's own setting for that. Setting added in version 7.3.2

false

Return value

Type Description
string The category browsing HTML to use on the page.

Tags

Name Description
since Version 5.1.0

categoryColumnSort( Array   $categories, int   $columns, bool   $cat_alpha, int   $maxColumnCount, ) : Array

Description

Sorts an array of categories into a number of columns with a max length

Arguments

Name Type Description Default
$categories Array

pre-constructed array of categories. several assumed values. @see geoBrowse::categoryBrowsing()

$columns int

number of columns to sort into

$cat_alpha bool

true if sorting across columns instead of down them

$maxColumnCount int

maximum length of each column (will increase recursively if needed)

Return value

Type Description
Array $categories_sorted Like $categories, but sorted.

Tags

Name Description
since 7.0.0

classified_exists( int   $classified_id = 0, ) : bool

Description

Finds out if a given id number has a listing associated with it.
Included here mainly for legacy purposes, this may be removed in the future. Instead, you would call geoListing::getListing($classified_id,false) and if the result produced an object, then the listing exists. If it returned false, you know the listing does not exist.

Arguments

Name Type Description Default
$classified_id int

the id to check

0

Return value

Type Description
bool true if listing exists, false otherwise

commonBrowseData( Array   $data, Array   $text, bool   $featured = false, bool   $tabular = true, ) : Array

Description

converts raw listing data that is common to all browsing pages into a format the templates can use.
This sets up ALL possible data -- it's up to the caller to configure the template to only show the appropriate columns

Arguments

Name Type Description Default
$data Array

usually a row out of the classifieds table

$text Array

array of page-specific database text

$featured bool

is this being displayed as part of a set of featured listings?

false
$tabular bool

If set to false, will set country/state to blank instead of "-" when not set. Param added in version 6.0.4

true

Return value

Type Description
Array the formatted array

getCurrentBrowseView( ) : string

Description

Get what the current browsing view should be, based on the default or if set, the last requested view as saved in the session. It will be either grid, list, or gallery

Return value

Type Description
string

Tags

Name Description
since Version 7.1.0

getOrderByString( int   $browse_type = false, int   $category = 0, ) : string

Description

Returns the order by part of a SQL statement depending on the specified browse type number, specify false to use site-default.

Arguments

Name Type Description Default
$browse_type int

The number to browse by.

false
$category int

the current browsing category

0

Return value

Type Description
string

getSortOptions( array   $fields, array   $txt, ) : array

Description

Get array of sort options to show in sort drop-down.

Arguments

Name Type Description Default
$fields array

Array of fields as returned by geoFields::getDisplayLocationFields()

$txt array

Array of labels, each array entry is sort_id => label

Return value

Type Description
array An array in same format as the text array, but with entries that should not show filtered out.

Tags

Name Description
since Version 7.1.0

pageNotFound( ) : n/a

Description

If setting to use 404 header is turned on, this method will send a 404 not found header. Otherwise nothing will happen when this is called.

Return value

Type Description
n/a n/a

Tags

Name Description
since Version 5.1.0

whereCategory( \geoTableSelect   $query, int   $category_id, ) : boolean

Description

Add the specified category to the WHERE clause for the $query

Arguments

Name Type Description Default
$query \geoTableSelect
$category_id int

Return value

Type Description
boolean True if where subquery added successfully, false otherwise

Tags

Name Description
since 7.4.0

Properties

$configuration_data,

Array  public  $configuration_data =

category configuration settings.


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.