Assets cms: Assets | Craft CMS Documentation

Активы

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

Здесь мы в основном сосредоточимся на контексте доставки, так как он представляет основной интерес для разработчиков. См. Управление активами с помощью
Oracle Content Management для получения дополнительной информации об активах с точки зрения управления.

После публикации каждый ресурс доступен как ресурс REST. Вы можете увидеть
адрес к ресурсу в составе свойств актива, которые можно найти в веб-интерфейсе Oracle Content Management.

Описание иллюстрации assets-api-properties.png

Давайте рассмотрим, как выглядит такой ресурс REST в контексте доставки. Во-первых,
URL-адрес доставки имеет определенную форму.

 https://.../content/published/api/v1.1/items/CORE6F39A82DD76F408C8C31F7D8FCB3E8C0?channelToken=1c92cd5b68b245ax87ffb8898ff2fdbd 

• Идентификатор контекста доступа /published указывает, что это
  о доставке опубликованного контента.
• Идентификатор объекта /items указывает, что мы работаем с
  элементы активов (а не другие типы объектов).
• Далее следует идентификатор актива, представляющий собой ряд
  буквы и цифры (например,
  CORE6F39A82DD76F408C8C31F7D8FCB3E8C0 ). У каждого актива есть свой
  уникальный идентификатор.
• В конце находится параметр запроса, channelToken , который является
  идентификатор канала, на котором опубликован этот ресурс. Это контекст
  в котором осуществляется доступ к активу.

Чтобы просмотреть полные данные ответа JSON для актива, нажмите {}
скобки рядом с URL-адресом доставки. Это выглядит примерно так:
Описание иллюстрации json-response-content-type.png

Или в текстовом виде:

 {
  "id": "CORE6F39A82DD76F408C8C31F7D8FCB3E8C0",
  "type": "Пресс-релиз",
  "typeCategory": "ТипКонтента",
  "name": "Сила кофе",
  "description": "Пресс-релиз "Сила кофе" для маркетингового комплекта",
  "slug": "1481786546522-сила-кофе",
  "язык": "en-US",
  «переводимый»: правда,
  "Дата создания": {
    "значение": "2021-03-29T18:33:13.732Z",
    "часовой пояс": "UTC"
  },
  "дата обновления": {
    "значение": "2021-03-29Т23:55:37.057З",
    "часовой пояс": "UTC"
  },
  "поля": {
    "body_text": "\n\rНаш ежегодный сбор средств \"Power of Coffee\" собрал более 1 миллиона долларов, чтобы помочь нуждающимся семьям. Благодаря вашим пожертвованиям в прошлом месяце и доллару Cafe Supremo, мы достигли наших самых высоких показателей за всю историю! Спасибо вам за то, что вы являетесь частью нашего сообщества и отдаете долг нашему сообществу.  Наш ежегодный сбор средств «Сила кофе» собрал более 1 миллиона долларов, чтобы помочь нуждающимся семьям. Благодаря вашим пожертвованиям в прошлом месяце и доллару Cafe Supremo, мы достигли наших самых высоких показателей за всю историю! Спасибо за то, что вы являетесь частью нашего сообщества и делаете вклад в наше сообщество. ",
    "Фото": {
      "id": "CONTA37AC23CE5284C46ACF4D3C3B10A9950",
      "тип": "Цифровой актив",
      "typeCategory": "ЦифровойАссетТип",
      "name": "Кофе в зернах и молотый кофе.jpg",
      "ссылки": [
        {
          "href": "https://.../content/published/api/v1.1/items/CONTA37AC23CE5284C46ACF4D3C3B10A9950?channelToken=1c92bb5b68b245da87ffb8672ff2fddb",
          "отн": "я",
          "метод": "ПОЛУЧИТЬ",
          "mediaType": "приложение/json"
        }
      ]
    },
    "title": "Сила кофе!"
  },
  "ссылки": [
    {
      "href": "https://.../content/published/api/v1.1/items/CORE6F39A82DD76F408C8C31F7D8FCB3E8C0?channelToken=1c92bb5b68b245da87ffb8672ff2fddb",
      "отн": "я",
      "метод": "ПОЛУЧИТЬ",
      "mediaType": "приложение/json"
    },
    {
      "href": "https://. ../content/published/api/v1.1/items/CORE6F39A82DD76F408C8C31F7D8FCB3E8C0?channelToken=1c92bb5b68b245da87ffb8672ff2fddb",
      "отн": "канонический",
      "метод": "ПОЛУЧИТЬ",
      "mediaType": "приложение/json"
    },
    {
      "href": "https://.../content/published/api/v1.1/metadata-catalog/items/CORE6F39A82DD76F408C8C31F7D8FCB3E8C0?channelToken=1c92bb5b68b245da87ffb8672ff2fddb",
      "rel": "описано",
      "метод": "ПОЛУЧИТЬ",
      "mediaType": "приложение/схема+json"
    }
  ]
}
 

