nc_file_path ( int $class_id, int $message_id, mixed $field_name [, string $file_name_prefix [, bool $preview]] )
функция позволяет получить путь к файлу, указанному в определенном поле, по номеру (ID) этого объекта и номеру (ID) компонента, которому он принадлежит
Параметры | Описание |
---|---|
$class_id | номер компонента (для системных таблиц – название таблицы, допустимые значения – “Catalogue”, “Subdivision”, “User”, “Template”) |
$message_id | номер объекта |
$field_name | название поля или его идентификатор в компоненте |
$file_name_prefix (опционально) |
укажите “h_”, если хотите получить ссылку для скачивания файла
под оригинальным именем (подробнее см. в разделе «Файловая
система» настоящего руководства), или если нужно получить объект для получения ссылки на обработанное изображение (при любом типе файловой системы) |
$preview (опционально) | Если передать true, то вернет ссылку на превью файла |
Будьте внимательны, не путайте номера компонента и номер компонента в разделе (инфоблока). Номер компонента вы можете узнать, например, в разделе «Список компонентов» системы администрирования.
Если в указанном поле файл не был закачан, функция возвращает NULL. При неправильно указанном имени или идентификаторе поля функция сообщит об ошибке и вернет NULL.
Если указано значение аргумента $file_name_prefix
, при наличии файла или в режиме редактирования
будет возвращён объект — экземпляр класса для получения ссылки
на преобразованное изображение (если файла нет, то в режиме просмотра будет возвращён NULL).
При приведении этого объекта к строке без
вызова методов преобразования изображений получится путь для скачивания исходного файла.
Путь к файлу на диске в поле “Pic” объекта номер 100 в шаблоне 2:
<?= $DOCUMENT_ROOT.nc_file_path(2, 100, 'Pic')?>
Если поле “Pic” в компоненте номер 2 имеет идентификатор 84, то следующий пример аналогичен предыдущему:
<?= $DOCUMENT_ROOT.nc_file_path(2, 100, 84)?>
Ссылка для скачивания файла, указанного в поле “ForumAvatar” у пользователя с идентификатором 5:
<img src="<?= nc_file_path('User', 5, 'ForumAvatar', 'h_')?> />