Bitrix как найти компонент

Как использовать компонент

Урок
137
из
366

  Видеоурок

В предыдущих уроках мы разобрались, что такое

компонент


Компонент – специальный элемент системы, предназначенный для вывода информации из Базы данных сайта.

Подробнее…

. Система “1С-Битрикс: Управление сайтом” обладает стандартным набором компонентов, которые помогают решить практически все возможные задачи.

  Где найти компоненты?

Мы сказали, что в системе есть стандартный набор компонентов. Где же они находятся? На специальной панели в

визуальном редакторе


Визуальный редактор – инструмент, позволяющий отображать редактируемый текст в точности так

же, как он будет выглядеть на странице, без использования HTML кода.

Подробнее…

, в которой компоненты разделены на группы (например – контент, общение, магазин). Строка поиска чуть ниже поможет вам найти компонент по названию.

  Как разместить компонент на странице?

Просто

переместите






его мышкой в рабочую область слева от списка. Заметьте, что у простых компонентов серая иконка, а у комплексных – зеленая:

Сразу после размещения появится окно настройки компонента. Пока можете его закрыть, мы обратимся к настройке чуть позже.

Если что-то не получается

• Не вижу панели компонентов в визуальном редакторе:
  1. Сначала проверьте, возможно, панель просто скрыта. Раскройте её, нажав на
  
  стрелочку
  
  
  
  
  справа;
  2. Панель компонентов показана только для страниц со
  
  статической информацией
  
  
  Статическая информация – это информация, которая редко меняется с течением времени. Например, рекламные тексты, история компании, контактная информация. Статическая информация создается и редактируется вручную.

  Подробнее…

  
  
  
  . Если вы ее не видите, значит, вы редактируете
  
  Инфоблок
  
  Информационный блок (или Инфоблок) – специальный инструмент “1С-Битрикс: Управление сайтом” с помощью которого заносится информация в Базу данных.
  Подробнее…
  
  
  
  .

• Не могу найти нужный компонент в визуальном редакторе. В этом случае возможны два варианта:
  
  1. либо вы пользуетесь редакцией продукта, в которой отсутствует данный компонент;
  
  2. либо
  
  администратор ограничил
  
  
  Ограничение работает так: если в поле нет ни одного компонента, то разрешены все. Если в поле добавлен хотя бы один компонент, то будет разрешен только он (все остальные запрещены). Иными словами, для запрета доступа к единственному компоненту в это поле нужно внести все компоненты, которые разрешены.

  Подробнее…

  
  
  
  список разрешенных компонентов.

• Я разместил два комплексных компонента, а правильно работает только один из них. Все верно, работать будет только первый комплексный компонент.

  Заключение

Компоненты расположены в визуальном редакторе и добавляются на страницу простым переносом. Однако недостаточно просто разместить компонент, мы должны также настроить его. Об этом поговорим в следующем уроке.

/local/components/example/compsimple #component root directory
├── /lang
|   └── /ru
|       └── .description.php
├── /templates
|   └── /.default
|       └── template.php
├── .description.php
├── .parameters.php
└── class.php

<?php
use BitrixMainLoader;
use BitrixMainApplication;

if (!defined('B_PROLOG_INCLUDED') || B_PROLOG_INCLUDED !== true) die();

class ExampleCompSimple extends CBitrixComponent {
    private $_request;

    /**
     * Проверка наличия модулей требуемых для работы компонента
     * @return bool
     * @throws Exception
     */
    private function _checkModules() {
        if (   !Loader::includeModule('iblock')
            || !Loader::includeModule('sale')
        ) {
            throw new Exception('Не загружены модули необходимые для работы модуля');
        }

        return true;
    }

    /**
     * Обертка над глобальной переменной
     * @return CAllMain|CMain
     */
    private function _app() {
        global $APPLICATION;
        return $APPLICATION;
    }

    /**
     * Обертка над глобальной переменной
     * @return CAllUser|CUser
     */
    private function _user() {
        global $USER;
        return $USER;
    }

    /**
     * Подготовка параметров компонента
     * @param $arParams
     * @return mixed
     */
    public function onPrepareComponentParams($arParams) {
        // тут пишем логику обработки параметров, дополнение параметрами по умолчанию
        // и прочие нужные вещи
        return $arParams;
    }

    /**
     * Точка входа в компонент
     * Должна содержать только последовательность вызовов вспомогательых ф-ий и минимум логики
     * всю логику стараемся разносить по классам и методам 
     */
    public function executeComponent() {
        $this->_checkModules();

        $this->_request = Application::getInstance()->getContext()->getRequest();
        
        // что-то делаем и результаты работы помещаем в arResult, для передачи в шаблон
        $this->arResult['SOME_VAR'] = 'some result data for template';

        $this->includeComponentTemplate();
    }
}

<?if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true) die();

use BitrixMainLocalizationLoc;

