Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Next: Cloudinary Laravel SDK v3 #144

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,11 @@ jobs:
strategy:
fail-fast: false
matrix:
php: [8.1, 8.2, 8.3]
laravel: [10.*, 11.*]
php: [8.2, 8.3, 8.4]
laravel: [11.*]
include:
- laravel: 10.*
testbench: 8.*
- laravel: 11.*
testbench: 9.*
exclude:
- laravel: 11.*
php: 8.1

name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }} - Testbench ${{ matrix.testbench }}

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The MIT License (MIT)

Copyright (c) 2020 Cloudinary Labs
Copyright (c) 2025 Cloudinary Labs

> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
Expand Down
180 changes: 1 addition & 179 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,13 @@

- [Installation](#installation)
- [Configuration](#configuration)
- [Upload, Retrieval & Transformation](#upload-retrieval--transformation)
- [Attach Files to Eloquent Models](#attach-files-to-eloquent-models)
- [Media Management via CLI](#media-management-via-cli)
- [Cloudinary URL Generation](#cloudinary-url-generation)
- [Blade Components](#blade-components)
- [Disclaimer](#disclaimer)
- [Contributions](#contributions)
- [License](#license)

## Installation

Requires PHP 8.1+ and Laravel 10+.
Requires PHP 8.2+ and Laravel 11+.

```bash
composer require cloudinary-labs/cloudinary-laravel
Expand All @@ -58,179 +53,6 @@ CLOUDINARY_NOTIFICATION_URL=
> [!NOTE]
> You can get your `CLOUDINARY_URL` from your [Cloudinary console](https://cloudinary.com/console). It typically looks like this: `cloudinary://API_KEY:API_SECRET@CLOUD_NAME`. Make sure to replace `API_KEY`, `API_SECRET`, and `CLOUD_NAME` with your actual Cloudinary credentials.

## Usage

### Upload, Retrieval & Transformation

```php
// Upload
$uploadedFileUrl = cloudinary()->upload($request->file('file')->getRealPath())->getSecurePath();

// Upload with transformation
$uploadedFileUrl = cloudinary()->upload($request->file('file')->getRealPath(), [
'folder' => 'uploads',
'transformation' => [
'width' => 400,
'height' => 400,
'crop' => 'fill'
]
])->getSecurePath();

// Get URL
$url = cloudinary()->getUrl($publicId);

// Check if file exists
$exists = Storage::disk('cloudinary')->fileExists($publicId);
```

### Attach Files to Eloquent Models

First, add the `MediaAlly` trait to your model:

```php
use CloudinaryLabs\CloudinaryLaravel\MediaAlly;

class Page extends Model
{
use MediaAlly;
// ...
}
```

Then, you can use the following methods:

```php
// Attach media
$page->attachMedia($request->file('file'));

// Retrieve media
$allMedia = $page->fetchAllMedia();
$firstMedia = $page->fetchFirstMedia();
$lastMedia = $page->fetchLastMedia();

// Update media
$page->updateMedia($newFile);

// Detach media
$page->detachMedia($file);
```

### Media Management via CLI

```bash
php artisan cloudinary:backup
php artisan cloudinary:delete
php artisan cloudinary:fetch
php artisan cloudinary:rename
php artisan cloudinary:upload
```

## Cloudinary URL Generation

Use the `Cloudinary` facade or the `cloudinary()` helper function to generate URLs:

```php
use CloudinaryLabs\CloudinaryLaravel\Facades\Cloudinary;

$url = Cloudinary::getUrl($publicId);
// or
$url = cloudinary()->getUrl($publicId);
```

## Blade Components

This package provides several Blade components for easy integration of Cloudinary media in your Laravel views

### Upload files via an Upload Widget

You can use the `<x-cld-upload-button />` Blade component that ships with this page like so:

```blade
<!DOCTYPE html>
<html>
<head>
... @cloudinaryJS
</head>
<body>
<x-cld-upload-button>Upload Files</x-cld-upload-button>
</body>
</html>
```

### Image Component

Basic usage:

```blade
<x-cld-image public-id="example" />
```

With additional properties:

```blade
<x-cld-image public-id="example" width="300" height="300" />
```

#### Properties available:

| Property | Required |
| --------------------- | -------- |
| `public-id` | Yes |
| `width` | No |
| `height` | No |
| `alt` | No |
| `class` | No |
| `crop` | No |
| `gravity` | No |
| `effect` | No |
| `rotate` | No |
| `colorize` | No |
| `trim` | No |
| `blur` | No |
| `gray-scale` | No |
| `black-white` | No |
| `sepia` | No |
| `redeye` | No |
| `negate` | No |
| `oil-paint` | No |
| `vignette` | No |
| `simulate-colorblind` | No |
| `pixelate` | No |
| `unsharp-mask` | No |
| `saturation` | No |
| `contrast` | No |
| `brightness` | No |
| `gamma` | No |
| `improve-mode` | No |
| `shadow` | No |
| `border` | No |
| `round-corners` | No |
| `bg-color` | No |
| `art` | No |
| `cartoonify` | No |

### Video Component

Basic usage:

```blade
<x-cld-video public-id="example"></x-cld-video>
```

With additional properties:

```blade
<x-cld-video public-id="example" width="300" height="300" />
```

#### Properties available:

| Property | Required |
| ----------- | -------- |
| `public-id` | Yes |
| `width` | No |
| `height` | No |

## Disclaimer

> _This software/code provided under Cloudinary Labs is an unsupported pre-production prototype undergoing further development and provided on an “AS IS” basis without warranty of any kind, express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. Furthermore, Cloudinary is not under any obligation to provide a commercial version of the software.</br> </br> Your use of the Software/code is at your sole risk and Cloudinary will not be liable for any direct, indirect, incidental, special, exemplary, consequential or similar damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of the Software, even if advised of the possibility of such damage.</br> </br> You should refrain from uploading any confidential or personally identifiable information to the Software. All rights to and in the Software are and will remain at all times, owned by, or licensed to Cloudinary._
Expand Down
30 changes: 14 additions & 16 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
"license": "MIT",
"authors": [
{
"name": "Prosper Otemuyiwa",
"email": "[email protected]",
"homepage": "https://github.com/unicodeveloper"
"name": "Josh Manders",
"homepage": "https://github.com/joshmanders"
}
],
"homepage": "https://github.com/cloudinary-labs/cloudinary-laravel",
Expand All @@ -22,24 +21,26 @@
"test": "pest"
},
"require": {
"php": "^8.1",
"php": "^8.2",
"ext-json": "*",
"illuminate/support": "^10.0|^11.0",
"cloudinary/cloudinary_php": "^2.0"
"illuminate/support": "^11.0",
"cloudinary/cloudinary_php": "^3.0",
"league/flysystem": "^3.29"
},
"require-dev": {
"mockery/mockery": "^1.1",
"orchestra/testbench": "^8.0|^9.0",
"pestphp/pest": "^2.35",
"sempro/phpunit-pretty-print": "^1.0",
"laravel/pint": "^1.20"
"mockery/mockery": "^1.6",
"orchestra/testbench": "^9.9",
"pestphp/pest": "^2.36",
"sempro/phpunit-pretty-print": "^1.2",
"laravel/pint": "^1.20",
"phpspec/prophecy-phpunit": "^2.3"
},
"autoload": {
"psr-4": {
"CloudinaryLabs\\CloudinaryLaravel\\": "src/"
},
"files": [
"src/Support/helpers.php"
"src/helpers.php"
]
},
"autoload-dev": {
Expand All @@ -51,10 +52,7 @@
"laravel": {
"providers": [
"CloudinaryLabs\\CloudinaryLaravel\\CloudinaryServiceProvider"
],
"aliases": {
"Cloudinary": "CloudinaryLabs\\CloudinaryLaravel\\Facades\\Cloudinary"
}
]
}
},
"config": {
Expand Down
Loading