Данные JSON соответствуют различным полям метаданных актива в Oracle Content Management:

Описание иллюстрации json-response-diagram.png

Все поля, выделенные зеленым, являются стандартными; они присутствуют в каждом активе.
Одним из таких стандартных полей является уникальный идентификатор (id) актива. Другой стандарт
поля — это свойства активов, такие как тип, имя, описание, слаг, язык,
статус переводимости (переводимо), а также даты создания и обновления
(Дата создания и Дата обновления).

Дочерний узел «поля» содержит все пользовательские значения полей, такие как заголовок,
тело, фотография или что-то еще, что было указано в определении типа актива.

Глядя на поле «фотография» в приведенном выше примере, вы можете заметить, что это
выглядит немного иначе. Это потому, что это поле ссылки. Они не содержат
полный набор данных для актива, а только идентификатор, имя, тип и ссылка на
актив. На самом деле любое медиа-поле (тип данных для поля «фото») на самом деле является
справочное поле за кулисами. Это ссылка на нестандартный тип, называемый
DigitalAsset (именно поэтому «введите» под полем с фотографией написано «DigitalAsset»).

Теперь предположим, что у вас есть элемент содержимого «Статья» с полем ссылки «автор», и вы
хотите получить доступ ко всему полю автора вместе со статьей без необходимости нести
дополнительные сетевые вызовы. Вы можете легко сделать это, просто добавив
expand=fields.author в качестве параметра запроса и поле автора
расширяется внутри ответа статьи JSON.

Активы | Документация Craft CMS

Вы можете управлять файлами мультимедиа и документов («активами») вашего проекта в Craft так же, как записями и другими типами контента .

Volumes

Все ваши активы хранятся в «томах». Тома — это контейнеры для хранения. Том может быть каталогом на веб-сервере или удаленным хранилищем, например Amazon S3.

Вы можете управлять томами вашего проекта из Настройки → Активы .

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

Базовые URL-адреса томов могут быть установлены в переменной среды или начинаться с псевдонима. См. Конфигурация среды, чтобы узнать больше об этом.

Локальные тома

По умолчанию вы можете создать один тип тома — «Локальный». Локальные тома представляют собой каталог на локальном веб-сервере.

Локальные тома имеют одну настройку: Путь к файловой системе . Используйте этот параметр, чтобы указать путь к корневому каталогу тома на сервере.

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

Обратите внимание, что Craft/PHP должен иметь возможность записи в созданный вами каталог.

Удаленные тома

Если вы предпочитаете хранить свои активы в службе удаленного хранения, такой как Amazon S3, вы можете установить подключаемый модуль, обеспечивающий интеграцию.

• Amazon S3 (открывается в новом окне) (собственный)
• Google Cloud Storage (открывается в новом окне) (собственный)
• Rackspace Cloud Files (открывается в новом окне) (собственный)
• DigitalOcean Spaces (открывается в новом окне) ) (Værsågod)
• fortrabbit Object Storage (opens new window) (fortrabbit)

Пользовательские поля активов

Каждый из ваших томов имеет макет полей, где вы можете установить поля, которые будут доступны для активов в этом томе. Вы можете изменить макет поля тома, щелкнув вкладку Макет поля при редактировании тома.

Любые выбранные здесь поля будут видны в HUD редактора ресурсов, который открывается при двойном щелчке по активу (либо на странице «Активы», либо в полях «Активы»).

Страница активов

Когда вы создаете свой первый том, Элемент Assets будет добавлен в навигацию основной панели управления. Нажав на нее, вы перейдете на страницу «Активы», где на левой боковой панели показан список всех ваших томов, а файлы выбранного тома — в области основного содержимого.

На этой странице вы можете делать следующее:

• Загружать новые файлы
• Переименовывать файлы
• Редактировать заголовки и имена файлов
• Запускать редактор изображений для выбранного изображения
• Управление подпапками
• Переместить файлы в другой том или подпапку (с помощью перетаскивания)
• Удалить файлы

Управление вложенными папками

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

Создав подпапку, вы можете начать перетаскивать в нее файлы.

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