$arComponentDescription = [
    "NAME" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT"),
    "DESCRIPTION" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT_DESCRIPTION"),
    "COMPLEX" => "N",
    "PATH" => [
        "ID" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT_PATH_ID"),
        "NAME" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT_PATH_NAME"),
    ],
];
?>

<?if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true) die();

use BitrixMainLocalizationLoc;

$arComponentDescription = [
    "NAME" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT"),
    "DESCRIPTION" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT_DESCRIPTION"),
    "COMPLEX" => "N",
    "PATH" => [
        "ID" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT_PATH_ID"),
        "NAME" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT_PATH_NAME"),
        "CHILD" => [
            "ID" => Loc::getMessage("EXAMPLE_COMPSIMPLE_COMPONENT_CHILD_PATH_ID"),
            "NAME" => GetMessage("EXAMPLE_COMPSIMPLE")
        ]
    ],
];
?>

<?if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true) die();

$MESS["EXAMPLE_COMPSIMPLE_COMPONENT_PATH_ID"] = "local";
$MESS["EXAMPLE_COMPSIMPLE_COMPONENT_CHILD_PATH_ID"] = "compsimplechiltpath";
$MESS["EXAMPLE_COMPSIMPLE_COMPONENT_PATH_NAME"] = "Компоненты проекта";
$MESS["EXAMPLE_COMPSIMPLE"] = "Дочерняя ветка";
$MESS["EXAMPLE_COMPSIMPLE_COMPONENT"] = "Тестовый компонент";
$MESS["EXAMPLE_COMPSIMPLE_COMPONENT_DESCRIPTION"] = "Описание тестового компонента";

<?if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true) die();

/**
 * @var string $componentPath
 * @var string $componentName
 * @var array $arCurrentValues
 * */
 
use BitrixMainLoader;
use BitrixMainLocalizationLoc;

if( !Loader::includeModule("iblock") ) {
    throw new Exception('Не загружены модули необходимые для работы компонента');
}

// типы инфоблоков
$arIBlockType = CIBlockParameters::GetIBlockTypes();

// инфоблоки выбранного типа
$arIBlock = [];
$iblockFilter = !empty($arCurrentValues['IBLOCK_TYPE'])
    ? ['TYPE' => $arCurrentValues['IBLOCK_TYPE'], 'ACTIVE' => 'Y']
    : ['ACTIVE' => 'Y'];

$rsIBlock = CIBlock::GetList(['SORT' => 'ASC'], $iblockFilter);
while ($arr = $rsIBlock->Fetch()) {
    $arIBlock[$arr['ID']] = '['.$arr['ID'].'] '.$arr['NAME'];
}
unset($arr, $rsIBlock, $iblockFilter);

$arComponentParameters = [
    // группы в левой части окна
    "GROUPS" => [
        "SETTINGS" => [
            "NAME" => Loc::getMessage('EXAMPLE_COMPSIMPLE_PROP_SETTINGS'),
            "SORT" => 550,
        ],
    ],
    // поля для ввода параметров в правой части
    "PARAMETERS" => [
        // Произвольный параметр типа СПИСОК
        "IBLOCK_TYPE" => [
            "PARENT" => "SETTINGS",
            "NAME" => Loc::getMessage('EXAMPLE_COMPSIMPLE_PROP_IBLOCK_TYPE'),
            "TYPE" => "LIST",
            "ADDITIONAL_VALUES" => "Y",
            "VALUES" => $arIBlockType,
            "REFRESH" => "Y"
        ],
        "IBLOCK_ID" => [
            "PARENT" => "SETTINGS",
            "NAME" => Loc::getMessage('EXAMPLE_COMPSIMPLE_PROP_IBLOCK_ID'),
            "TYPE" => "LIST",
            "ADDITIONAL_VALUES" => "Y",
            "VALUES" => $arIBlock,
            "REFRESH" => "Y"
        ],
        // Произвольный параметр типа СТРОКА
        "SECTION_IDS" => [
            "PARENT" => "SETTINGS",
            "NAME" => Loc::getMessage('EXAMPLE_COMPSIMPLE_PROP_SECTION_IDS'),
            "TYPE" => "STRING",
            "MULTIPLE" => "N",
            "DEFAULT" => "",
            "COLS" => 25
        ],
        // Настройки кэширования
        'CACHE_TIME' => ['DEFAULT' => 3600],
    ]
];

<?if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true) die();

$MESS["EXAMPLE_COMPSIMPLE_PROP_SETTINGS"] = "Выбор инфоблока и разделов";
$MESS["EXAMPLE_COMPSIMPLE_PROP_IBLOCK_TYPE"] = "Тип инфоблока";
$MESS["EXAMPLE_COMPSIMPLE_PROP_IBLOCK_ID"] = "Инфоблок";
$MESS["EXAMPLE_COMPSIMPLE_PROP_SECTION_IDS"] = "ID разделов через запятую";

<?php if(!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true)die();?>

<?
    BitrixMainDiagDebug::dump($arParams);
    BitrixMainDiagDebug::dump($arResult);
?>