Откуда папки. В самом WordPress папок в медиатеке нет: файлы лежат на диске по годам
* и месяцам, а медиатека показывает их одним списком. Папки добавляет плагин FileBird. Они
* ненастоящие: файл на диске никуда не переезжает и адрес его не меняется, FileBird лишь
* хранит в своих таблицах, какой файл в какой папке. Новый файл он кладёт в папку только
* при загрузке через медиатеку — по папке, открытой на экране. Наш файл скачивает сервер
* магазина, папки в этом запросе нет, и без этого класса он ложился бы в «Без папки».
*
* Правило. Папка изображения товара; если оно не в папке — папка первого фото
* галереи, у которого папка есть. Ни одно фото товара не в папке или FileBird не стоит —
* файл остаётся в «Без папки», как без этого правила.
*
* Чьи папки. В FileBird есть настройка «у каждого пользователя свои папки» — по
* умолчанию она выключена, и папки общие. Когда она включена, у разных сотрудников разное
* дерево папок. Функции FileBird, которые здесь зовутся, сами смотрят на эту настройку
* и работают с папками того, кто сохраняет. Фоновое досохранение (Jobs\Scheduler) делается
* от имени того же человека, поэтому и папка та же.
*
* Функции FileBird — внутренние, не официальные. В новой версии FileBird их могут
* переименовать. Поэтому перед вызовом проверяется, что они есть, а любая ошибка здесь
* только пишется в журнал: сохранение фото в товар от папки не зависит и не срывается
* из-за неё никогда.
*/
final class Media_Folders {
/** Класс FileBird, в котором живут функции папок. */
private const FILEBIRD_FOLDER = 'FileBird\Model\Folder';
/**
* Папка, в которую положить новое фото товара; 0 — класть некуда.
*
* @param int $main_id Изображение товара; 0 — его нет.
* @param int[] $gallery_ids Галерея товара по порядку.
* @return int Id папки FileBird или 0.
*/
public static function folder_for_product( int $main_id, array $gallery_ids ): int {
if ( ! self::available() ) {
return 0;
}
try {
return self::pick( $main_id, $gallery_ids, array( self::class, 'folder_of' ) );
} catch ( \Throwable $error ) {
Logger::warning(
'FileBird folder of the product photos could not be read; the photo goes to the Media Library root',
array(
'main_image' => $main_id,
'gallery' => $gallery_ids,
'error' => $error->getMessage(),
)
);
return 0;
}
}
/**
* Правило выбора папки — без WordPress и без FileBird, чтобы его можно было проверить тестом.
*
* Сначала изображение товара, затем галерея по порядку; берётся первая найденная папка.
*
* @param int $main_id Изображение товара; 0 — его нет.
* @param int[] $gallery_ids Галерея товара по порядку.
* @param callable(int): int $folder_of Папка вложения; 0 — вложение не в папке.
* @return int Id папки или 0.
*/
public static function pick( int $main_id, array $gallery_ids, callable $folder_of ): int {
$candidates = array_merge( array( $main_id ), array_map( 'intval', $gallery_ids ) );
foreach ( $candidates as $attachment_id ) {
if ( $attachment_id <= 0 ) {
continue;
}
$folder_id = (int) $folder_of( $attachment_id );
if ( $folder_id > 0 ) {
return $folder_id;
}
}
return 0;
}
/**
* Кладёт вложение в папку FileBird. Ошибка не срывает сохранение — только пишется в журнал.
*
* @param int $attachment_id Вложение.
* @param int $folder_id Папка из folder_for_product(); 0 — ничего не делать.
* @return void
*/
public static function put( int $attachment_id, int $folder_id ): void {
if ( $folder_id <= 0 || $attachment_id <= 0 || ! self::available() ) {
return;
}
try {
call_user_func( array( self::FILEBIRD_FOLDER, 'setFoldersForPosts' ), $attachment_id, $folder_id );
Logger::info(
'Photo put into the FileBird folder of the product photos',
array(
'attachment_id' => $attachment_id,
'folder_id' => $folder_id,
)
);
} catch ( \Throwable $error ) {
Logger::warning(
'Photo could not be put into the FileBird folder; it stays in the Media Library root',
array(
'attachment_id' => $attachment_id,
'folder_id' => $folder_id,
'error' => $error->getMessage(),
)
);
}
}
/**
* Стоит ли FileBird и есть ли у него нужные функции.
*
* @return bool
*/
private static function available(): bool {
return class_exists( self::FILEBIRD_FOLDER )
&& method_exists( self::FILEBIRD_FOLDER, 'getFolderFromPostId' )
&& method_exists( self::FILEBIRD_FOLDER, 'setFoldersForPosts' );
}
/**
* Папка вложения в дереве того, кто сохраняет; 0 — вложение не в папке.
*
* @param int $attachment_id Вложение.
* @return int Id папки или 0.
*/
private static function folder_of( int $attachment_id ): int {
$rows = call_user_func( array( self::FILEBIRD_FOLDER, 'getFolderFromPostId' ), $attachment_id );
if ( ! is_array( $rows ) ) {
return 0;
}
foreach ( $rows as $row ) {
$folder_id = (int) ( is_object( $row ) ? ( $row->folder_id ?? 0 ) : ( $row['folder_id'] ?? 0 ) );
if ( $folder_id > 0 ) {
return $folder_id;
}
}
return 0;
}
}