social_media_links-8.x-2.x-dev/src/Plugin/Block/SocialMediaLinksBlock.php
src/Plugin/Block/SocialMediaLinksBlock.php
<?php
namespace Drupal\social_media_links\Plugin\Block;
use Drupal\Component\Plugin\Exception\PluginException;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\Template\Attribute;
use Drupal\Core\Url;
use Drupal\social_media_links\IconsetBase;
use Drupal\social_media_links\IconsetFinderService;
use Drupal\social_media_links\SocialMediaLinksIconsetManager;
use Drupal\social_media_links\SocialMediaLinksPlatformManager;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Provides the Social Media Links Block.
*
* @Block(
* id="social_media_links_block",
* admin_label = @Translation("Social Media Links"),
* )
*/
class SocialMediaLinksBlock extends BlockBase implements ContainerFactoryPluginInterface {
/**
* {@inheritdoc}
*/
protected $platformManager;
/**
* {@inheritdoc}
*/
protected $iconsetManager;
/**
* {@inheritdoc}
*/
protected $iconsetFinderService;
/**
* {@inheritdoc}
*/
protected $renderer;
/**
* {@inheritdoc}
*/
protected $logger;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, SocialMediaLinksPlatformManager $platform_manager, SocialMediaLinksIconsetManager $iconset_manager, IconsetFinderService $finder_service, RendererInterface $renderer, LoggerInterface $logger) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->platformManager = $platform_manager;
$this->iconsetManager = $iconset_manager;
$this->iconsetFinderService = $finder_service;
$this->renderer = $renderer;
$this->logger = $logger;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static(
$configuration,
$plugin_id,
$plugin_definition,
$container->get('plugin.manager.social_media_links.platform'),
$container->get('plugin.manager.social_media_links.iconset'),
$container->get('social_media_links.finder'),
$container->get('renderer'),
$container->get('logger.channel.social_media_links')
);
}
/**
* {@inheritdoc}
*/
public function blockForm($form, FormStateInterface $form_state) {
$form = parent::blockForm($form, $form_state);
$config = $this->getConfiguration();
// Platforms.
$form['platforms'] = [
'#type' => 'table',
'#header' => [
$this->t('Platform'),
$this->t('Platform URL'),
$this->t('Description'),
$this->t('Weight'),
],
'#tabledrag' => [
[
'action' => 'order',
'relationship' => 'sibling',
'group' => 'platform-order-weight',
],
],
];
// Keep a note of the highest weight.
$max_weight = 10;
$platforms = $this->platformManager->getPlatformsSortedByWeight($this->getConfiguration());
foreach ($platforms as $platform_id => $platform) {
$form['platforms'][$platform_id]['#attributes']['class'][] = 'draggable';
$form['platforms'][$platform_id]['#weight'] = $platform['weight'];
if ($platform['weight'] > $max_weight) {
$max_weight = $platform['weight'];
}
$form['platforms'][$platform_id]['label'] = [
'#markup' => '<strong>' . $platform['name']->render() . '</strong>',
];
$form['platforms'][$platform_id]['value'] = [
'#type' => 'textfield',
'#title' => $platform['name']->render(),
'#title_display' => 'invisible',
'#size' => 40,
'#default_value' => $config['platforms'][$platform_id]['value'] ?? '',
'#field_prefix' => $platform['instance']->getUrlPrefix(),
'#field_suffix' => $platform['instance']->getUrlSuffix(),
'#element_validate' => [
[
get_class($platform['instance']),
'validateValue',
],
],
];
if (!empty($platform['instance']->getFieldDescription())) {
$form['platforms'][$platform_id]['value']['#description'] = $platform['instance']->getFieldDescription();
}
$form['platforms'][$platform_id]['description'] = [
'#type' => 'textfield',
'#title' => $platform['name']->render(),
'#title_display' => 'invisible',
'#description' => $this->t('The description is used for the title and WAI-ARIA attribute.'),
'#size' => 40,
'#placeholder' => $this->t('Find / Follow us on %platform', ['%platform' => $platform['name']->render()]),
'#default_value' => $config['platforms'][$platform_id]['description'] ?? '',
];
$form['platforms'][$platform_id]['weight'] = [
'#type' => 'weight',
'#title' => $this->t('Weight for @title', ['@title' => $platform['name']->render()]),
'#title_display' => 'invisible',
'#default_value' => $platform['weight'],
'#attributes' => ['class' => ['platform-order-weight']],
// Delta: We need to use the max weight + number of platforms,
// because if they get re-ordered it could start the count again from
// the max weight, when the last item is dragged to be the first item.
'#delta' => $max_weight + count($platforms),
];
}
// Appearance.
$form['appearance'] = [
'#type' => 'details',
'#title' => $this->t('Appearance'),
'#tree' => TRUE,
];
$form['appearance']['orientation'] = [
'#type' => 'select',
'#title' => $this->t('Orientation'),
'#options' => [
'v' => $this->t('vertical'),
'h' => $this->t('horizontal'),
],
'#default_value' => $config['appearance']['orientation'] ?? 'h',
];
$form['appearance']['show_name'] = [
'#type' => 'checkbox',
'#title' => $this->t('Show name'),
'#description' => $this->t('Show the platform name next to the icon.'),
'#default_value' => $config['appearance']['show_name'] ?? 0,
];
$form['appearance']['suggestion'] = [
'#type' => 'machine_name',
'#title' => $this->t('Theme hook suggestion'),
'#default_value' => $config['appearance']['suggestion'] ?? '',
'#required' => FALSE,
'#field_prefix' => '<code>social_media_links_platforms__</code>',
'#description' => $this->t('A theme hook suggestion can be used to override the default HTML and CSS found in <code>social-media-links-platforms.html</code>.'),
'#machine_name' => [
'error' => $this->t('The theme hook suggestion must contain only lowercase letters, numbers, and underscores.'),
'exists' => [$this, 'suggestionExists'],
],
];
// Link Attributes.
$form['link_attributes'] = [
'#type' => 'details',
'#title' => $this->t('Link attributes'),
'#tree' => TRUE,
];
$form['link_attributes']['target'] = [
'#type' => 'select',
'#title' => $this->t('Default target'),
'#default_value' => $config['link_attributes']['target'] ?? '<none>',
'#options' => [
'<none>' => $this->t('Remove target attribute'),
'_blank' => $this->t('Open in a new browser window or tab (_blank)'),
'_self' => $this->t('Open in the current window (_self)'),
'_parent' => $this->t('Open in the frame that is superior to the frame the link is in (_parent)'),
'_top' => $this->t('Cancel all frames and open in full browser window (_top)'),
],
];
$form['link_attributes']['rel'] = [
'#type' => 'select',
'#title' => $this->t('Default rel'),
'#default_value' => $config['link_attributes']['rel'] ?? '<none>',
'#options' => [
'<none>' => $this->t('Remove rel attribute'),
'nofollow' => $this->t('Set nofollow'),
],
];
// Icon Sets.
$iconsetStyles = $this->iconsetManager->getStyles();
$form['iconset'] = [
'#type' => 'details',
'#title' => $this->t('Icon Sets'),
'#open' => TRUE,
'#attributes' => ['class' => ['iconsets-wrapper']],
];
$form['iconset']['style'] = [
'#type' => 'select',
'#title' => $this->t('Icon Style'),
'#default_value' => $config['iconset']['style'] ?? '',
'#options' => $iconsetStyles,
];
// Get the possible libarary install locations.
// We use it maybe later in the form process, if a iconset is not installed.
$installDirs = $this->iconsetFinderService->getInstallDirs();
$installedIconsets = [];
foreach ($this->iconsetManager->getIconsets() as $iconset_id => $iconset) {
if (isset($iconset['downloadUrl'])) {
$name = Link::fromTextAndUrl($iconset['name'], Url::fromUri($iconset['downloadUrl']))->toString();
}
else {
$name = $iconset['name'];
}
$publisher = '';
if (isset($iconset['publisher'])) {
$publisher = $this->t('by') . ' ';
if (isset($iconset['publisherUrl'])) {
$publisher .= Link::fromTextAndUrl($iconset['publisher'], Url::fromUri($iconset['publisherUrl']))->toString();
}
else {
$publisher .= $iconset['publisher'];
}
}
$installedIconsets[$iconset_id]['name'] = [
'#markup' => '<strong>' . $name . '</strong><br />' . $publisher,
];
$installedIconsets[$iconset_id]['styles'] = [
'#markup' => implode('<br />', $iconsetStyles[$iconset_id]),
];
if ($iconset['instance']->getPath()) {
$installedIconsets[$iconset_id]['examples'] = [
'#type' => 'table',
];
// Use the first iconset style for the sample table.
$style = key($iconsetStyles[$iconset_id]);
$style = IconsetBase::explodeStyle($style);
$style = $style['style'];
if ($iconset['instance']->getPath() === 'library' && $library = $iconset['instance']->getLibrary()) {
$installedIconsets[$iconset_id]['examples']['#attached']['library'] = (array) $library;
}
foreach ($this->platformManager->getPlatforms() as $platform_id => $platform) {
$installedIconsets[$iconset_id]['examples']['#header'][] = $platform['name']->render();
$iconElement = $iconset['instance']->getIconElement($platform['instance'], $style);
$installedIconsets[$iconset_id]['examples'][1][$platform_id] = [
'#type' => 'markup',
'#markup' => $this->renderer->render($iconElement),
];
}
}
else {
$examples = '<strong>' . $this->t('Not installed.') . '</strong><br />';
$examples .= $this->t('To install: @download and copy it to one of these directories:',
[
'@download' => Link::fromTextAndUrl($this->t('Download'), Url::fromUri($iconset['downloadUrl']))->toString(),
]
);
$installDirsIconset = [];
foreach ($installDirs as $dir) {
$installDirsIconset[] = $dir . '/' . $iconset_id;
}
$examples .= '<br /><code>' . preg_replace('/,([^,]+) ?$/', " " . 'or' . " $1", implode(',<br />', $installDirsIconset), 1) . '</code>';
$installedIconsets[$iconset_id]['examples'] = [
'#markup' => $examples,
];
}
// Add a weigth to the iconset for sorting.
$installedIconsets[$iconset_id]['#weight'] = $iconset['instance']->getPath() ? 0 : 1;
}
// Sort the array so that installed iconsets shown first.
uasort($installedIconsets, [
'Drupal\Component\Utility\SortArray',
'sortByWeightProperty',
]);
$form['iconset']['installed_iconsets'] = [
'#type' => 'table',
'#header' => [
$this->t('Name'),
$this->t('Sizes'),
$this->t('Icon examples and download instructions'),
],
] + $installedIconsets;
return $form;
}
/**
* {@inheritdoc}
*/
public function blockSubmit($form, FormStateInterface $form_state) {
$this->setConfigurationValue('platforms', $form_state->getValue('platforms'));
$this->setConfigurationValue('appearance', $form_state->getValue('appearance'));
$this->setConfigurationValue('link_attributes', $form_state->getValue('link_attributes'));
$iconset = $form_state->getValue('iconset');
unset($iconset['iconset']['installed_iconsets']);
$this->setConfigurationValue('iconset', $iconset);
}
/**
* {@inheritdoc}
*/
public function build() {
$config = $this->getConfiguration();
$platforms = $this->platformManager->getPlatformsWithValue($config['platforms']);
if (count($platforms) < 1) {
return [];
}
$iconset = IconsetBase::explodeStyle($config['iconset']['style']);
try {
$iconsetInstance = $this->iconsetManager->createInstance($iconset['iconset']);
}
catch (PluginException $exception) {
$this->logger->error('The selected "@iconset" iconset plugin does not exist.', ['@iconset' => $iconset['iconset']]);
return [];
}
foreach ($config['link_attributes'] as $key => $value) {
if ($value === '<none>') {
unset($config['link_attributes'][$key]);
}
}
// Set the attributes for the individual links.
//
// We use two different types of link attributes:
// * "global" attributes that affects all links (e.g. target or rel)
// which are set in $config['link_attributes'];
// * "individual" attributes for each link (e.g. title) which are defined
// in $platforms[$platform_id]['attributes'].
foreach ($platforms as $platform_id => $platform) {
$platforms[$platform_id]['element'] = (array) $iconsetInstance->getIconElement($platform['instance'], $iconset['style']);
$platforms[$platform_id]['attributes'] = new Attribute($config['link_attributes']);
if (!empty($platform['instance']->getDescription())) {
$platforms[$platform_id]['attributes']->setAttribute('aria-label', $platform['instance']->getDescription());
$platforms[$platform_id]['attributes']->setAttribute('title', $platform['instance']->getDescription());
}
}
$output = [
'#theme' => 'social_media_links_platforms',
'#platforms' => $platforms,
'#appearance' => $config['appearance'],
'#attached' => [
'library' => ['social_media_links/social_media_links.theme'],
],
];
if ($iconsetInstance->getPath() === 'library' && (array) $library = $iconsetInstance->getLibrary()) {
$output['#attached']['library'] = array_merge_recursive($output['#attached']['library'], $library);
}
return [$output];
}
/**
* Checks for an existing theme hook suggestion.
*
* @return bool
* Returns FALSE because there is no need of validation by unique value.
*/
public function suggestionExists() {
return FALSE;
}
}
