nucleos/shariff-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

This bundle provides shariff integration in symfony applications

5.1.1 2020-11-04 10:09 UTC

Requires

• php: ^7.3
• ext-json: *
• psr/cache: ^1.0
• psr/http-client: ^1.0
• psr/http-message: ^1.0
• sonata-project/block-bundle: ^3.21 || ^4.2
• sonata-project/form-extensions: ^1.0
• symfony/config: ^4.2 || ^5.0
• symfony/dependency-injection: ^4.2 || ^5.0
• symfony/expression-language: ^4.2 || ^5.0
• symfony/form: ^4.2 || ^5.0
• symfony/framework-bundle: ^4.2 || ^5.0
• symfony/http-foundation: ^4.2 || ^5.0
• symfony/http-kernel: ^4.2 || ^5.0
• symfony/options-resolver: ^4.2 || ^5.0
• symfony/twig-bundle: ^4.2 || ^5.0

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.3
• ergebnis/composer-normalize: ^2.0.1
• nyholm/psr7: ^1.0
• symfony/browser-kit: ^4.4 || ^5.0
• symfony/cache: ^4.2 || ^5.0
• symfony/http-client: ^4.2 || ^5.0

MIT

• Christian Gripp

• symfony
• sonata
• bundle
• twitter
• google
• facebook
• widget
• heise
• shariff
• sonata-block

README

This bundle provides a wrapper for using shariff inside the symfony sonata-project.

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require nucleos/shariff-bundle

Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    Nucleos\ShariffBundle\NucleosShariffBundle::class => ['all' => true],
];

Define cache, http client and request factory:

# config/routes/nucleos_shariff.yaml

framework:
    cache:
        pools:
            cache.shariff:
                adapter: cache.adapter.filesystem

nucleos_shariff:
    cache: 'cache.shariff'
    http_client: 'some.http.client'         # e.g httplug.client
    request_factory: 'some.request.factory' # e.g. nyholm.psr7.psr17_factory

Assets

It is recommended to use webpack / webpack-encore to include the shariff.js and shariff.css file in your page.

You can use npm or yarn to load the library:

npm install shariff

yarn add shariff

Configure the Bundle

Create a configuration file called nucleos_shariff.yaml:

# config/routes/nucleos_shariff.yaml

nucleos_shariff:
    resource: "@NucleosShariffBundle/Resources/config/routing/backend.yml"

Create a configuration file called framework_cache.yaml:

framework:
    cache:
        pools:
            cache.shariff:
                adapter: cache.adapter.filesystem

Usage

{# template.twig #}

{{ sonata_block_render({ 'type': 'nucleos_shariff.block.share' }, {
    'url': 'https://example.com/site.html'
}) }}

Configure the Bundle

You can globally configure the services that should count the likes or favorites for a page.

nucleos_shariff:
    cache: 'cache.shariff'
    http_client: 'some.http.client'
    request_factory: 'some.request.factory'

    options:
        domains: [ ] # Allow specific domains for shariff
        services: [ 'addthis', 'buffer', 'facebook', 'pinterest', 'reddit', 'stumbleupon', 'vk', 'xing' ]

    services:
        facebook:
            app_id:  "1234567890"
            secret:  "GENERATEDSECRET"
            version: "5.0"

This is a fork of shariff-php with a more modern and dynamic solution.

License

This bundle is under the MIT license.