[ Index ]
osCommerce Docs :: PHP Cross Reference For osCommerce 2.2 MS2
Provided By OSCdox.com

/includes/functions/ -> general.php (summary)

[Source view]

(no description)

Author: (None specified)
File Size: 1253 lines (42 kb)
Included or required: 3 times
Referenced: 0 times
Includes or requires: 0 files
Tables referenced:  address_book
 address_format
 categories
 countries
 countries;
 currencies
 customers
 products
 products_to_categories
 tax_rates
 tax_rates;
 zones
 zones_to_geo_zones

Defines 64 functions

  tep_exit()
  tep_redirect()
  tep_parse_input_field_data()
  tep_output_string()
  tep_output_string_protected()
  tep_sanitize_string()
  tep_random_select()
  tep_get_products_name()
  tep_get_products_special_price()
  tep_get_products_stock()
  tep_check_stock()
  tep_break_string()
  tep_get_all_get_params()
  tep_get_countries()
  tep_get_countries_with_iso_codes()
  tep_get_path()
  tep_browser_detect()
  tep_get_country_name()
  tep_get_zone_name()
  tep_get_zone_code()
  tep_round()
  tep_get_tax_rate()
  tep_get_tax_description()
  tep_add_tax()
  tep_calculate_tax()
  tep_count_products_in_category()
  tep_has_category_subcategories()
  tep_get_address_format_id()
  tep_address_format()
  tep_address_label()
  tep_row_number_format()
  tep_get_categories()
  tep_get_manufacturers()
  tep_get_subcategories()
  tep_date_long()
  tep_date_short()
  tep_parse_search_string()
  tep_checkdate()
  tep_is_leap_year()
  tep_create_sort_heading()
  tep_get_parent_categories()
  tep_get_product_path()
  tep_get_uprid()
  tep_get_prid()
  tep_customer_greeting()
  tep_mail()
  tep_has_product_attributes()
  tep_word_count()
  tep_count_modules()
  tep_count_payment_modules()
  tep_count_shipping_modules()
  tep_create_random_value()
  tep_array_to_string()
  tep_not_null()
  tep_display_tax_value()
  tep_currency_exists()
  tep_string_to_int()
  tep_parse_category_path()
  tep_rand()
  tep_setcookie()
  tep_get_ip_address()
  tep_count_customer_orders()
  tep_count_customer_address_book_entries()
  tep_convert_linefeeds()

Functions

Functions that are not part of a class:
tep_exit()   X-Ref

Stop from parsing any further PHP code

tep_redirect($url)   X-Ref

Redirect to another page or site

tep_parse_input_field_data($data, $parse)   X-Ref

Parse the data used in the html tags to ensure the tags will not break

tep_output_string($string, $translate = false, $protected = false)   X-Ref
No description

tep_output_string_protected($string)   X-Ref
No description

tep_sanitize_string($string)   X-Ref
No description

tep_random_select($query)   X-Ref

Return a random row from a database query

tep_get_products_name($product_id, $language = '')   X-Ref

Return a product's name
TABLES: products

tep_get_products_special_price($product_id)   X-Ref

Return a product's special price (returns nothing if there is no offer)
TABLES: products

tep_get_products_stock($products_id)   X-Ref

Return a product's stock
TABLES: products

tep_check_stock($products_id, $products_quantity)   X-Ref

Check if the required stock is available
If insufficent stock is available return an out of stock message

tep_break_string($string, $len, $break_char = '-')   X-Ref

Break a word in a string if it is longer than a specified length ($len)

tep_get_all_get_params($exclude_array = '')   X-Ref

Return all HTTP GET variables, except those passed as a parameter

tep_get_countries($countries_id = '', $with_iso_codes = false)   X-Ref

Returns an array with countries
TABLES: countries

tep_get_countries_with_iso_codes($countries_id)   X-Ref

Alias function to tep_get_countries, which also returns the countries iso codes

tep_get_path($current_category_id = '')   X-Ref

Generate a path to categories

tep_browser_detect($component)   X-Ref

Returns the clients browser

tep_get_country_name($country_id)   X-Ref

Alias function to tep_get_countries()

tep_get_zone_name($country_id, $zone_id, $default_zone)   X-Ref

Returns the zone (State/Province) name
TABLES: zones

tep_get_zone_code($country_id, $zone_id, $default_zone)   X-Ref

Returns the zone (State/Province) code
TABLES: zones

tep_round($number, $precision)   X-Ref

Wrapper function for round()

tep_get_tax_rate($class_id, $country_id = -1, $zone_id = -1)   X-Ref

Returns the tax rate for a zone / class
TABLES: tax_rates, zones_to_geo_zones

