diecoding\flysystem\WebDavComponent

Complexity

Total Complexity

5

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	7	1
A	initAdapter()	0	12	4

<?php

namespace diecoding\flysystem;

use diecoding\flysystem\adapter\WebDAVAdapter;
use Sabre\DAV\Client;
use yii\base\InvalidConfigException;

/**
 * Interacting with an WebDAV filesystem
 * ! Notice
 * It's important to know this adapter does not fully comply with the adapter contract. The difference(s) is/are:
 * - Visibility setting or retrieving is not supported.
 * - TemporaryUrl setting or retrieving equal to PublicUrl.
 * @see https://flysystem.thephpleague.com/docs/adapter/webdav/
 * 
 * ```php
 * 'components' => [
 *     'fs' => [
 *         'class' => \diecoding\flysystem\WebDavComponent::class,
 *         'baseUri' => 'http://your-webdav-server.org/',
 *         'userName' => 'your_user',
 *         'password' => 'superSecret1234',
 *         // 'proxy' => '',
 *         // 'authType' => \Sabre\DAV\Client::AUTH_BASIC,
 *         // 'encoding' => \Sabre\DAV\Client::ENCODING_IDENTITY,
 *         // 'prefix' => '',
 *     ],
 * ],
 * ```
 * 
 * @link      https://sugengsulistiyawan.my.id/
 * @author    Sugeng Sulistiyawan <sugeng.sulistiyawan@gmail.com>
 * @copyright Copyright (c) 2023
 */
class WebDavComponent extends AbstractComponent
{
    /**
     * @var string
     */
    public $baseUri;

    /**
     * @var string
     */
    public $userName;

    /**
     * @var string
     */
    public $password;

    /**
     * @var mixed
     */
    public $proxy;

    /**
     *  authType must be a bitmap, using Client::AUTH_BASIC, Client::AUTH_DIGEST
     *  and Client::AUTH_NTLM. If you know which authentication method will be
     *  used, it's recommended to set it, as it will save a great deal of
     *  requests to 'discover' this information.
     * 
     * @var int
     */
    public $authType;

    /**
     * Encoding is a bitmap with one of the ENCODING constants.
     * 
     * @var int
     */
    public $encoding;

    /**
     * @var Client
     */
    protected $client;

    /**
     * @var string[]
     */
    protected $_availableOptions = [
        'baseUri',
        'userName',
        'password',
        'proxy',
        'authType',
        'encoding',
    ];

    /**
     * @inheritdoc
     * @throws InvalidConfigException
     */
    public function init()
    {
        $this->validateProperties([
            'baseUri',
        ]);

        parent::init();
    }

    /**
     * @return WebDAVAdapter
     */
    protected function initAdapter()
    {
        $config = [];
        foreach ($this->_availableOptions as $property) {
            if ($this->$property !== null) {
                $config[$property] = $this->$property;
            }
        }

        $this->client = new Client($config);

        return new WebDAVAdapter($this->client, (string) $this->prefix, $this->debug ? WebDAVAdapter::ON_VISIBILITY_THROW_ERROR : WebDAVAdapter::ON_VISIBILITY_IGNORE);
    }
}