phata/widgetfy

Widgetfy is a PHP library to translate URLs of video sites into the embed / widget

v3.0 2024-06-27 17:59 UTC

Requires

• php: >=8.1

Requires (Dev)

• phpstan/phpstan: ^1.11
• phpunit/phpunit: ^10

LGPL-3.0-or-later

• Koala Yeung

• embed
• url translate

README

Widgetfy is a PHP library to translate URLs of video sites into the embed / widget.

Install

First, install composer to your development platform.

Then run this in your project folder:

composer require phata/widgetfy

Example Code

// require the composer autoload script
require_once './vendor/autoload.php';

use Phata\Widgetfy\Core as Widgetfy;

// simple setup
if (($embed = Widgetfy::translate($link)) != NULL) {
    echo $embed['html'];
}

// adjust all video to width 640px, if the source support that
$options = array('width'=>640);
if (($embed = Widgetfy::translate($link, $options)) != NULL) {
    echo $embed['html'];
}

// using the default theme, and inlining the default CSS
// along with the first embed code.
echo Phata\Widgetfy\Theme::toHTML($embed, true);

For more detailed documentation, please visit our Documentation page on GitLab.

Branches

Branch	Purpose	PHP Version	Status
3.x	Stable / Default	8.1, 8.2, 8.3
2.x	Maintenance	7.1, 7.2, 7.3, 7.4
1.x	Maintenance	5.3, 5.4, 5.5, 5.6
main	Development	7.1, 7.2, 7.3, 7.4

License

This file is part of Widgetfy.

Widgetfy is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Widgetfy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public Licensefor more details.

You should have received a copy of the GNU Lesser General Public License along with Widgetfy. If not, see http://www.gnu.org/licenses/lgpl.html.