Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pixel-developpement/sulu-socialbundle

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/pixel-developpement/sulu-socialbundle
Owner: Pixel-Developpement
Created: 2022-05-23T07:54:35.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-10-03T18:27:03.000Z (4 months ago)
Last Synced: 2024-11-05T06:22:31.489Z (3 months ago)
Language: PHP
Size: 193 KB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md

Awesome Lists containing this project

README

# Sulu social bundle

![GitHub release (with filter)](https://img.shields.io/github/v/release/Pixel-Developpement/sulu-socialbundle?style=for-the-badge)
[![Dependency](https://img.shields.io/badge/sulu-2.5-cca000.svg?style=for-the-badge)](https://sulu.io/)

## Presentation
A Sulu bundle to easily manage the social medias.

## Requirements

* PHP >= 8.0
* Sulu >= 2.4.*
* Symfony >= 5.4
* Composer

## Installation

### Install the bundle

Execute the following [composer](https://getcomposer.org/) command to add the bundle to the dependencies of your
project:

```bash
composer require pixeldev/sulu-socialbundle --with-all-dependencies
```

### Enable the bundle

Enable the bundle by adding it to the list of registered bundles in the `config/bundles.php` file of your project:

```php
return [
/* ... */
Pixel\SocialBundle\SocialBundle::class => ['all' => true],
];
```

### Update schema
```shell script
bin/console do:sch:up --force
```

## Bundle Config

Define the Admin Api Route in `routes_admin.yaml`
```yaml
social.settings_api:
type: rest
prefix: /admin/api
resource: pixel_social.settings_route_controller
name_prefix: social.
```

## Use
## General use
To access the social medias settings, on the administration interface, go to the Settings section and click on "Social medias management".
Once on the form, you will see block content type.

This block is composed of on type, the "Social media" type.
It is made with two fields:
* The social media name
* The social media link

The social media name field is a select in which you can choose the social media you want.

The social media link is a link field type.

Do not forget to click on "Save" to have the information stored and available.

## Twig extension
This bundle comes with several twig function that will help you in rendering the social medias you filled:

**social_settings()**: returns all the social medias you provided. No parameters are required.

Example of use:
```twig
{% set socialSettings = social_settings() %}

```

**facebook_share(link, title)**: returns a link to share on Facebook. It takes two parameters:
* link: the link you want to share
* title: the text that will appear on the shared link on Facebook

Example of use:
```twig
Share on Facebook
```

**twitter_share(link, title, origin)**: returns a link to share on Twitter. It takes three parameters:
* link: the link you want to share
* title: the text that will appear on the shared link on Twitter
* origin: the origin of the sharing

Example of use:
```twig
Share on LinkedIn
```

**whatsapp_share(text, link)**: returns a link to share on WhatsApp. It takes two parameters:
* text: the text that will appear on the shared link on WhatsApp
* link: the link you want to share

Example of use:
```twig
Share on Pinterest
```

**social_media_logo(name)**: renders the logo of the specified social media. It takes one parameter:
* name: name of the social media

Example of use:
```twig
{{ social_media_logo(socialMedia.socialMediaName) }}
```

## Contributing
You can contribute to this bundle. The only thing you must do is respect the coding standard we implements.
You can find them in the `ecs.php` file.