tep_get_tax_description($class_id, $country_id, $zone_id)   X-Ref

Return the tax description for a zone / class
TABLES: tax_rates;

tep_add_tax($price, $tax)   X-Ref

Add tax to a products price

tep_calculate_tax($price, $tax)   X-Ref
No description

tep_count_products_in_category($category_id, $include_inactive = false)   X-Ref

Return the number of products in a category
TABLES: products, products_to_categories, categories

tep_has_category_subcategories($category_id)   X-Ref

Return true if the category has subcategories
TABLES: categories

tep_get_address_format_id($country_id)   X-Ref

Returns the address_format_id for the given country
TABLES: countries;

tep_address_format($address_format_id, $address, $html, $boln, $eoln)   X-Ref

Return a formatted address
TABLES: address_format

tep_address_label($customers_id, $address_id = 1, $html = false, $boln = '', $eoln = "\n")   X-Ref

Return a formatted address
TABLES: customers, address_book

tep_row_number_format($number)   X-Ref
No description

tep_get_categories($categories_array = '', $parent_id = '0', $indent = '')   X-Ref
No description

tep_get_manufacturers($manufacturers_array = '')   X-Ref
No description

tep_get_subcategories(&$subcategories_array, $parent_id = 0)   X-Ref

Return all subcategory IDs
TABLES: categories

tep_date_long($raw_date)   X-Ref
No description

tep_date_short($raw_date)   X-Ref

Output a raw date string in the selected locale date format
$raw_date needs to be in this format: YYYY-MM-DD HH:MM:SS
NOTE: Includes a workaround for dates before 01/01/1970 that fail on windows servers

tep_parse_search_string($search_str = '', &$objects)   X-Ref

Parse search string into indivual objects

tep_checkdate($date_to_check, $format_string, &$date_array)   X-Ref

Check date

tep_is_leap_year($year)   X-Ref

Check if year is a leap year

tep_create_sort_heading($sortby, $colnum, $heading)   X-Ref

Return table heading with sorting capabilities

tep_get_parent_categories(&$categories, $categories_id)   X-Ref

Recursively go through the categories and retreive all parent categories IDs
TABLES: categories

tep_get_product_path($products_id)   X-Ref

Construct a category path to the product
TABLES: products_to_categories

tep_get_uprid($prid, $params)   X-Ref

Return a product ID with attributes

tep_get_prid($uprid)   X-Ref

Return a product ID from a product ID with attributes

tep_customer_greeting()   X-Ref

Return a customer greeting

tep_mail($to_name, $to_email_address, $email_subject, $email_text, $from_email_name, $from_email_address)   X-Ref
Send email (text/html) using MIME
This is the central mail function. The SMTP Server should be configured
correct in php.ini
Parameters:
$to_name           The name of the recipient, e.g. "Jan Wildeboer"
$to_email_address  The eMail address of the recipient,
e.g. jan.wildeboer@gmx.de
$email_subject     The subject of the eMail
$email_text        The text of the eMail, may contain HTML entities
$from_email_name   The name of the sender, e.g. Shop Administration
$from_email_adress The eMail address of the sender,
e.g. info@mytepshop.com

tep_has_product_attributes($products_id)   X-Ref

Check if product has attributes

tep_word_count($string, $needle)   X-Ref

Get the number of times a word/character is present in a string

tep_count_modules($modules = '')   X-Ref
No description

tep_count_payment_modules()   X-Ref
No description

tep_count_shipping_modules()   X-Ref
No description

tep_create_random_value($length, $type = 'mixed')   X-Ref
No description

tep_array_to_string($array, $exclude = '', $equals = '=', $separator = '&')   X-Ref
No description

tep_not_null($value)   X-Ref
No description

tep_display_tax_value($value, $padding = TAX_DECIMAL_PLACES)   X-Ref

Output the tax percentage with optional padded decimals

tep_currency_exists($code)   X-Ref

Checks to see if the currency code exists as a currency
TABLES: currencies

tep_string_to_int($string)   X-Ref
No description

tep_parse_category_path($cPath)   X-Ref

Parse and secure the cPath parameter values

tep_rand($min = null, $max = null)   X-Ref

Return a random value

tep_setcookie($name, $value = '', $expire = 0, $path = '/', $domain = '', $secure = 0)   X-Ref
No description

tep_get_ip_address()   X-Ref
No description

tep_count_customer_orders($id = '', $check_session = true)   X-Ref
No description

tep_count_customer_address_book_entries($id = '', $check_session = true)   X-Ref
No description

tep_convert_linefeeds($from, $to, $string)   X-Ref
No description



Generated: Tue Nov 4 23:53:39 2003
Hosted By :: AABox.com
Cross-referenced by PHPXref 0.4