Weave Code
Filejet Php Laravel Package
filejet/filejet-php
PHP client library for Filejet, a file upload and delivery service. Simplifies integrating Filejet’s API into PHP applications for uploading, managing, and serving files, with a clean, lightweight interface suitable for Laravel and other PHP projects.
PHP wrapper for FileJet service
Frequently asked questions about Filejet Php
- What is filejet/filejet-php and what does it actually do?
- filejet/filejet-php is a PHP client library for FileJet, a file upload and delivery service. It gives you a clean, framework-agnostic API for uploading, retrieving, and deleting files while FileJet handles CDN-backed storage and automatic image processing. It is a thin client rather than a storage abstraction, so it stays small and is easy to drop into an existing PHP or Laravel application. HTTP communication is handled through Guzzle.
- How do I install filejet/filejet-php with Composer?
- Run composer require filejet/filejet-php and Composer will resolve the package plus its Guzzle-based HTTP dependencies. After that, include Composer's autoloader and instantiate the client with your FileJet credentials. If you use Laravel, the package also offers optional integration so the client can be resolved from the container instead of being constructed manually.
- Does filejet/filejet-php support Laravel, and which versions?
- Yes. The core library is framework-agnostic, but the package includes optional Laravel integration so the client can be bound in the service container. Which Laravel versions are supported depends on the release you install, so check the package's composer.json constraints and the README before upgrading a project. It works fine in plain PHP projects too, so Laravel is not a requirement.
- How do I upload a file and what is the mutation identifier it returns?
- You upload a file through the client and FileJet returns a unique mutation identifier representing that upload operation. Store that identifier and reference it afterwards instead of a raw file path, since it lets you track the result of the upload. For the exact method signature and response shape, follow the usage example in the README, because the API surface is intentionally small and may change between versions.
- How do I generate an optimized or transformed image URL?
- FileJet serves files from its CDN and applies image transformations on the fly, so the client lets you build retrieval URLs for a stored file rather than streaming bytes through your own server. You supply the file reference and the transformation parameters you want, and get back a URL you can place straight into an img tag or an API response. Because processing happens at the CDN layer, your application does not need an image manipulation library installed.
- How do I delete a file with filejet/filejet-php?
- The client exposes a delete call for removing files you no longer need from FileJet storage. Deletion is done by reference to the stored file, typically the identifier or handle you received at upload time. Keep in mind that a CDN may keep serving cached copies briefly after deletion, so plan for cache invalidation if immediate removal matters to you.
- Can I use this library outside Laravel, in a plain PHP or other framework project?
- Yes. The library is plain PHP with no framework coupling, so any project that can load Composer dependencies can use it. You construct the client yourself and call the upload, retrieve, and delete methods directly. The Laravel integration is optional convenience layered on top of that, not a requirement.
- How should I configure FileJet credentials and keep them safe?
- Credentials are passed into the client rather than baked into it, so keep them in environment variables or a secrets manager and inject them at construction time. In Laravel that means putting the values in your .env file and letting your configuration read them, so they never land in source control. Use separate credentials for staging and production, and avoid hard-coding keys in tests or CI scripts.
- How do I test code that uses this client without hitting the real FileJet API?
- Because HTTP handling goes through Guzzle, you can inject a client configured with a mock handler so your tests never reach the real FileJet API. Assert on the outgoing requests and return canned responses that mimic uploads, URL generation, and deletes. That keeps your test suite fast and deterministic and avoids consuming real storage quota in CI.
- How does filejet/filejet-php compare to Flysystem or Laravel's Storage facade?
- Flysystem and Laravel's Storage facade are storage abstractions designed to let you swap providers with minimal code changes, whereas this package is a dedicated client for a single service. Choose filejet-php when you specifically want FileJet's CDN delivery and on-the-fly image processing without maintaining your own transformation pipeline. If provider portability is the priority, a filesystem abstraction layered over FileJet may suit you better.
Weaver
How can I help you explore Laravel packages today?