Download the PHP package cyhello/seafile-php-sdk without Composer

On this page you can find all versions of the php package cyhello/seafile-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of cyhello/seafile-php-sdk

Informations about the package seafile-php-sdk

Seafile PHP SDK

This is a PHP package for accessing Seafile Web API.

German Web Application Developer Available for Hire!

No marketing skills whatsoever, but low rates, 20+ years of experience, and "german work attitude" -- whatever you associate with that.

Get in touch now: https://sdo.sh/#contact

PHP Composer Test Coverage License

What is Seafile?

How to get Started

To get started with Seafile PHP SDK, you may either set up your own private Seafile server (see https://www.seafile.com/en/product/private_server/) or obtain a cloud account. Because the SDK is in its infancy it's highly recommended to set up a test server or create a test account.

It's not advisable yet to use your real server/account if you already got one.

After you have created your test account continue to the next step.

Roadmap and notes on development

Please note that this SDK currently is under active development and that things might change rather drastically.

If you are looking for stability please refer to stable tags.

Obtain API token

Please refer to the Seafile docs on how to obtain an API token.

This also applies to the token required for functional tests (TEST_SERVER_AUTHORIZATION_TOKEN).

Installing Seafile-PHP-SDK

The recommended way to install seafile-php-sdk is through Composer.

Next, run the Composer command to install the latest stable version of seafile-php-sdk:

After installing, you need to require Composer's autoloader:

You can then later update seafile-php-sdk using Composer:

Using Seafile PHP SDK

Hint: Have a look at -- everything this SDK can do is covered there!

Connecting to Seafile

First, you need to include the API token (see above):

List available libraries

List directory contents

Check if directory item exists

Be aware that because Seafile Web API does not provide a function to do this check on its own, all items of the directory will get loaded for iteration. So that's not very efficient.

Create directory

Download file from unencrypted library

Download file from encrypted library

Trying to download a file from an encrypted library without unlocking it first would inevitably fail, so just unlock (API docs say "decrypt") the library before attempting:

Upload file

Update file

Get file details

Get API user account info

Get all accounts

Create account

Update account

Get account info by email address

Delete account

or

Get avatar of an account

or

Create and remove shared link

Get all starred files, star and unstar file

Debugging and how to enable logging of requests and responses

This example requires monolog. Log entries and Guzzle debug info will be written to stdout.

Issues

Dependencies

Seafile Web API Support Matrix

Resource Web API Version Support grade
Account v2 ★★★☆
Avatar v2.1 ★★★★
Events v2 Yet to be done, contact me
File Share Link v2.1 ★★★☆
Group v2 ★☆☆☆
Library/Directory v2 ★★☆☆
Library/File v2 ★★☆☆
Library/Library v2 ★★☆☆
Library/Multiple Files v2 ★★★★
Organization v2 Yet to be done, contact me
Starred Files v2 ★★★★

Seafile server compatibility

Tested with:

Support

I'd be happy to implement new features for you at a competitive hourly rate. Get in touch now: https://sdo.sh/#contact

Contributing

Please note that this package still is in its infancy. Only a part of the API has been implemented so far.

Pull requests are welcome. Please adhere to some very basic and simple principles:

Tests

There are two types of tests:

  1. Unit tests that test a code unit without external dependencies and no data manipulation. Please always provide at least unit tests when contributing.
  2. Functional tests that run against a live server instance (=may have external dependencies) and also alter data. Disabled and thus skipped by default. Please refer to /phpunit/php in phpunit.xml.dist for information on how to enable functional tests.

Links

License

MIT © 2015-2021 Rene Schmidt DevOps UG (haftungsbeschränkt) & Co. KG

All versions of seafile-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
guzzlehttp/guzzle Version ~7.2
marcusball/case-helper Version ~0.1
ext-json Version *
sdo/bitmask Version ~1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package cyhello/seafile-php-sdk contains the following files

Loading the files please wait ....