Вы можете переименовать вложенную папку, щелкнув правой кнопкой мыши вложенную папку на левой боковой панели и выбрав Переименовать папку .

Вы можете удалить вложенную папку (и все ресурсы в ней), щелкнув правой кнопкой мыши вложенную папку на левой боковой панели и выбрав Удалить папку .

Обновление индексов активов

Если какие-либо файлы когда-либо будут добавлены, изменены или удалены за пределами Craft (например, по FTP), вам потребуется указать Craft обновить свои индексы для тома. Вы можете сделать это с Коммунальные услуги → Индексы активов .

У вас будет возможность кэшировать удаленные изображения. Если у вас нет удаленных томов (Amazon S3 и т. д.), вы можете спокойно игнорировать это. Включение этого параметра приведет к тому, что процесс индексации займет больше времени, но улучшит скорость создания преобразования изображения.

Преобразование изображений

Craft позволяет выполнять различные преобразования изображений для ваших ресурсов. См. Преобразование изображения для получения дополнительной информации.

Редактор изображений

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

Чтобы запустить Редактор изображений, дважды щелкните изображение (либо на странице Активы, либо в поле Активы) и нажмите Редактировать в правом верхнем углу области предварительного просмотра изображения в HUD. Кроме того, вы можете выбрать актив на странице «Активы» и выбрать «Редактировать изображение » в меню задач (

Значок шестеренки

).

Фокусные точки

Установите фокусные точки на ваших изображениях, чтобы Craft знал, какой части изображения отдавать приоритет при определении того, как обрезать ваши изображения для преобразования изображения. Фокусные точки имеют приоритет над параметром «Положение обрезки» трансформации.

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

Чтобы удалить точку фокусировки, снова нажмите кнопку «Точка фокусировки».

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

Запрос ресурсов

Вы можете получить ресурсы в своих шаблонах или коде PHP, используя запросов ресурсов .

• Twig
• PHP

Создав запрос актива, вы можете установить для него параметры, чтобы сузить результаты, а затем выполнить его, вызвав . все() . Будет возвращен массив объектов Asset (opens new window).

См. раздел Запросы элементов, чтобы узнать, как работают запросы элементов.

Пример

Мы можем отобразить список эскизов изображений в томе «Фотографии», выполнив следующие действия:

1. Создайте запрос актива с помощью craft.assets() .
2. Установите на нем параметры Volume и Kind.
3. Получить активы с помощью .all() .
4. Прокрутите ресурсы, используя тег for (открывает новое окно), чтобы создать HTML-список эскизов.

При использовании assets.url или assets.getUrl() исходный том актива должен иметь включенный параметр «Активы в этом томе имеют общедоступные URL-адреса» и настройку «Базовый URL». В противном случае результат всегда будет пустым.

Вы можете автоматически очищать URL-адреса активов из кэша, включив параметр конфигурации revAssetUrls, или обрабатывать их по отдельности, используя функцию url() Craft, чтобы добавить параметр запроса с отметкой времени последнего изменения:

Параметры

Запросы ресурсов поддерживают следующие параметры:

