Функция cot_getExtensionsWithStructure в Cotonti

Функция cot_getExtensionsWithStructure
Функция cot_getExtensionsWithStructure предназначена для получения списка расширений, которые имеют структуру (например, страницы или категории) в контексте фреймворка Cotonti.

Подробное объяснение работы:

function cot_getExtensionsWithStructure()
{
    static $extensionsWithStructure = [];
    static $loaded = false;

    if ($loaded) {
        return $extensionsWithStructure;
    }

    /* === Hook === */
    foreach (cot_getextplugins('structure.extensions') as $pl) {
        include $pl;
    }
    /* ===== */

    $loaded = true;

    return $extensionsWithStructure;
}

Описание:

Использование статических переменных:

static $extensionsWithStructure = [];
static $loaded = false;

$extensionsWithStructure — это массив, который будет хранить список расширений с структурой. Он инициализируется пустым массивом.

$loaded — логическая переменная, которая контролирует, было ли уже загружено расширение. Она используется, чтобы избежать повторной загрузки расширений при многократных вызовах функции.

Проверка флага загрузки:

if ($loaded) {
    return $extensionsWithStructure;
}

Если переменная $loaded установлена в true, функция сразу возвращает уже загруженный список расширений, не выполняя дальнейшую логику.

Загрузка расширений через плагины:

foreach (cot_getextplugins('structure.extensions') as $pl) {
    include $pl;
}

В этом участке происходит вызов функции cot_getextplugins('structure.extensions'), которая возвращает список всех активных плагинов, связанных с "структурой" расширений.

Каждый найденный плагин подключается с помощью оператора include. Это позволяет динамически загружать код плагинов, которые могут добавлять или изменять информацию о расширениях с структурой.

Фиксация загрузки:

$loaded = true;

После того как плагин был загружен, флаг $loaded устанавливается в true, чтобы избежать повторной загрузки при последующих вызовах функции.

Возврат результата:

return $extensionsWithStructure;

Возвращает массив с кодами расширений, которые имеют структуру.
Что возвращает функция:
Функция возвращает массив, содержащий коды расширений, которые имеют структуру. Например, это могут быть расширения, которые предоставляют функционал для работы с различными видами данных, такими как страницы, категории и другие элементы, требующие структурированного хранения.

Пример использования:

$structurePartUrl = null;
$extensionsWithStructure = cot_getExtensionsWithStructure();
if (in_array($code, $extensionsWithStructure, true)) {
    $structurePartUrl = cot_url('admin', ['m' => 'structure', 'n' => $code]);
}

Допустим, у нас есть несколько расширений, которые добавляют структуру для различных объектов на сайте. В таком случае эта функция поможет нам узнать, какие из расширений предоставляют такую функциональность.

$extensions = cot_getExtensionsWithStructure();
foreach ($extensions as $extension) {
    echo "Extension with structure: $extension\n";
}

Заключение:

Функция cot_getExtensionsWithStructure является частью механизма, который позволяет динамически подключать и получать список расширений, которые обеспечивают структуру для данных в системе. Она использует механизм хуков для подключения плагинов и кеширует результаты, чтобы избежать повторных вычислений, что помогает повысить производительность.