Download the PHP package locomotivemtl/charcoal-contrib-embed without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-contrib-embed. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-contrib-embed
More information about locomotivemtl/charcoal-contrib-embed
Files in locomotivemtl/charcoal-contrib-embed
Package charcoal-contrib-embed
Short Description Charcoal service provider for an embed property.
License MIT
Homepage https://locomotivemtl.github.io/charcoal-contrib-embed/
Informations about the package charcoal-contrib-embed
Charcoal Embed
A Charcoal service provider embed property.
Table of Contents
- Installation
- Dependencies
- Service Provider
- Parameters
- Services
- Configuration
- Usage
- Development
- API Documentation
- Development Dependencies
- Coding Style
- Credits
- License
Installation
The preferred (and only supported) method is with Composer:
Dependencies
Required
- PHP 5.6+: PHP 7 is recommended.
- locomotivemtl/charcoal-property : ^0.8
- guzzlehttp/guzzle : ^6.0 or ^7.0
- embed/embed : ^3.4.10
Service Provider
The following services are provided with the use of locomotivemtl/charcoal-contrib-embed
Services
- embed/repository instance of
Embed\EmbedRepository
- Charcoal\Embed\Mixin\EmbedRepositoryTrait provided for ease of use.
Configuration
Include the embed module in the projects's config file. This will provide everything needed for locomotivemtl/charcoal-contrib-embed to work properly. No need for metadata/views/action/routes path etc.
You can provide additional configurations in the project's config file like so :
This is the actual default config.
Usage
The Embed Contrib provides a custom Property type : "embed". When using it, the property will fetch embed data from media providers and store them in a third table.
To load the embed data from database, use EmbedRepository service method
Dependency injection :
Development
To install the development environment:
To run the scripts (phplint, phpcs, and phpunit):
API Documentation
- The auto-generated
phpDocumentor
API documentation is available at:
https://locomotivemtl.github.io/charcoal-contrib-embed/docs/master/ - The auto-generated
apigen
API documentation is available at:
https://codedoc.pub/locomotivemtl/charcoal-contrib-embed/master/
Development Dependencies
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
Coding Style
The charcoal-contrib-embed module follows the Charcoal coding-style:
- PSR-1
- PSR-2
- PSR-4, autoloading is therefore provided by Composer.
- phpDocumentor comments.
- .editorconfig for coding standards.
Coding style validation / enforcement can be performed with
composer phpcs
. An auto-fixer is also available withcomposer phpcbf
.
Credits
License
Charcoal is licensed under the MIT license. See LICENSE for details.
All versions of charcoal-contrib-embed with dependencies
embed/embed Version ^3.4
locomotivemtl/charcoal-app Version ~0.8
locomotivemtl/charcoal-config Version ~0.10
locomotivemtl/charcoal-property Version ~0.8
guzzlehttp/guzzle Version ^6.0 || ^7.0
guzzlehttp/promises Version ^1.4 || ^2.0
pimple/pimple Version ^3.5
psr/log Version ^1.1