Параметр	Описание
afterPopulate	Выполняет любую обработку элементов после заполнения.
andRelatedTo	Ограничивает результаты запроса только теми активами, которые связаны с определенными другими элементами.
anyStatus	Удаляет фильтры элементов на основе их статусов.
asArray	Заставляет запрос возвращать соответствующие активы в виде массивов данных, а не объектов Asset (opens new window).
кэш	Включает кэш запросов для этого запроса.
clearCachedResult	Очищает кэшированный результат (открывает новое окно).
dateCreated	Сужение результатов запроса на основе дат создания объектов.
dateModified	Сужение результатов запроса на основе дат последнего изменения файлов ресурсов.
dateUpdated	Сужает результаты запроса на основе дат последнего обновления объектов.
имя файла	Сужение результатов запроса на основе имен файлов ресурсов.
fixedOrder	Заставляет результаты запроса возвращаться в порядке, указанном идентификатором.
folderId	Сужает результаты запроса на основе папок, которым принадлежат ресурсы, по идентификаторам папок.
folderPath	Сужает результаты запроса на основе папок, к которым принадлежат ресурсы, по путям к папкам.
height	Сужает результаты запроса на основе высоты изображения объектов.
id	Сужение результатов запроса на основе идентификаторов активов.
ignorePlaceholders	Заставляет запрос возвращать совпадающие активы, поскольку они хранятся в базе данных, игнорируя совпадающие элементы-заполнители, которые были установлены craft\services\Elements::setPlaceholderElement() (открывает новое окно).
inReverse	Заставляет результаты запроса возвращаться в обратном порядке.
includeSubfolders	Расширяет результаты запроса, чтобы включить активы из любой из подпапок папки, заданной идентификатором папки.
вид	Сужение результатов запроса на основе типов файлов ресурсов.
limit	Определяет количество активов, которые должны быть возвращены.
offset	Определяет, сколько ресурсов должно быть пропущено в результатах.
orderBy	Определяет порядок, в котором должны быть возвращены активы. (Если пусто, по умолчанию используется dateCreated DESC .) запрос элементов с несколькими сайтами.
relatedTo	Сужает результаты запроса до тех объектов, которые связаны с некоторыми другими элементами.
поиск	Сужает результаты запроса до тех ресурсов, которые соответствуют поисковому запросу.
сайт	Определяет сайты, на которых следует запрашивать активы.
siteSettingsId	Сужает результаты запроса на основе идентификаторов активов в таблице elements_sites .
размер	Сужение результатов запроса на основе размеров файлов ресурсов (в байтах).
название	Сужает результаты запроса на основе названий активов.
в корзину	Ограничивает результаты запроса только объектами, которые были обратимо удалены.
uid	Сужение результатов запроса на основе UID активов.
unique	Определяет, должны ли быть возвращены по запросу только элементы с уникальными идентификаторами.
загрузчик	Сужает результаты запроса на основе пользователя, которым были загружены ресурсы, в соответствии с идентификаторами пользователя.
том	Сужает результаты запроса на основе тома, к которому принадлежат активы.
volumeId	Сужение результатов запроса на основе томов, к которым принадлежат активы, по идентификаторам томов.
ширина	Сужение результатов запроса на основе ширины изображений ресурсов.
с	Заставляет запрос возвращать соответствующие ресурсы, загруженные связанными элементами.
withTransforms	Заставляет запрос возвращать соответствующие активы, предварительно загруженные индексами преобразования изображений.

afterPopulate

Выполняет любую обработку элементов после заполнения.

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

См. Отношения (открывается в новом окне) для полного объяснения того, как работать с этим параметром.

• Twig
• PHP

anyStatus

Удаляет фильтры элементов на основе их статусов.

• Twig
• PHP

asArray

Заставляет запрос возвращать соответствующие ресурсы в виде массивов данных, а не объектов Asset (opens new window).

• Ветка
• PHP

кеш

Включает кэш запросов для этого запроса.

clearCachedResult

Очищает кэшированный результат (открывает новое окно).

dateCreated

Сужает результаты запроса на основе дат создания объектов.

Возможные значения включают в себя:

• Twig
• PHP

dateModified

Сужение результатов запроса на основе дат последнего изменения файлов ресурсов.

Возможные значения:

Значение	Извлекает активы…
'>= 2018-04-01'	, которые были изменены после 10. 1-0-04	, которые были изменены
'< 01.05.2018'	которые были изменены до 01.05.2018
['and', '>= 2018-04-0 -01']	, которые были изменены между 01 апреля 2018 г. и 01 мая 2018 г.

• Twig
• PHP

dateUpdated

Сужение результатов запроса на основе дат последнего обновления ресурсов.

Возможные значения включают в себя:

• Twig
• PHP

имя файла

Сужение результатов запроса на основе имен файлов ресурсов.

Возможные значения:

• Twig
• PHP

fixedOrder

Заставляет результаты запроса возвращаться в порядке, указанном идентификатором.

Если в id не было передано ни одного идентификатора, установка значения true приведет к пустому результирующему набору.

• Twig
• PHP

folderId

Сужает результаты запроса на основе папок, которым принадлежат активы, в соответствии с идентификаторами папок.

Возможные значения:

1

99999999999999999999999999999999994994994994994994994999949949949949949949949949949949949949949949949949949949949949949949999999999499999999999999999999499999999999999999999999999ня. ['not', 1, 2]

• Twig
• PHP

Это можно комбинировать с includeSubfolders, если вы хотите включить ресурсы во всех подпапках определенной папки.

folderPath

Сужает результаты запроса на основе папок, к которым принадлежат ресурсы, в соответствии с путями к папкам.

Возможные значения включают в себя:

• Ветка
• PHP

высота

Сужает результаты запроса на основе высоты изображения объектов.

Possible values ​​include:

• Twig
• PHP

id

Сужение результатов запроса на основе идентификаторов активов.

Возможные значения включают в себя:

40019 1

40019 1

• TWIG
• 18181924

  9249249249249241924100

4100

100