Download the PHP package slations/directus-php-sdk without Composer
On this page you can find all versions of the php package slations/directus-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download slations/directus-php-sdk
More information about slations/directus-php-sdk
Files in slations/directus-php-sdk
Package directus-php-sdk
Short Description A PHP SDK for interacting with the Directus API
License MIT
FAQ
Example:
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 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.
Informations about the package directus-php-sdk
Directus PHP SDK
A PHP SDK for interacting with the Directus API. This SDK provides a convenient and object-oriented way to access Directus endpoints and perform common operations.
Table of Contents
- Directus PHP SDK
- Table of Contents
- Features
- Requirements
- Installation
- Configuration
- Usage
- Authentication
- API Key Authentication
- User/Password Authentication
- Items
- Users
- Files
- Other Endpoints
- Custom Calls
- Storage
- Session Storage
- Cookie Storage
- Custom Storage
- Error Handling
- Testing
- Contributing
- License
Features
- Object-oriented interface for interacting with the Directus API
- Supports all Directus endpoints (Items, Files, Users, etc.)
- Supports multiple authentication methods (API Key, User/Password)
- Customizable storage for authentication tokens (Session, Cookie, Custom)
- Easy-to-use methods for common CRUD operations (Create, Read, Update, Delete)
- Comprehensive error handling
Requirements
- PHP 8.0 or higher
- Composer
- Guzzle HTTP client (
guzzlehttp/guzzle)
Installation
- Install the SDK using Composer:
Configuration
Before using the SDK, you need to configure it with your Directus base URL and authentication details.
- Base URL: The base URL of your Directus instance (e.g.,
https://your-directus-instance.com). - Storage: Choose a storage mechanism for authentication tokens (Session, Cookie, or Custom).
- Authentication: Choose an authentication method and provide the necessary credentials.
Usage
Authentication
The SDK supports multiple authentication methods:
API Key Authentication
User/Password Authentication
Items
The items endpoint allows you to manage items in a specific collection.
Users
The users endpoint allows you to manage users in your Directus instance.
Files
The files endpoint allows you to manage files in your Directus instance.
Other Endpoints
The SDK provides access to all Directus endpoints, including:
activity()collections()comments()contentVersions()dashboards()extensions()fields(string $collection)flows()folders()notifications()operations()panels()permissions()policies()presets()relations()revisions()roles()schema()server()settings()shares()translations()utilities()
Each endpoint provides methods for performing common operations, such as get, create, update, and delete. Refer to the Directus API documentation for more information on each endpoint and its available methods.
Custom Calls
You can make custom API calls using the makeCustomCall method:
Storage
The SDK uses a StorageInterface to store authentication tokens. You can choose between session storage, cookie storage, or implement your own custom storage mechanism.
Session Storage
Session storage uses PHP sessions to store authentication tokens. This is the default storage mechanism.
Cookie Storage
Cookie storage uses cookies to store authentication tokens.
Custom Storage
You can implement your own custom storage mechanism by creating a class that implements the StorageInterface.
Error Handling
The SDK throws exceptions for API errors. You can catch these exceptions and handle them appropriately.
Testing
The SDK includes a set of Pest PHP tests to ensure that it functions correctly. To run the tests, follow these steps:
-
Install Pest PHP:
- Run the tests:
Contributing
Contributions are welcome! Please submit a pull request with your changes.
License
The Directus PHP SDK is licensed under the MIT License.
