Qiniu PHP SDK | Generated by AI

Home PDF

To use the "qiniu/php-sdk": "^7.0" in PHP, you’ll need to integrate the Qiniu PHP SDK into your project. This SDK allows you to interact with Qiniu Cloud Storage services, such as uploading files, managing buckets, and more. Below is a step-by-step guide to get you started:

1. Install the Qiniu PHP SDK

The recommended way to install the SDK is via Composer, a dependency manager for PHP. Ensure you have Composer installed on your system.

Steps:

If you don’t have Composer installed, you can download it from getcomposer.org.

2. Set Up Your Project

After installation, you need to include the autoloader in your PHP script to use the SDK classes.

Example:

Create a PHP file (e.g., index.php) in your project directory and add the following line at the top:

require_once 'vendor/autoload.php';

This ensures that the SDK classes are automatically loaded when needed.

3. Configure Authentication

To use the Qiniu SDK, you’ll need your Qiniu AccessKey and SecretKey, which you can obtain from your Qiniu account dashboard.

Example:

use Qiniu\Auth;

$accessKey = 'YOUR_ACCESS_KEY';
$secretKey = 'YOUR_SECRET_KEY';

$auth = new Auth($accessKey, $secretKey);

Replace 'YOUR_ACCESS_KEY' and 'YOUR_SECRET_KEY' with your actual credentials.

4. Basic Usage: Uploading a File

One of the most common tasks with the Qiniu SDK is uploading files to a bucket. Here’s an example of how to upload a local file.

Example:

use Qiniu\Storage\UploadManager;

$bucket = 'YOUR_BUCKET_NAME'; // Replace with your Qiniu bucket name
$filePath = '/path/to/your/file.txt'; // Path to the file you want to upload
$key = 'file.txt'; // The name of the file in Qiniu storage (can be null to use the original filename)

$token = $auth->uploadToken($bucket); // Generate an upload token
$uploadMgr = new UploadManager();

list($ret, $error) = $uploadMgr->putFile($token, $key, $filePath);

if ($error !== null) {
    echo "Upload failed: " . $error->message();
} else {
    echo "Upload successful! File hash: " . $ret['hash'];
}

5. Additional Features

The Qiniu PHP SDK provides many other functionalities, such as:

Example: Listing Files in a Bucket

use Qiniu\Storage\BucketManager;

$bucketMgr = new BucketManager($auth);
list($ret, $error) = $bucketMgr->listFiles($bucket);

if ($error !== null) {
    echo "Error: " . $error->message();
} else {
    echo "Files in bucket:\n";
    foreach ($ret['items'] as $item) {
        echo $item['key'] . "\n";
    }
}

6. Error Handling

Always check the $error variable after SDK operations. If an operation fails, $error will contain details about what went wrong.

Example:

if ($error !== null) {
    var_dump($error);
} else {
    var_dump($ret);
}

7. Requirements

You can check your PHP version and extensions with:

php -v
php -m

8. Where to Go Next

Full Example Code

Here’s a complete script to upload a file:

<?php
require_once 'vendor/autoload.php';

use Qiniu\Auth;
use Qiniu\Storage\UploadManager;

$accessKey = 'YOUR_ACCESS_KEY';
$secretKey = 'YOUR_SECRET_KEY';
$bucket = 'YOUR_BUCKET_NAME';
$filePath = '/path/to/your/file.txt';
$key = 'file.txt';

$auth = new Auth($accessKey, $secretKey);
$token = $auth->uploadToken($bucket);
$uploadMgr = new UploadManager();

list($ret, $error) = $uploadMgr->putFile($token, $key, $filePath);

if ($error !== null) {
    echo "Upload failed: " . $error->message();
} else {
    echo "Upload successful! File hash: " . $ret['hash'];
}

Replace the placeholder values (YOUR_ACCESS_KEY, YOUR_SECRET_KEY, YOUR_BUCKET_NAME, /path/to/your/file.txt) with your actual data, and you’re good to go!

Let me know if you need help with a specific feature!

Back 2025.03.04 Donate