README

Embed Video for Laravel

The package is designed to create a URL for an embedded video and a URL for a cover image from various video hosting sites from a video URL in any format.
The package can be used both to process user-entered data before adding it to the database and to display the result on the page.
The package includes handlers for videos from YouTube, Rutube and VK Video.
If necessary, you can add your own handler classes for other video hostings.

Installation

Install the latest version with

composer require vhar/laravel-embed-video

Usage

Call the handle method of the Vhar\LaravelEmbedVideo\Facades\EmbeVideo facade, passing it the URL of the video in any format as an argument.

try {
    return EmbedVideo::handle('https://www.youtube.com/watch?v=gpn_4tWz1w8');
} catch (\Exception $exception) {
    return ['error' => $exception->getMessage()];
}

If the passed URL is successfully processed, the handle method will return an instance of \Vhar\LaravelEmbedVideo\EmbedData class containing the ID, the URL for the embedded video, and the URL for the cover image.

{
  id: "gpn_4tWz1w8"
  video: "https://www.youtube.com/embed/gpn_4tWz1w8"
  cover: "https://img.youtube.com/vi/gpn_4tWz1w8/0.jpg"
}

or an exception with an error message, such as:

The argument is not valid URL-address to a YouTube video.

You can also call a specific handler using the hosting method passing an alias of an available handler as an argument.

try {
    return EmbedVideo::hosting('youtube')->handle('https://www.youtube.com/watch?v=gpn_4tWz1w8');
} catch (\Exception $exception) {
    return ['error' => $exception->getMessage()];
}

The following aliases are currently available:

youtube for YouTube;
rutube for Rutube;
vkvideo for VK Video;

Testing

To use the tests, add keys to the .env file for your test environment with URLs to any available videos on the corresponding hosts.

YOUTUBE_VIDEO=''
RUTUBE_VIDEO=''
VK_VIDEO=''

If keys are missing or contain an invalid value, the test will be skipped.

Next step - add testsuite block to phpunit.xml file.

<testsuites>instance
    ...
    <testsuite name="Embed Video">
        <directory suffix="Test.php">./vendor/vhar/laravel-embed-video/tests/</directory>
    </testsuite>
</testsuites>

Embedded video tests will now start when you run an php artisan test command.

Creating your own class-handler

Сreate a class implementing the interface Vhar\LaravelEmbedVideo\Contracts\EmbedVideoContract.
In the handle method, create the code to handle the URL string. This method should return an instance of \Vhar\LaravelEmbedVideo\EmbedData class containing a property with an identifier (id), a URL for the embedded video (video), and a URL for the cover image (cover).

public function handle(string $url): EmbedData
{
    ...    
    return EmbedData::create($id, $embedURL, $coverURL);
}

The availableDomains method must return an array with the hosting domain names for this handler.

public function allowedDomains(): array
{
    return [
        'youtu.be',
        'youtube.com',
    ];
}

Add your handler registration to the register method of the App\Providers\AppServiceProvider provider.

class AppServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        ...
        \Vhar\LaravelEmbedVideo\Facades\VideoHosting::hosting('you_alias', \YouNamespace\YouClassHandlerService::class);
    }
}

Now, you can call the link handling from the new handler, just like for the built-in services, by calling the handle method of Vhar\LaravelEmbedVideo\Facades\EmbedVideo facade.

vhar / laravel-embed-video

Maintainers

Details