modResource.canPreviewResource

Последнее обновление not available | История страницы | Улучшить эту страницу | Сообщить о проблеме

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$194 per month—let's make that $500!

Learn more

modResource.canPreviewResource¶

Проверяет цель предпросмотра до того, как менеджер построит URL предпросмотра. Значение $targetId, чья строковая форма начинается с 0 — само 0 и строки вроде 05 — отклоняется в первую очередь; затем цель загружается, и она не должна быть удалённой. Каждый неудачный путь пишет в журнал ошибок сообщение лексикона resource_err_preview_*; $sourceId только определяет, какое именно сообщение будет записано. Предпросмотр самим собой — когда $sourceId равен $targetId или не передан вовсе — получает собственные записи.

Метод объявлен с типом возврата bool и всегда возвращает логическое значение. В ядре его вызывает только getPreviewUrl().

Синтаксис¶

boolean canPreviewResource (int|string $targetId [, int|string|null $sourceId = null])

$targetId (int|string) ID ресурса, который будут предпросматривать
$sourceId (int|string|null) ID ресурса, с которого запросили предпросмотр, по умолчанию null

Пример¶

$resource = $modx->getObject('modResource', array('id' => 5));
if ($resource->canPreviewResource(5)) {
    $url = $resource->getPreviewUrl();
}

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