src/CloudMailRuInterface.php - master - SerjPopov/cloud-mail-ru-php

src/CloudMailRuInterface.php

75 строк3 KB

biodata

Исправлено получение токена. Обновлена библиотека Guzzle. Обновлен docker контейнер. Протестировано на PHP 8.2.

03 фев 2024, 20:16

03 фев 2024, 20:16605acc0

<?php

namespace SergPopov\CloudMailRu;

interface CloudMailRuInterface
{
    /**
     * Authorization in the cloud.
     * This method must be performed at the beginning of working with the cloud.
     * @return CloudMailRu
     * @throws CloudMailRuException
     */
    public function login(): CloudMailRu;

    /**
     * Getting a list of directories and files in a specified directory.
     * @param string $pathOnCloud
     * @return array An array describing the contents of the directory.
     *  [
     *      'folders' => [
     *              'folder1',
     *              'folder2',
     *          ],
     *      'files' => [
     *              'file1.txt',
     *              'file2.jpg',
     *          ],
     *  ];
     * @throws CloudMailRuException
     */
    public function folderList(string $pathOnCloud): array;

    /**
     * Adding a directory to the cloud.
     * If nonexistent directories are present in the path, they will be created.
     * @param string $pathFolderOnCloud Full path of the created directory in the cloud.
     *                                  '/' - root directory.
     * @return CloudMailRu
     * @throws CloudMailRuException
     */
    public function folderAdd(string $pathFolderOnCloud): CloudMailRu;

    /**
     * Uploading a file to the cloud.
     * If nonexistent directories are present in the path, they will be created.
     * If a file with the same name already exists in the cloud,
     * then the new file will NOT be replaced,
     * and an exception will NOT be thrown.
     * @param string $pathLocalFile Path in the filesystem to the downloaded file.
     * @param string $pathFileOnCloud Full path to the file in the cloud.
     *                                '/' - root directory.
     * @return CloudMailRu
     * @throws CloudMailRuException
     */
    public function fileUpload(string $pathLocalFile, string $pathFileOnCloud): CloudMailRu;

    /**
     * Deleting a file from the cloud.
     * @param string $pathOnCloud Full path to the file in the cloud.
     *                            '/' - root directory.
     * @return CloudMailRu
     * @throws CloudMailRuException
     */
    public function fileRemove(string $pathOnCloud): CloudMailRu;

    /**
     * Obtaining a public link for downloading a file by any unauthorized user.
     * Example URL: https://cloud.mail.ru/public/5gww/3RUS5aTTT
     * @param string $pathOnCloud Full path to the file in the cloud.
     *                            '/' - root directory.
     * @return string
     * @throws CloudMailRuException
     */
    public function filePublish(string $pathOnCloud): string;
}