D7-аналоги функций в 1С-Битрикс
Подключение стилей и скриптов
CMain::AddHeadScript , CMain::SetAdditionalCss , CMain::AddHeadString
// Old school
$APPLICATION->AddHeadScript(SITE_TEMPLATE_PATH . "/js/fix.js");
$APPLICATION->SetAdditionalCSS(SITE_TEMPLATE_PATH . "/styles/fix.css");
$APPLICATION->AddHeadString("<link href='http://fonts.googleapis.com/css?family=PT+Sans:400&subset=cyrillic' rel='stylesheet' type='text/css'>");
// D7
use Bitrix\Main\Page\Asset;
Asset::getInstance()->addJs(SITE_TEMPLATE_PATH . "/js/fix.js");
Asset::getInstance()->addCss(SITE_TEMPLATE_PATH . "/styles/fix.css");
Asset::getInstance()->addString("<link href='http://fonts.googleapis.com/css?family=PT+Sans:400&subset=cyrillic' rel='stylesheet' type='text/css'>");Эти методы динамические, а класс реализует паттерн “одиночка” (Singletone) и обратиться к объекту можно через Bitrix\Main\Page\Asset::getInstance() .
Локализация
GetMessage , IncludeModuleLangFile , IncludeTemplateLangFile
// Old school
IncludeTemplateLangFile(__FILE__);
echo GetMessage("INTERVOLGA_TIPS.TITLE");
// D7
use Bitrix\Main\Localization\Loc;
Loc::loadMessages(__FILE__);
echo Loc::getMessage("INTERVOLGA_TIPS.TITLE");
Настройки модулей
COption::SetOptionInt , COption::SetOptionString , COption::GetOptionInt , COption::GetOptionString , COption::RemoveOption
Претерпел изменения и код для работы с чтением и записью настроек модулей. На смену классу COption пришел Bitrix\Main\Config\Option:
// Old school
COption::SetOptionString("main", "max_file_size", "1024");
$size = COption::GetOptionInt("main", "max_file_size");
COption::RemoveOption("main", "max_file_size", "s2");
// D7
use Bitrix\Main\Config\Option;
Option::set("main", "max_file_size", "1024");
$size = Option::get("main", "max_file_size");
Option::delete("main", array(
"name" => "max_file_size",
"site_id" => "s2"
)
);Пропало разделение методов на int и string, а при удалении теперь используется массив-фильтр.
Кеширование
CPHPCache::StartDataCache , CPHPCache::InitCache , CPHPCache::GetVars , CPHPCache::EndDataCache , CPHPCache::AbortDataCache
Новый класс Bitrix\Main\Data\Cache почти ничем не отличается в обращении от старого CPHPCache .
// Old school
$cache = new CPHPCache();
if ($cache->InitCache($cacheTime, $cacheId, $cacheDir))
{
$result = $cache->GetVars();
}
elseif($cache->StartDataCache())
{
$result = array();
// ...
if ($isInvalid)
{
$cache->AbortDataCache();
}
// ...
$cache->EndDataCache($result);
}
// D7
$cache = Bitrix\Main\Data\Cache::createInstance();
if ($cache->initCache($cacheTime, $cacheId, $cacheDir))
{
$result = $cache->getVars();
}
elseif ($cache->startDataCache())
{
$result = array();
// ...
if ($isInvalid)
{
$cache->abortDataCache();
}
// ...
$cache->endDataCache($result);
}
События
AddEventHandler , RemoveEventHandler , RegisterModuleDependences , UnRegisterModuleDependences , GetModuleEvents
За кратко- и долгосрочную регистрацию обработчиков событий отвечает один класс: Bitrix\Main\EventManager .
// Old school
$handler = AddEventHandler("main",
"OnUserLoginExternal",
array(
"Intervolga\\Test\\EventHandlers\\Main",
"onUserLoginExternal"
)
);
RemoveEventHandler(
"main",
"OnUserLoginExternal",
$handler
);
RegisterModuleDependences(
"main",
"OnProlog",
$this->MODULE_ID,
"Intervolga\\Test\\EventHandlers",
"onProlog"
);
UnRegisterModuleDependences(
"main",
"OnProlog",
$this->MODULE_ID,
"Intervolga\\Test\\EventHandlers",
"onProlog"
);
$handlers = GetModuleEvents("main", "OnProlog", true);
// D7
use Bitrix\Main\EventManager;
$handler = EventManager::getInstance()->addEventHandler(
"main",
"OnUserLoginExternal",
array(
"Intervolga\\Test\\EventHandlers\\Main",
"onUserLoginExternal"
)
);
EventManager::getInstance()->removeEventHandler(
"main",
"OnUserLoginExternal",
$handler
);
EventManager::getInstance()->registerEventHandler(
"main",
"OnProlog",
$this->MODULE_ID,
"Intervolga\\Test\\EventHandlers",
"onProlog"
);
EventManager::getInstance()->unRegisterEventHandler(
"main",
"OnProlog",
$this->MODULE_ID,
"Intervolga\\Test\\EventHandlers",
"onProlog"
);
$handlers = EventManager::getInstance()->findEventHandlers("main", "OnProlog");Bitrix\Main\EventManager , так же как Bitrix\Main\Page\Asset , реализует паттерн Одиночка, обращаться к нему нужно через getInstance() .
Важное замечание: в обработчики, зарегистрированные с помощью addEventHandler в качестве аргумента будет передан объект события ( Bitrix\Main\Event ). Если хотите, чтобы передавались старые добрые аргументы, нужно использовать addEventHandlerCompatible . Аналогично с registerEventHandler и registerEventHandlerCompatible .
Файловая структура
CheckDirPath , DeleteDirFilesEx , RewriteFile
Для работы с файлами, папками и всем прочим – отдельные классы, все типизировано и напоминает Java. Самые “главные” классы здесь – Bitrix\Main\IO\Directory и Bitrix\Main\IO\File (ну и немного Bitrix\Main\IO\Path ).
// Old school
CheckDirPath($_SERVER["DOCUMENT_ROOT"] . "/foo/bar/baz/");
RewriteFile(
$_SERVER["DOCUMENT_ROOT"] . "/foo/bar/baz/1.txt",
"hello from old school!"
);
DeleteDirFilesEx("/foo/bar/baz/");
// D7
use Bitrix\Main\Application;
use Bitrix\Main\IO\Directory;
use Bitrix\Main\IO\File;
Directory::createDirectory(
Application::getDocumentRoot() . "/foo/bar/baz/"
);
File::putFileContents(
Application::getDocumentRoot() . "/foo/bar/baz/1.txt",
"hello from D7"
);
Directory::deleteDirectory(
Application::getDocumentRoot() . "/foo/bar/baz/"
);DeleteDirFilesEx принимал путь от корня сайта, а его аналог принимает абсолютный путь к файлу от корня сервера.
Обратите внимание : вместо $_SERVER[«DOCUMENT_ROOT»] сейчас можно использовать Bitrix\Main\Application::getDocumentRoot() .
Исключения
CMain::ThrowException , CMain::ResetException , CMain::GetException
Одним из наиболее существенных изменений в D7 стала обработка ошибок при помощи механизма исключений (полное соблюдение религии исключений в php ). Если происходит ошибка – выбрасываем исключение. Если хотим обработать ошибку – ловим исключение. Базовый класс для всех исключений в системе: Bitrix\Main\SystemException .
// Old school
global $APPLICATION;
$APPLICATION->ResetException();
$APPLICATION->ThrowException("Error");
//...
if ($exception = $APPLICATION->GetException())
{
echo $exception->GetString();
}
// D7
use Bitrix\Main\SystemException;
try
{
// ...
throw new SystemException("Error");
}
catch (SystemException $exception)
{
echo $exception->getMessage();
}
Отладка
// Old school
define("LOG_FILENAME", $_SERVER["DOCUMENT_ROOT"]."/bitrix/log-intervolga.txt");
AddMessage2Log($_SERVER);
echo "<pre>" . mydump($_SERVER) . "</pre>";
// D7
use Bitrix\Main\Diag\Debug;
Debug::dumpToFile($_SERVER);
// or
Debug::writeToFile($_SERVER);
Debug::dump($_SERVER);Первый для любителей var_dump , второй для адептов print_r ’а.
Так же в этом классе есть несколько совершенно новых методов, не имеющих аналогов в старом ядре. Например, методы для измерения времени:
// D7
use Bitrix\Main\Diag\Debug;
Debug::startTimeLabel("foo");
foo();
Debug::endTimeLabel("foo");
Debug::startTimeLabel("bar");
bar();
Debug::endTimeLabel("bar");
print_r(Debug::getTimeLabels());
Почтовые события
CEvent::Send , CEvent::SendImmediate
Отправка почтовых событий претерпела незначительные изменения. Вместо нескольких аргументов, метод теперь принимает ассоциативный массив настроек.
// Old school
CEvent::Send(
"NEW_USER",
"s1",
array(
"EMAIL" => "info@intervolga.ru",
"USER_ID" => 42
)
);
// D7
use Bitrix\Main\Mail\Event;
Event::send(array(
"EVENT_NAME" => "NEW_USER",
"LID" => "s1",
"C_FIELDS" => array(
"EMAIL" => "info@intervolga.ru",
"USER_ID" => 42
),
));
Работа с GET- и POST-параметрами страницы
Чтобы избавиться от глобальных переменных в коде (суперглобальных в том числе) в D7 изобрели класс Bitrix\Main\HttpRequest . Забирать get- и post-переменные теперь можно через него.
// Old school
$name = $_POST["name"];
$email = htmlspecialchars($_GET["email"]);
// D7
use Bitrix\Main\Application;
$request = Application::getInstance()->getContext()->getRequest();
$name = $request->getPost("name");
$email = htmlspecialchars($request->getQuery("email"));Конструировать объект самому не нужно, добраться до него можно через приложение и контекст (как в примере кода выше).
Работа с cookie
CMain::set_cookie , CMain::get_cookie
Класс CMain слишком много себе позволяет. Он и компоненты подключал, и CSS/JS регистрирует, и хлебные крошки собирает, и т.п. В этом разделе мы рассмотрим, куда “сбежали” методы работы с куками. В старом ядре было 2 метода: для создания и для получения кук. Теперь всё стало гораздо глубже: задавать куки нужно через класс “ответа сервера” – Bitrix\Main\HttpResponse , получать их нужно через класс “запроса к серверу” – Bitrix\Main\HttpRequest .
// Old school
global $APPLICATION;
$APPLICATION->set_cookie("TEST", 42, false, "/", "example.com");
// Cookie будет доступна только на следующем хите!
echo $APPLICATION->get_cookie("TEST");
// D7
use Bitrix\Main\Application;
use Bitrix\Main\Web\Cookie;
$cookie = new Cookie("TEST", 42);
$cookie->setDomain("example.com");
Application::getInstance()->getContext()->getResponse()->addCookie($cookie);
// Cookie будет доступна только на следующем хите!
echo Application::getInstance()->getContext()->getRequest()->getCookie("TEST");Также работа с куками может вестись силами класса Bitrix\Main\Web\HttpClient , но это совсем другая история .
Важное замечание: запись куки, добавленной через D7, произойдет только при подключении эпилога (там вызывается метод Bitrix\Main\HttpResponse::flush() )
Работа со ссылками
CMain::GetCurPageParam , DeleteParam
Для работы со ссылками в ядре D7 есть отдельный класс: Bitrix\Main\Web\Uri . Правда, работа с ним не так “компактна”, как с его предшественником. Но это лишь следствие того, что в этом классе соблюдается принцип “1 метод – 1 ответственность”.
// Old school
global $APPLICATION;
$redirect = $APPLICATION->GetCurPageParam("foo=bar", array("baz"));
// D7
use Bitrix\Main\Application;
use Bitrix\Main\Web\Uri;
$request = Application::getInstance()->getContext()->getRequest();
$uriString = $request->getRequestUri();
$uri = new Uri($uriString);
$uri->deleteParams(array("baz"));
$uri->addParams(array("foo" => "bar"));
$redirect = $uri->getUri();
Запросы к БД
Теперь доступ получается не через глобальный объект $DB класса CDatabase , а через Bitrix\Main\DB\Connection . “Добираться” до подключения нужно через Bitrix\Main\Application:
// Old school
global $DB;
$record = $DB->Query("select 1+1;")->Fetch();
AddMessage2Log($record);
// D7
use Bitrix\Main\Application;
use Bitrix\Main\Diag\Debug;
$record = Application::getConnection()
->query("select 1+1;")
->fetch();
Debug::writeToFile($record);
Таблица аналогов старых методов и классов в новом ядре D7 (с примерами вызова)
| Было (старое ядро) | Стало (новое ядро D7) |
| CMain::AddHeadScript | Bitrix\Main\Page\Asset::addJs |
| CMain::SetAdditionalCss | Bitrix\Main\Page\Asset::addCss |
| CMain::AddHeadString | Bitrix\Main\Page\Asset::addString |
| CModule::IncludeModule | Bitrix\Main\Loader::includeModule |
| CModule::IncludeModuleEx | Bitrix\Main\Loader::includeSharewareModule |
| GetMessage | Bitrix\Main\Localization\Loc::getMessage |
| IncludeModuleLangFile , IncludeTemplateLangFile | Bitrix\Main\Localization\Loc::loadMessages |
| COption::SetOptionInt , COption::SetOptionString , | Bitrix\Main\Config\Option::set |
| COption::GetOptionInt , COption::GetOptionString | Bitrix\Main\Config\Option::get |
| COption::RemoveOption | Bitrix\Main\Config\Option::delete |
| CPHPCache::StartDataCache | Bitrix\Main\Data\Cache::startDataCache |
| CPHPCache::InitCache | Bitrix\Main\Data\Cache::initCache |
| CPHPCache::GetVars | Bitrix\Main\Data\Cache::getVars |
| CPHPCache::EndDataCache | Bitrix\Main\Data\Cache::endDataCache |
| CPHPCache::AbortDataCache | Bitrix\Main\Data\Cache::abortDataCache |
| AddEventHandler | Bitrix\Main\EventManager::addEventHandler (новый формат), Bitrix\Main\EventManager::addEventHandlerCompatible |
| RemoveEventHandler | Bitrix\Main\EventManager::removeEventHandler (новый формат), Bitrix\Main\EventManager::registerEventHandlerCompatible |
| RegisterModuleDependences | Bitrix\Main\EventManager::registerEventHandler |
| UnRegisterModuleDependences | Bitrix\Main\EventManager::unRegisterEventHandler |
| GetModuleEvents | Bitrix\Main\EventManager::findEventHandlers |
| CheckDirPath | Bitrix\Main\IO\Directory::createDirectory |
| DeleteDirFilesEx | Bitrix\Main\IO\Directory::deleteDirectory |
| RewriteFile | Bitrix\Main\IO\File::putFileContents |
| CMain::ThrowException | Bitrix\Main\SystemException |
| CMain::ResetException | Bitrix\Main\SystemException |
| CMain::GetException | Bitrix\Main\SystemException |
| AddMessage2Log | Bitrix\Main\Diag\Debug::dumpToFile,
Bitrix\Main\Diag\Debug::writeToFile |
| mydump | Bitrix\Main\Diag\Debug::dump |
| CEvent::Send | Bitrix\Main\Mail\Event::send |
| CEvent::SendImmediate | Bitrix\Main\Mail\Event::sendImmediate |
| $_REQUEST | Bitrix\Main\HttpRequest::get |
| $_GET | Bitrix\Main\HttpRequest::getQuery |
| $_POST | Bitrix\Main\HttpRequest::getPost |
| CMain::set_cookie | Bitrix\Main\HttpResponse::addCookie |
| CMain::get_cookie | Bitrix\Main\HttpRequest::getCookie |
| CMain::GetCurPageParam | Bitrix\Main\Web\Uri::addParams,
Bitrix\Main\Web\Uri::deleteParams, Bitrix\Main\Web\Uri::getUri |
| DeleteParam | Bitrix\Main\Web\Uri::deleteParams,
Bitrix\Main\Web\Uri::getUri |
| CDatabase::Query | Bitrix\Main\DB\Connection::query |
ORM-классы
| Класс в старом ядре | Класс в новом ядре D7 | Таблица БД |
| CUser | Bitrix\Main\UserTable | b_user |
| CFile | Bitrix\Main\FileTable | b_file |
| CGroup | Bitrix\Main\GroupTable | b_group |
| CSite | Bitrix\Main\SiteTable | b_lang |
| CIBlockElement | Bitrix\Iblock\ElementTable | b_iblock_element |
| CIBlock | Bitrix\Iblock\IblockTable | b_iblock |
| CIBlockProperty | Bitrix\Iblock\PropertyTable | b_iblock_property |
| CIBlockSection | Bitrix\Iblock\SectionTable | b_iblock_section |
| CIBlockPropertyEnum | Bitrix\Iblock\PropertyEnumerationTable | b_iblock_property_enum |
| CCatalogStore | Bitrix\Catalog\StoreTable | b_catalog_store |
| CCatalogProduct | Bitrix\Catalog\ProductTable | b_catalog_product |
| CCatalogGroup | Bitrix\Catalog\GroupTable | b_catalog_group |
| CSaleOrder | Bitrix\Sale\Internals\OrderTable | b_sale_order |
| CSaleBasket | Bitrix\Sale\Internals\BasketTable | b_sale_basket |
| CSaleOrderProps | Bitrix\Sale\Internals\OrderPropsTable | b_sale_order_props |
| CSaleOrderPropsValue | Bitrix\Sale\Internals\OrderPropsValueTable | b_sale_order_props_value |
Источник: https://www.intervolga.ru/blog/projects/d7-analogi-lyubimykh-funktsiy-v-1s-bitriks/#section0