partner-it / b2-php

src/B2Client.php

Doc Comments +8 added lines, -4 removed lines

@@ -95,8 +95,8 @@ 
     }
 
     /**
-     * @param $endpoint
-     * @param $method
+     * @param string $endpoint
+     * @param string $method
      * @param array $data
      * @return mixed
      * @throws \Exception
@@ -132,7 +132,7 @@ 
     /**
      * @param $uri
      * @param string $method
-     * @param array $headers
+     * @param string[] $headers
      * @param null $body
      * @return B2Response
      */
@@ -182,9 +182,12 @@ 
     /**
      * @param $data
      * @param $sha1
-     * @param $fileName
+     * @param string $fileName
      * @param $url
      * @param $token
+     * @param string $fileData
+     * @param string $fileDataSha1
+     * @param string $contentType
      */
     public function uploadData($fileData, $fileDataSha1, $fileName, $contentType, $uploadUrl, $uploadToken)
     {
@@ -200,6 +203,7 @@ 
 
     /**
      * @param $url
+     * @param string $uri
      */
     public function downloadFileByName($uri)
     {

Indentation +216 added lines, -216 removed lines

@@ -8,221 +8,221 @@
 class B2Client
 {
 
-    /**
-     * @var string
-     */
-    protected $accountId;
-
-    /**
-     * @var string
-     */
-    protected $applicationKey;
-
-    /**
-     * @var string
-     */
-    protected $apiUrl;
-
-    /**
-     * @var string
-     */
-    protected $authorizationToken;
-
-    /**
-     * @var string
-     */
-    protected $downloadUrl;
-
-    /**
-     * @var CurlRequest
-     */
-    protected $CurlRequest;
-
-    /**
-     * @var Files
-     */
-    public $Files;
-
-
-    /**
-     * B2Client constructor.
-     * @param string $accountId
-     * @param string $applicationKey
-     */
-    public function __construct($accountId, $applicationKey, CurlRequest $curlRequest = null)
-    {
-
-        if (!$curlRequest) {
-            $this->CurlRequest = new CurlRequest();
-        } else {
-            $this->CurlRequest = $curlRequest;
-        }
-
-        $this->accountId      = $accountId;
-        $this->applicationKey = $applicationKey;
-        $this->Files          = new Files($this);
-
-    }
-
-    /**
-     * @param array $result
-     */
-    public function setToken($result)
-    {
-        $this->authorizationToken = $result['authorizationToken'];
-        $this->apiUrl             = $result['apiUrl'];
-        $this->downloadUrl        = $result['downloadUrl'];
-    }
-
-    /**
-     *
-     */
-    public function requestToken()
-    {
-
-        $response = $this->curl('https://api.backblaze.com/b2api/v1/b2_authorize_account', 'GET', [
-            $this->buildBasicAuthHeader()
-        ]);
-
-        $data = $response->getJsonData();
-        if ($response->getStatusCode() === 200) {
-            $this->setToken($data);
-            return true;
-        } else {
-            throw new \RuntimeException('Failed to get token: ' . $data['message']);
-        }
-
-    }
-
-    /**
-     * @param $endpoint
-     * @param $method
-     * @param array $data
-     * @return mixed
-     * @throws \Exception
-     */
-    public function call($endpoint, $method, $data = [])
-    {
-
-        if (empty($this->authorizationToken)) {
-            throw new \Exception('You must set or generate a token');
-        }
-
-        $headers = [
-            $this->buildTokenAuthHeader()
-        ];
-
-        $headers[] = 'Content-Type: application/json';
-        $headers[] = "Accept: application/json";
-        $body      = json_encode($data);
-
-        $response = $this->curl($this->apiUrl . '/b2api/v1/' . $endpoint, $method, $headers, $body);
-
-        if ($response->getStatusCode() >= 200 && $response->getStatusCode() < 300) {
-            return $response->getJsonData();
-        }
-
-        if ($response->getStatusCode() >= 400) {
-            $data = $response->getJsonData();
-            throw new \RuntimeException('Error ' . $response->getStatusCode() . ' - ' . $data['message']);
-        }
-
-    }
-
-    /**
-     * @param $uri
-     * @param string $method
-     * @param array $headers
-     * @param null $body
-     * @return B2Response
-     */
-    public function curl($uri, $method = 'GET', $headers = [], $body = null)
-    {
-
-        $response = new B2Response();
-
-        $this->CurlRequest->setOption(CURLOPT_URL, $uri);
-        $this->CurlRequest->setOption(CURLOPT_CUSTOMREQUEST, $method);
-        $this->CurlRequest->setOption(CURLOPT_RETURNTRANSFER, 1);
-        $this->CurlRequest->setOption(CURLOPT_POST, 1);
-        $this->CurlRequest->setOption(CURLOPT_POSTFIELDS, $body);
-        $this->CurlRequest->setOption(CURLOPT_HTTPHEADER, $headers);
-        $this->CurlRequest->setOption(CURLOPT_HEADERFUNCTION,
-            function ($curl, $header) use ($response) {
-                $response->addHeader($header);
-                return strlen($header);
-            });
-
-        $resp = $this->CurlRequest->execute();
-        if ($this->CurlRequest->getErrorNo() !== 0) {
-            throw new \RuntimeException('curl error ' . $this->CurlRequest->getError() . '" - Code: ' . $this->CurlRequest->getErrorNo());
-        } else {
-            $response->setData($resp);
-            $response->setStatusCode($this->CurlRequest->getInfo(CURLINFO_HTTP_CODE));
-            return $response;
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function buildBasicAuthHeader()
-    {
-        return 'Authorization: Basic ' . base64_encode($this->accountId . ':' . $this->applicationKey);
-    }
-
-    /**
-     * @return string
-     */
-    public function buildTokenAuthHeader()
-    {
-        return 'Authorization: ' . $this->authorizationToken;
-    }
-
-    /**
-     * @param $data
-     * @param $sha1
-     * @param $fileName
-     * @param $url
-     * @param $token
-     */
-    public function uploadData($fileData, $fileDataSha1, $fileName, $contentType, $uploadUrl, $uploadToken)
-    {
-        $headers   = [];
-        $headers[] = "Authorization: " . $uploadToken;
-        $headers[] = "X-Bz-File-Name: " . $fileName;
-        $headers[] = "Content-Type: " . $contentType;
-        $headers[] = "X-Bz-Content-Sha1: " . $fileDataSha1;
-
-        $response = $this->curl($uploadUrl, 'POST', $headers, $fileData);
-        return $response->getJsonData();
-    }
-
-    /**
-     * @param $url
-     */
-    public function downloadFileByName($uri)
-    {
-
-        $uri     = $this->downloadUrl . "/file/" . $uri;
-        $headers = [
-            $this->buildTokenAuthHeader()
-        ];
-
-        $response = $this->curl($uri, 'GET', $headers);
-        if ($response->getStatusCode() === 200) {
-            return $response->getData();
-        } else {
-            throw new \RuntimeException('Download failed. ' . $response->getStatusCode());
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function getDownloadUrl()
-    {
-        return $this->downloadUrl;
-    }
+	/**
+	 * @var string
+	 */
+	protected $accountId;
+
+	/**
+	 * @var string
+	 */
+	protected $applicationKey;
+
+	/**
+	 * @var string
+	 */
+	protected $apiUrl;
+
+	/**
+	 * @var string
+	 */
+	protected $authorizationToken;
+
+	/**
+	 * @var string
+	 */
+	protected $downloadUrl;
+
+	/**
+	 * @var CurlRequest
+	 */
+	protected $CurlRequest;
+
+	/**
+	 * @var Files
+	 */
+	public $Files;
+
+
+	/**
+	 * B2Client constructor.
+	 * @param string $accountId
+	 * @param string $applicationKey
+	 */
+	public function __construct($accountId, $applicationKey, CurlRequest $curlRequest = null)
+	{
+
+		if (!$curlRequest) {
+			$this->CurlRequest = new CurlRequest();
+		} else {
+			$this->CurlRequest = $curlRequest;
+		}
+
+		$this->accountId      = $accountId;
+		$this->applicationKey = $applicationKey;
+		$this->Files          = new Files($this);
+
+	}
+
+	/**
+	 * @param array $result
+	 */
+	public function setToken($result)
+	{
+		$this->authorizationToken = $result['authorizationToken'];
+		$this->apiUrl             = $result['apiUrl'];
+		$this->downloadUrl        = $result['downloadUrl'];
+	}
+
+	/**
+	 *
+	 */
+	public function requestToken()
+	{
+
+		$response = $this->curl('https://api.backblaze.com/b2api/v1/b2_authorize_account', 'GET', [
+			$this->buildBasicAuthHeader()
+		]);
+
+		$data = $response->getJsonData();
+		if ($response->getStatusCode() === 200) {
+			$this->setToken($data);
+			return true;
+		} else {
+			throw new \RuntimeException('Failed to get token: ' . $data['message']);
+		}
+
+	}
+
+	/**
+	 * @param $endpoint
+	 * @param $method
+	 * @param array $data
+	 * @return mixed
+	 * @throws \Exception
+	 */
+	public function call($endpoint, $method, $data = [])
+	{
+
+		if (empty($this->authorizationToken)) {
+			throw new \Exception('You must set or generate a token');
+		}
+
+		$headers = [
+			$this->buildTokenAuthHeader()
+		];
+
+		$headers[] = 'Content-Type: application/json';
+		$headers[] = "Accept: application/json";
+		$body      = json_encode($data);
+
+		$response = $this->curl($this->apiUrl . '/b2api/v1/' . $endpoint, $method, $headers, $body);
+
+		if ($response->getStatusCode() >= 200 && $response->getStatusCode() < 300) {
+			return $response->getJsonData();
+		}
+
+		if ($response->getStatusCode() >= 400) {
+			$data = $response->getJsonData();
+			throw new \RuntimeException('Error ' . $response->getStatusCode() . ' - ' . $data['message']);
+		}
+
+	}
+
+	/**
+	 * @param $uri
+	 * @param string $method
+	 * @param array $headers
+	 * @param null $body
+	 * @return B2Response
+	 */
+	public function curl($uri, $method = 'GET', $headers = [], $body = null)
+	{
+
+		$response = new B2Response();
+
+		$this->CurlRequest->setOption(CURLOPT_URL, $uri);
+		$this->CurlRequest->setOption(CURLOPT_CUSTOMREQUEST, $method);
+		$this->CurlRequest->setOption(CURLOPT_RETURNTRANSFER, 1);
+		$this->CurlRequest->setOption(CURLOPT_POST, 1);
+		$this->CurlRequest->setOption(CURLOPT_POSTFIELDS, $body);
+		$this->CurlRequest->setOption(CURLOPT_HTTPHEADER, $headers);
+		$this->CurlRequest->setOption(CURLOPT_HEADERFUNCTION,
+			function ($curl, $header) use ($response) {
+				$response->addHeader($header);
+				return strlen($header);
+			});
+
+		$resp = $this->CurlRequest->execute();
+		if ($this->CurlRequest->getErrorNo() !== 0) {
+			throw new \RuntimeException('curl error ' . $this->CurlRequest->getError() . '" - Code: ' . $this->CurlRequest->getErrorNo());
+		} else {
+			$response->setData($resp);
+			$response->setStatusCode($this->CurlRequest->getInfo(CURLINFO_HTTP_CODE));
+			return $response;
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function buildBasicAuthHeader()
+	{
+		return 'Authorization: Basic ' . base64_encode($this->accountId . ':' . $this->applicationKey);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function buildTokenAuthHeader()
+	{
+		return 'Authorization: ' . $this->authorizationToken;
+	}
+
+	/**
+	 * @param $data
+	 * @param $sha1
+	 * @param $fileName
+	 * @param $url
+	 * @param $token
+	 */
+	public function uploadData($fileData, $fileDataSha1, $fileName, $contentType, $uploadUrl, $uploadToken)
+	{
+		$headers   = [];
+		$headers[] = "Authorization: " . $uploadToken;
+		$headers[] = "X-Bz-File-Name: " . $fileName;
+		$headers[] = "Content-Type: " . $contentType;
+		$headers[] = "X-Bz-Content-Sha1: " . $fileDataSha1;
+
+		$response = $this->curl($uploadUrl, 'POST', $headers, $fileData);
+		return $response->getJsonData();
+	}
+
+	/**
+	 * @param $url
+	 */
+	public function downloadFileByName($uri)
+	{
+
+		$uri     = $this->downloadUrl . "/file/" . $uri;
+		$headers = [
+			$this->buildTokenAuthHeader()
+		];
+
+		$response = $this->curl($uri, 'GET', $headers);
+		if ($response->getStatusCode() === 200) {
+			return $response->getData();
+		} else {
+			throw new \RuntimeException('Download failed. ' . $response->getStatusCode());
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDownloadUrl()
+	{
+		return $this->downloadUrl;
+	}
 
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -148,7 +148,7 @@
         $this->CurlRequest->setOption(CURLOPT_POSTFIELDS, $body);
         $this->CurlRequest->setOption(CURLOPT_HTTPHEADER, $headers);
         $this->CurlRequest->setOption(CURLOPT_HEADERFUNCTION,
-            function ($curl, $header) use ($response) {
+            function($curl, $header) use ($response) {
                 $response->addHeader($header);
                 return strlen($header);
             });

src/B2Response.php

Indentation +44 added lines, -44 removed lines

@@ -8,50 +8,50 @@
 class B2Response
 {
 
-    private $data = null;
-
-    private $statusCode = 0;
-
-    private $headers = [];
-
-    public function __construct()
-    {
-    }
-
-    /**
-     * @param $header
-     */
-    public function addHeader($header)
-    {
-        $this->headers[] = $header;
-    }
-
-    public function setData($data)
-    {
-        $this->data = $data;
-    }
-
-    public function setStatusCode($statusCode)
-    {
-        $this->statusCode = $statusCode;
-    }
-
-    public function getStatusCode()
-    {
-        return $this->statusCode;
-    }
-
-    public function getJsonData()
-    {
-        if ($this->data) {
-            return json_decode($this->data, true);
-        }
-    }
-
-    public function getData()
-    {
-        return $this->data;
-    }
+	private $data = null;
+
+	private $statusCode = 0;
+
+	private $headers = [];
+
+	public function __construct()
+	{
+	}
+
+	/**
+	 * @param $header
+	 */
+	public function addHeader($header)
+	{
+		$this->headers[] = $header;
+	}
+
+	public function setData($data)
+	{
+		$this->data = $data;
+	}
+
+	public function setStatusCode($statusCode)
+	{
+		$this->statusCode = $statusCode;
+	}
+
+	public function getStatusCode()
+	{
+		return $this->statusCode;
+	}
+
+	public function getJsonData()
+	{
+		if ($this->data) {
+			return json_decode($this->data, true);
+		}
+	}
+
+	public function getData()
+	{
+		return $this->data;
+	}
 
 }
 

src/Files/Files.php

Indentation +115 added lines, -115 removed lines

@@ -10,120 +10,120 @@
 class Files
 {
 
-    /**
-     * @var B2Client
-     */
-    public $B2Client;
-
-    /**
-     * Files constructor.
-     * @param B2Client $B2Client
-     */
-    public function __construct(B2Client $B2Client)
-    {
-        $this->B2Client = $B2Client;
-    }
-
-    /**
-     * @param $bucketId
-     * @param $startFileName
-     * @return mixed
-     * @throws \Exception
-     */
-    public function listFileNames($bucketId, $startFileName = null, $maxFileCount = 100)
-    {
-        return $this->B2Client->call('b2_list_file_names', 'POST', [
-            'startFileName' => $startFileName,
-            'bucketId'      => $bucketId,
-            'maxFileCount'  => $maxFileCount
-        ]);
-    }
-
-    /**
-     * Lists all files in a bucket and starting filename. For very large buckets this may fail, use listFileNames() directly
-     *
-     * @param $bucketId
-     * @param $startFileName
-     * @return array
-     */
-    public function listAllFileNames($bucketId, $startFileName)
-    {
-
-        $allresults = [];
-        $result     = $this->listFileNames($bucketId, $startFileName);
-        $allresults = array_merge($allresults, $result['responseBody']['files']);
-
-        if ($result['responseBody']['nextFileName'] !== null) {
-            $allresults = array_merge($allresults,
-                $this->listAllFileNames($bucketId, $result['responseBody']['nextFileName']));
-        }
-
-        return $allresults;
-    }
-
-    /**
-     * @param $fileID
-     * @return mixed
-     * @throws \Exception
-     */
-    public function getFileInfo($fileId)
-    {
-        return $this->B2Client->call('b2_get_file_info', 'POST', ['fileId' => $fileId]);
-    }
-
-    /**
-     * @param $bucketId
-     * @return mixed
-     * @throws \Exception
-     */
-    public function getUploadUrl($bucketId)
-    {
-        return $this->B2Client->call('b2_get_upload_url', 'POST', ['bucketId' => $bucketId]);
-    }
-
-    /**
-     * @param $bucketId
-     * @param string $filePath The path to the local file
-     * @param string $fileName The name/path on B2
-     * @param string $contentType
-     * @param array $uploadUrlResponse
-     * @return array
-     */
-    public function uploadFile($bucketId, $filePath, $fileName, $contentType, $uploadUrlResponse = [])
-    {
-
-        if (empty($uploadUrlResponse)) {
-            $uploadUrlResponse = $this->getUploadUrl($bucketId);
-        }
-
-        $handle       = fopen($filePath, 'r');
-        $fileData     = fread($handle, filesize($filePath));
-        $fileDataSha1 = sha1_file($filePath);
-
-        return $this->B2Client->uploadData($fileData, $fileDataSha1, $fileName, $contentType,
-            $uploadUrlResponse['uploadUrl'],
-            $uploadUrlResponse['authorizationToken']);
-
-    }
-
-    /**
-     * @param $bucketId
-     * @param $fileName
-     * @return mixed
-     * @throws \Exception
-     */
-    public function downloadFileByName($bucketName, $fileName)
-    {
-        return $this->B2Client->downloadFileByName($bucketName . '/' . $fileName);
-    }
-
-    /**
-     * @param $bucketId
-     * @param $fileName
-     */
-    public function hideFile($bucketId, $fileName) 
-    {
-        return $this->B2Client->call('b2_hide_file', 'POST', ['bucketId' => $bucketId, 'fileName' => $fileName]);
-    }
+	/**
+	 * @var B2Client
+	 */
+	public $B2Client;
+
+	/**
+	 * Files constructor.
+	 * @param B2Client $B2Client
+	 */
+	public function __construct(B2Client $B2Client)
+	{
+		$this->B2Client = $B2Client;
+	}
+
+	/**
+	 * @param $bucketId
+	 * @param $startFileName
+	 * @return mixed
+	 * @throws \Exception
+	 */
+	public function listFileNames($bucketId, $startFileName = null, $maxFileCount = 100)
+	{
+		return $this->B2Client->call('b2_list_file_names', 'POST', [
+			'startFileName' => $startFileName,
+			'bucketId'      => $bucketId,
+			'maxFileCount'  => $maxFileCount
+		]);
+	}
+
+	/**
+	 * Lists all files in a bucket and starting filename. For very large buckets this may fail, use listFileNames() directly
+	 *
+	 * @param $bucketId
+	 * @param $startFileName
+	 * @return array
+	 */
+	public function listAllFileNames($bucketId, $startFileName)
+	{
+
+		$allresults = [];
+		$result     = $this->listFileNames($bucketId, $startFileName);
+		$allresults = array_merge($allresults, $result['responseBody']['files']);
+
+		if ($result['responseBody']['nextFileName'] !== null) {
+			$allresults = array_merge($allresults,
+				$this->listAllFileNames($bucketId, $result['responseBody']['nextFileName']));
+		}
+
+		return $allresults;
+	}
+
+	/**
+	 * @param $fileID
+	 * @return mixed
+	 * @throws \Exception
+	 */
+	public function getFileInfo($fileId)
+	{
+		return $this->B2Client->call('b2_get_file_info', 'POST', ['fileId' => $fileId]);
+	}
+
+	/**
+	 * @param $bucketId
+	 * @return mixed
+	 * @throws \Exception
+	 */
+	public function getUploadUrl($bucketId)
+	{
+		return $this->B2Client->call('b2_get_upload_url', 'POST', ['bucketId' => $bucketId]);
+	}
+
+	/**
+	 * @param $bucketId
+	 * @param string $filePath The path to the local file
+	 * @param string $fileName The name/path on B2
+	 * @param string $contentType
+	 * @param array $uploadUrlResponse
+	 * @return array
+	 */
+	public function uploadFile($bucketId, $filePath, $fileName, $contentType, $uploadUrlResponse = [])
+	{
+
+		if (empty($uploadUrlResponse)) {
+			$uploadUrlResponse = $this->getUploadUrl($bucketId);
+		}
+
+		$handle       = fopen($filePath, 'r');
+		$fileData     = fread($handle, filesize($filePath));
+		$fileDataSha1 = sha1_file($filePath);
+
+		return $this->B2Client->uploadData($fileData, $fileDataSha1, $fileName, $contentType,
+			$uploadUrlResponse['uploadUrl'],
+			$uploadUrlResponse['authorizationToken']);
+
+	}
+
+	/**
+	 * @param $bucketId
+	 * @param $fileName
+	 * @return mixed
+	 * @throws \Exception
+	 */
+	public function downloadFileByName($bucketName, $fileName)
+	{
+		return $this->B2Client->downloadFileByName($bucketName . '/' . $fileName);
+	}
+
+	/**
+	 * @param $bucketId
+	 * @param $fileName
+	 */
+	public function hideFile($bucketId, $fileName) 
+	{
+		return $this->B2Client->call('b2_hide_file', 'POST', ['bucketId' => $bucketId, 'fileName' => $fileName]);
+	}
 
 }