Получить время жизни кеша Entity::getCacheTtl

Модуль: main — подключать отдельно не нужно

Доступно с версии: 16.5.10

Метод Entity::getCacheTtl возвращает время жизни кеша выборок сущности. Метод ограничивает желаемое время настройками секции cache_flags файла .settings.php. Настройки ниже ограничивают время жизни кеша таблицы b_language от 600 до 3600 секунд.

'cache_flags' => [
    'value' => [
        'b_language_min_ttl' => 600,
        'b_language_max_ttl' => 3600,
    ],
],

Сигнатура метода в классе Bitrix\Main\ORM\Entity:

public function getCacheTtl($ttl)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
ttl* int Задает желаемое время жизни в секундах

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

Возвращаемое значение

Метод возвращает время жизни в секундах.

  • Если DataManager::isCacheable возвращает false, метод возвращает 0.
  • Ключ <таблица>_min_ttl поднимает время до минимума.
  • Ключ <таблица>_max_ttl опускает время до максимума. Максимум важнее минимума, значение 0 выключает кеш таблицы.

Примеры

Пример. Код получает время жизни кеша без ограничений в настройках:

<?php
use Bitrix\Main\Localization\LanguageTable;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

echo LanguageTable::getEntity()->getCacheTtl(3600);

Код выведет 3600.

Смотрите также