/includes/functions/general.php

Модуль представляет собой библиотеку подключаемых практически во всех модулях функций. Краткое описание этих функций будет дано ниже.

function tep_exit();
Функция закрывает открытую сессию и завершает работу.
function tep_redirect($url);
Функция осуществляет перенаправление  на указанную страницу
function tep_parse_input_field_data($data, $parse);
Функция производит поиск и замену в исходной строке $data значений, определяющихся содержимым массива $parse. Массив содержит
значения вида строка-замена. Возвращает преобразованную строку.
function tep_output_string($string, $translate = false, $protected = false);
Со строкой $string производит преобразования в соответствии со значениями массива $translate(по аналогии с  предыдущей функцией). при необходимости производит преобразование строки в формат "безопасный" для HTML страниц - заменяя все опасные символы их соответствующими заменителями. Преобразование производится, если параметр $proteced  равен true. Возвращает преобразованную строку.
function tep_output_string_protected($string);
Аналогично предыдущей функции возвращает строку, преобразованную в "безопасный" HTML вид.
function tep_sanitize_string($string);
Возвращает строку $string очищенную от лишних пробелов, а так же символов HTML тэгов <>. Последние заменяются на подчеркивание.
function tep_random_select($query);
Возвращает ассоциативный массив с результатами запроса $query. При этом, если результатом запроса является более чем одна строка - возвращается случайная строка в виде массива
function tep_get_products_name($product_id, $language = '');
Возвращает имя товара с заданным идентификатором.
function tep_get_customers_groups_id();
Возвращает идентификатор группы пользователя. Для определенной группы пользователей может назначаться, например определенная ставка дисконта.
function tep_get_products_special_price($product_id);
Возвращает специальную цену для продукта с заданным идентификатором. При этом учитывается специальная цена товара, система групповых скидок и наценок.
function tep_get_products_stock($products_id);
Возвращает количество товара на складе в магазине, если ведется отслеживание склада.
function tep_check_stock($products_id, $products_quantity);
Возвращет сообщение об ошибке, если указанного идентификатором товара на складе меньше, чем задано в $products_quantity. Если товара достаточно - возвращается пустая строка.
function tep_break_string($string, $len, $break_char = '-');
Возвращается строка, для которой расставляется разделительный символ в позициях, превышающих заданную длину. Таким образом, например, можно разбить одну длинную строку на несколько строк заданной длины.
function tep_get_all_get_params($exclude_array = '');
Очищает и возвращает строку, содержащую все значимые параметры из URL запроса, кроме тех, которые задают параметры, например, сессии.
function tep_get_countries($countries_id = '', $with_iso_codes = false);
Функция возвращает массив с именами стран и их ISO кодами
function tep_get_countries_with_iso_codes($countries_id);
Функциф возвращает массив с именами стран, у которых есть ISO код.
function tep_get_path($current_category_id = '');
Функция возвращает строку для URL, содержащей путь к заданной категории с учетом подкатегорий. Строка будет выглядеть примерно так:
cPath=3_6_9 для категории 9. Что означает: категория 9 является подкатегорией 6, которая в свою очередь является подкатегорией 3.
function tep_browser_detect($component);
Функция возвращает имя браузера клиента.
function tep_get_country_name($country_id);
Возвращает имя страны при заданном идентификаторе.
function tep_get_zone_name($country_id, $zone_id, $default_zone);
Возвращает имя временной зоны для заданной страны с определенным идентификаторм зоны.
function tep_get_zone_code($country_id, $zone_id, $default_zone);
Возвращает код временной зоны для заданной страны с определенным идентификаторм зоны.
function tep_round($number, $precision);
Возвращает числовое значение $number округленное до точности $precision после запятой
function tep_get_tax_rate($class_id, $country_id = -1, $zone_id = -1);
Возвращает ставку налога для заданного класса налогов и определенных стран и зон.
function tep_get_tax_description($class_id, $country_id, $zone_id);
Возвращает описание ставки налога для заданного класса налогов и определенных стран и зон.
function tep_add_tax($price, $tax);
Возвращает число, соответствующее цене $price при установленной налоговой ставке $tax. Так, при 20% ставке для числа 100 вернет 120.
function tep_calculate_tax($price, $tax);
Возвращает число, соответствующее величине налога при заданной сумме $price и ставке  $tax. Так, при 20% ставке для числа 100 вернет 20.
function tep_count_products_in_category($category_id, $include_inactive = false);
Возвращает количество товаров в категории. Флагом $include_inactive можно регулировать, следует ли в общее число включать количество неактивных (скрытых) товаров.
function tep_has_category_subcategories($category_id);
Возвращает true если категория с идентификатором $category_id имеет подкатегории.
function tep_get_address_format_id($country_id);
Возвращает идентификатор формата адреса для страны, заданной соответствующим идентификатором.
function tep_address_format($address_format_id, $address, $html, $boln, $eoln);
Возвращает строку с адресом $address отформатированную в соответствии с идентификатором $address_format_id в обычном ($html=false) или HTML формате. Перед адресом использует разделитель $boln, а после адреса -  $eoln.
function tep_address_label($customers_id, $address_id = 1, $html = false, $boln = '', $eoln = "\n");
Возвращает отформатированную строку адреса дя заданного пользователя.
function tep_get_categories($categories_array = '', $parent_id = '0', $indent = '');
Возвращает массив с идентификаторами категорий, и соответствующих им имен категорий. При этом учитывается родительская категория $parent_id
function tep_get_manufacturers($manufacturers_array = '');
Возвращает ассоциативный массив с идентификаторами и соответствующими им именами производителей продаваемых товаров.
function tep_get_subcategories(&$subcategories_array, $parent_id = 0);
В передаваемую переменную $subcategories_array возвращается массив со всеми идентификаторами родительской категории  $parent_id
function tep_date_long($raw_date);
Возвращает  представление  даты  $raw_date заданной в формате YYYY-MM-DD HH:MM:SS. Используется описание длинного формата даты при текущих региональных установках.
function tep_date_short($raw_date);
Возвращает  представление  даты  $raw_date заданной в формате YYYY-MM-DD HH:MM:SS. Используется описание короткого формата даты при текущих региональных установках.
function tep_is_leap_year($year);
Возвращает true если заданный год является высокосным.
function tep_get_parent_categories(&$categories, $categories_id);
Возвращает в $categories все идентификаторы от категории $categories_id до корневой категории.
function tep_get_product_path($products_id);
Функция возвращает строку с полным путем товара по аналогии со строкой для категории  tep_get_path.
function tep_get_uprid($prid, $params);
Возвращает идентификатор товара по заданному массиву аттрибутов. При этом строка используется для передачи параметров товара от одной формы в другую через браузер
function tep_get_prid($uprid);
Возвращает идентификатор товара из строки с стрибутами товара, передаваемой браузером в запросе или строке сдреса.
function tep_customer_greeting();
Возвращает строку приветствия пользователя. Содержит его имя и фамилию.
function tep_mail($to_name, $to_email_address, $email_subject, $email_text, $from_email_name, $from_email_address);
Производит отправку сообщения через электронную почту на имя $to_name с почтовым адресом $to_email_address. В почтовом сообщении задается тема $email_subject и само письмо через  $email_text. Для идентификации отправителя используется имя $from_email_name и адрес $from_email_address.
function tep_has_product_attributes($products_id);
Проверяет, есть ли у товара  аттрибуты.
function tep_word_count($string, $needle);
Функция вовзращает количество слов в строке.
function tep_count_modules($modules = '');
Функция вовзращает количество модуоей магазина
function tep_count_payment_modules();
Функция вовзращает количество платежных модулей
function tep_count_shipping_modules();
Функция возвращает количество модулей доставки.
function tep_create_random_value($length, $type = 'mixed');
Функция возвращает случайное значение заданной длины. При этом используется тип: digits - только цифры, chars - только символы,mixed - цифры и символы
function tep_array_to_string($array, $exclude = '', $equals = '=', $separator = '&');
Возвращает строку с содержимым массива в виде, удобном для URL - при которым ключ и значение массива разделяются символом =, а элементы массива разделяются с помощью &.
function tep_not_null($value);
Возвращает true если заданное значение не нулевое
function tep_display_tax_value($value, $padding = TAX_DECIMAL_PLACES);
Возвращает строку, содержащую значение и количество нулей, соответствующее $padding. Так tep_display_tax_value(10.9,5) выведет 10.90000
function tep_currency_exists($code);
Возвращает true  если существует валюта с заданным кодом.
function tep_string_to_int($string);
Функция вовзращает числовое значение, заданное строкой $string
function tep_parse_category_path($cPath);
Получает в качестве параметра строку, содержащую путь к заданной категории и возвращает массив с идентификаторами родительских категорий для заданной категории.
function tep_rand($min = null, $max = null);
Возвращает случайное число в диапазоне от $min до $max
function tep_setcookie($name, $value = '', $expire = 0, $path = '/', $domain = '', $secure = 0);
Устанавливает значение cookie с заданным именем и значением.
function tep_get_ip_address();
Возвращает IP адрес клиента
function tep_count_customer_orders($id = '', $check_session = true);
Возвращает количество ордеров для заданного клиента.
function tep_count_customer_address_book_entries($id = '', $check_session = true);
Возвращает количество записей в адресной книге для определенного клиента
function tep_convert_linefeeds($from, $to, $string);
Преобразует строку $string, заменяя $from на $to.
function tep_get_products_info($product_id);
Возвращает значение поля products_info для заданного идентификатора продукта.
function tep_get_manufacturers_name($manufacturers_id);
Возвращает имя производителя по его идентификатору.
function tep_get_categories_name($category_id);
Возвращает имя категории по ее идентификатору
function tep_decode_specialchars($string);
Преобразует строку с "безопасным" HTML кодированием в исходную строку.
function tep_output_warning($warning);
Отображает сообщение об ошибке.
function tep_get_languages_id($code);
Возвращает идентификатор языка по заданному коду.
function tep_get_extra_fields($customer_id,$languages_id);
Возвращает форматированную строку с дополнительными параметрами пользователя
function make_alias ($alias)
Возвращает транслитерированное значение строки.