Первая публикация из серии статей для разработчиков модулей/шаблонов под OpenCart. Эта часть содержит описание основных функций библиотек.
Описание функций основных классов
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
// Cache Кэш $this->cache->set($key, $value); // Внесение данных в кэш $this->cache->get($key); // Получение данных из кэша $this->cache->delete($key); // Удаление данных из кэша // Cart Корзина $this->cart->getProducts(); //Получает все товары находящиеся в корзине учитывая опции, акции. $this->cart->add( $product_id, $qty = 1, $options = array()); // Добавление товара в корзину $this->cart->remove( $key ); // Удаление товара из корзины $this->cart->clear(); // Очистка корзины $this->cart->getWeight(); // Получение веса всей корзины $this->cart->getSubTotal(); // Получение суммы цен элементов корзины без вычета налогов $this->cart->getTotal(); // Получение суммы цен элементов корзины с вычетом налогов $this->cart->countProducts(); // Получение количества товаров в корзине $this->cart->hasProducts(); // Проверяет пуста корзина или нет $this->cart->hasStock(); // Возвращает false, если хотя бы один элемент корзины отсутствует на складе(в продаже) $this->cart->hasShipping(); // Возвращает true, если хотя бы один элемент корзины требует доставку $this->cart->hasDownload(); // Возвращает true, если хотя бы один элемент корзины связан с какой-либо загрузкой // Config Настройки $this->config->get($key); // Возвращает значение настройки $this->config->set($key, $value); // Устанавливает значение настройки (Не сохраняется в базе данных) // Currency Валюта $this->currency->set($currency); // Устанавливает код валюты, который будет использоваться в сессии $this->currency->format($number, $currency = '', $value = '', $format = TRUE); // "format" валюты $this->currency->convert($value, $from, $to); // Конвертирует значение одной валюты в другую $this->currency->getId(); // Возвращает ID текущей валюты (1, 2, 3, 4) $this->currency->getCode(); // Возвращает код текущей валюты (USD, EUR, GBP, AUD, etc) $this->currency->getValue($currency); // Возвращает текущий курс для указанной валюты $this->currency->has($currency) // Проверяет существует ли указанная валюта // Customer Клиент $this->customer->login($email, $password); //Авторизация $this->customer->logout(); // Выход $this->customer->isLogged(); // Проверяет авторизован клиент или нет $this->customer->getId(); // Получает ID клиента $this->customer->getFirstName(); // Получает первое имя клиента $this->customer->getLastName(); // Получает второе имя клиента $this->customer->getEmail(); // Получает Email ользователя $this->customer->getTelephone(); // Получает номер телефона клиента $this->customer->getFax(); // Получает факс клиента $this->customer->getNewsletter(); // Получает подписку клиента $this->customer->getCustomerGroupId(); // Получает ID группы клиента $this->customer->getAddressId(); // Получает ID адреса пользователя // DB База данных $this->db->query($sql); //Выполняет SQL запрос $this->db->escape($value); // Слеширует данные перед внесением в базу данных $this->db->countAffected($sql); // Возвращает кол-во затронутых запросом строк $this->db->getLastId($sql); //Возвращает значение последнего auto_increment поля // Document Документ $this->document->setTitle($title); // Устанавливает title страницы $this->document->getTitle(); // Возвращает title страницы $this->document->setDescription($description); // Устанавливает description $this->document->getDescription(); // Возвращает description $this->document->setKeywords(); // Устанавливает keywords $this->document->getKeywords(); // Возвращает keywords $this->document->setBase($base); // Устанавливает базовую ссылку $this->document->getBase(); // Возвращает базовую ссылку $this->document->setCharset($charset); // Устанавливает charset страницы $this->document->getCharset(); Возвращает charset страницы $this->document->setLanguage($language); // Устанавливает язык страницы $this->document->getLanguage(); // Возвращает язык страницы $this->document->setDirection($direction); // Устанавливает направление текста страницы (rtl/ltr) $this->document->getDirection(); // Возвращает направление текста страницы (rtl/ltr) $this->document->addLink( $href, $rel ); // Добавляет тег <link> $this->document->getLinks(); // Возвращает массив тегов <link> $this->document->addStyle( $href, $rel = 'stylesheet', $media = 'screen' ); // Добавляет стиль $this->document->getStyles(); // Возвращает массив стилей $this->document->addScript( $script ); // Добавляет скрипт $this->document->getScripts(); // Возвращает массив скриптов $this->document->addBreadcrumb($text, $href, $separator = ' > '); // Добавляет хлебные крошки в массив $this->document->getBreadcrumbs(); // Возвращает хлебные крошки // Encryption Шифрование $this->encryption->encrypt($value); // Шифрует строку на основе ключа, установленного в административной панели. $this->encryption->decrypt($value); // Дешифрует строку // JSON $this->json->encode( $data ); // Шифрует данные в формат JSON $this->json->decode( $data , $assoc = FALSE); // Дешифрует данные из формата JSON // Language Язык $this->language->load($filename); // Загрузка языка $this->language->get($key); // Возвращает значение языковой переменный текущего языка // Lenght Длина $this->length->convert($value, $from, $to); // Конвертирует длину из одной системы в другую $this->length->format($value, $unit, $decimal_point = '.', $thousand_point = ','); // Форматирует вывод длины // Log Лог $this->log->write($message); // Записывает сообщение в лог // Request Запрос $this->request->clean($data); // Очищает поступившие данные для предотвращения XSS $this->request->get['x'] = $_GET['x'] $this->request->post['x'] = $_POST['x'] // Response Ответ $this->response->addHeader($header); // Добавляет header $this->response->redirect($url); // Перенаправляет на $url // Session Сессия $this->session->data['x'] = $_SESSION['x'] |