owncloud/core

<?php
/**
 * @author Robin McCorkell <robin@mccorkell.me.uk>
 * @author Vincent Petry <pvince81@owncloud.com>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\Files\External;

use OCP\IUser;
use OCP\Files\Storage;
use OCP\Files\External\IStorageConfig;
use OCP\Files\External\InsufficientDataForMeaningfulAnswerException;
use OCP\Files\StorageNotAvailableException;

/**
 * Trait for objects that can modify IStorageConfigs and wrap Storages
 *
 * When a storage implementation is being prepared for use, the IStorageConfig
 * is passed through manipulateStorageConfig() to update any parameters as
 * necessary. After the storage implementation has been constructed, it is
 * passed through wrapStorage(), potentially replacing the implementation with
 * a wrapped storage that changes its behaviour.
 *
 * Certain configuration options need to be set before the implementation is
 * constructed, while others are retrieved directly from the storage
 * implementation and so need a wrapper to be modified.
 */
trait StorageModifierTrait {
    /**
     * Modify a IStorageConfig parameters
     *
     * @param IStorageConfig $storage
     * @param IUser $user User the storage is being used as
     * @throws InsufficientDataForMeaningfulAnswerException
     * @throws StorageNotAvailableException
     */
    public function manipulateStorageConfig(IStorageConfig &$storage, IUser $user = null) {
    }

    /**
     * Wrap a Storage if necessary
     *
     * @param Storage $storage
     * @return Storage
     * @throws InsufficientDataForMeaningfulAnswerException
     * @throws StorageNotAvailableException
     */
    public function wrapStorage(Storage $storage) {
        return $storage;
    }
}