bootstrap3-1.0.1/src/Bootstrap.php
src/Bootstrap.php
<?php
namespace Drupal\bootstrap3;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Extension\ThemeHandlerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Render\Markup;
use Drupal\Core\Render\RenderContext;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\bootstrap3\Plugin\AlterManager;
use Drupal\bootstrap3\Plugin\FormManager;
use Drupal\bootstrap3\Plugin\PreprocessManager;
use Drupal\bootstrap3\Utility\Crypt;
use Drupal\bootstrap3\Utility\Element;
use Drupal\bootstrap3\Utility\Unicode;
use GuzzleHttp\Exception\GuzzleException;
use GuzzleHttp\Psr7\Request;
/**
* The primary class for the Drupal Bootstrap base theme.
*
* Provides many helper methods.
*
* @ingroup utility
*/
class Bootstrap {
/**
* Tag used to invalidate caches.
*
* @var string
*/
const CACHE_TAG = 'theme_registry';
/**
* Append a callback.
*
* @var int
*/
const CALLBACK_APPEND = 1;
/**
* Prepend a callback.
*
* @var int
*/
const CALLBACK_PREPEND = 2;
/**
* Replace a callback or append it if not found.
*
* @var int
*/
const CALLBACK_REPLACE_APPEND = 3;
/**
* Replace a callback or prepend it if not found.
*
* @var int
*/
const CALLBACK_REPLACE_PREPEND = 4;
/**
* The current supported Bootstrap Framework version.
*
* @var string
*/
const FRAMEWORK_VERSION = '3.4.4';
/**
* The Bootstrap Framework documentation site.
*
* @var string
*/
const FRAMEWORK_HOMEPAGE = 'https://bootstrap.7pro.ca/docs/3.4/';
/**
* The Bootstrap Framework repository.
*
* @var string
*/
const FRAMEWORK_REPOSITORY = 'https://github.com/entreprise7pro/bootstrap';
/**
* The project branch.
*
* @var string
*/
const PROJECT_BRANCH = '8.x-3.x';
/**
* The Drupal Bootstrap documentation site.
*
* @var string
*/
const PROJECT_DOCUMENTATION = 'https://drupal-bootstrap.org';
/**
* The project API search URL.
*
* @var string
*
* @todo Enable constant once PHP 5.5 is no longer supported.
*/
// Const PROJECT_API_SEARCH_URL = self::PROJECT_DOCUMENTATION . '/api/bootstrap3/' . self::PROJECT_BRANCH . '/search/@query';.
/**
* The Drupal Bootstrap project page.
*
* @var string
*/
const PROJECT_PAGE = 'https://www.drupal.org/project/bootstrap';
/**
* The File System service, if it exists.
*
* @var \Drupal\Core\File\FileSystemInterface|false
*/
protected static $fileSystem;
/**
* The Messenger service, if it exists.
*
* @var \Drupal\Core\Messenger\MessengerInterface|false
*/
protected static $messenger;
/**
* The Renderer service.
*
* @var \Drupal\Core\Render\Renderer
*/
protected static $renderer;
/**
* The Theme Registry service.
*
* @var \Drupal\Core\Theme\Registry
*/
protected static $themeRegistry;
/**
* The Twig service.
*
* @var \Drupal\Core\Template\TwigEnvironment
*/
protected static $twig;
/**
* Adds a callback to an array.
*
* @param array $callbacks
* An array of callbacks to add the callback to, passed by reference.
* @param array|string $callback
* The callback to add.
* @param array|string $replace
* If specified, the callback will instead replace the specified value
* instead of being appended to the $callbacks array.
* @param int $action
* Flag that determines how to add the callback to the array.
*
* @return bool
* TRUE if the callback was added, FALSE if $replace was specified but its
* callback could be found in the list of callbacks.
*/
public static function addCallback(array &$callbacks, $callback, $replace = NULL, $action = Bootstrap::CALLBACK_APPEND) {
// Replace a callback.
if ($replace) {
// Iterate through the callbacks.
foreach ($callbacks as $key => $value) {
// Convert each callback and match the string values.
if (Unicode::convertCallback($value) === Unicode::convertCallback($replace)) {
$callbacks[$key] = $callback;
return TRUE;
}
}
// No match found and action shouldn't append or prepend.
if ($action !== self::CALLBACK_REPLACE_APPEND || $action !== self::CALLBACK_REPLACE_PREPEND) {
return FALSE;
}
}
// Append or prepend the callback.
switch ($action) {
case self::CALLBACK_APPEND:
case self::CALLBACK_REPLACE_APPEND:
$callbacks[] = $callback;
return TRUE;
case self::CALLBACK_PREPEND:
case self::CALLBACK_REPLACE_PREPEND:
array_unshift($callbacks, $callback);
return TRUE;
default:
return FALSE;
}
}
/**
* Manages theme alter hooks as classes and allows sub-themes to sub-class.
*
* @param string $function
* The procedural function name of the alter (e.g. __FUNCTION__).
* @param mixed $data
* The variable that was passed to the hook_TYPE_alter() implementation to
* be altered. The type of this variable depends on the value of the $type
* argument. For example, when altering a 'form', $data will be a structured
* array. When altering a 'profile', $data will be an object.
* @param mixed $context1
* (optional) An additional variable that is passed by reference.
* @param mixed $context2
* (optional) An additional variable that is passed by reference. If more
* context needs to be provided to implementations, then this should be an
* associative array as described above.
*/
public static function alter($function, &$data, &$context1 = NULL, &$context2 = NULL) {
// Do not statically cache this as the active theme may change.
$theme = static::getTheme();
$theme_name = $theme->getName();
// Immediately return if the active theme is not Bootstrap based.
if (!$theme->isBootstrap()) {
return;
}
// Handle alter and form managers.
static $drupal_static_fast;
if (!isset($drupal_static_fast)) {
$drupal_static_fast['alter_managers'] = &drupal_static(__METHOD__ . '__alterManagers', []);
$drupal_static_fast['form_managers'] = &drupal_static(__METHOD__ . '__formManagers', []);
}
/** @var \Drupal\bootstrap3\Plugin\AlterManager[] $alter_managers */
$alter_managers = &$drupal_static_fast['alter_managers'];
if (!isset($alter_managers[$theme_name])) {
$alter_managers[$theme_name] = new AlterManager($theme);
}
/** @var \Drupal\bootstrap3\Plugin\FormManager[] $form_managers */
$form_managers = &$drupal_static_fast['form_managers'];
if (!isset($form_managers[$theme_name])) {
$form_managers[$theme_name] = new FormManager($theme);
}
// Retrieve the alter and form managers for this theme.
$alter_manager = $alter_managers[$theme_name];
$form_manager = $form_managers[$theme_name];
// Extract the alter hook name.
$hook = Unicode::extractHook($function, 'alter');
// Handle form alters as a separate plugin.
if (strpos($hook, 'form') === 0 && $context1 instanceof FormStateInterface) {
$form_state = $context1;
$form_id = $context2;
// Due to a core bug that affects admin themes, we should not double
// process the "system_theme_settings" form twice in the global
// hook_form_alter() invocation.
// @see https://www.drupal.org/node/943212
if ($form_id === 'system_theme_settings') {
return;
}
// Keep track of the form identifiers.
$ids = [];
// Get the build data.
$build_info = $form_state->getBuildInfo();
// Extract the base_form_id.
$base_form_id = !empty($build_info['base_form_id']) ? $build_info['base_form_id'] : FALSE;
if ($base_form_id) {
$ids[] = $base_form_id;
}
// If there was no provided form identifier, extract it.
if (!$form_id) {
$form_id = !empty($build_info['form_id']) ? $build_info['form_id'] : Unicode::extractHook($function, 'alter', 'form');
}
if ($form_id) {
$ids[] = $form_id;
}
// Iterate over each form identifier and look for a possible plugin.
foreach ($ids as $id) {
/** @var \Drupal\bootstrap3\Plugin\Form\FormInterface $form */
if ($form_manager->hasDefinition($id) && ($form = $form_manager->createInstance($id, ['theme' => $theme]))) {
$data['#submit'][] = [get_class($form), 'submitForm'];
$data['#validate'][] = [get_class($form), 'validateForm'];
$form->alterForm($data, $form_state, $form_id);
}
}
}
// Process hook alter normally.
else {
/** @var \Drupal\bootstrap3\Plugin\Alter\AlterInterface $class */
if ($alter_manager->hasDefinition($hook) && ($class = $alter_manager->createInstance($hook, ['theme' => $theme]))) {
$class->alter($data, $context1, $context2);
}
}
}
/**
* Returns a documentation search URL for a given query.
*
* @param string $query
* The query to search for.
*
* @return \Drupal\Component\Render\FormattableMarkup
* The complete URL to the documentation site.
*/
public static function apiSearchUrl($query = '') {
// @todo Move to a constant once PHP 5.5 is no longer supported.
return new FormattableMarkup(self::PROJECT_DOCUMENTATION . '/api/bootstrap3/' . self::PROJECT_BRANCH . '/search/@query', [
'@query' => $query,
]);
}
/**
* Returns the autoload fix include path.
*
* This method assists class based callbacks that normally do not work.
*
* If you notice that your class based callback is never invoked, you may try
* using this helper method as an "include" or "file" for your callback, if
* the callback metadata supports such an option.
*
* Depending on when or where a callback is invoked during a request, such as
* an ajax or batch request, the theme handler may not yet be fully
* initialized.
*
* Typically there is little that can be done about this "issue" from core.
* It must balance the appropriate level that should be bootstrapped along
* with common functionality. Cross-request class based callbacks are not
* common in themes.
*
* When this file is included, it will attempt to jump start this process.
*
* Please keep in mind, that it is merely an attempt and does not guarantee
* that it will actually work. If it does not appear to work, do not use it.
*
* @see \Drupal\Core\Extension\ThemeHandler::listInfo
* @see \Drupal\Core\Extension\ThemeHandler::systemThemeList
* @see system_list
* @see system_register()
* @see drupal_classloader_register()
*
* @return string
* The autoload fix include path, relative to Drupal root.
*/
public static function autoloadFixInclude() {
return static::getTheme('bootstrap3')->getPath() . '/autoload-fix.php';
}
/**
* Checks whether a specific URL is reachable.
*
* @param string $url
* The URL to check.
* @param array $options
* Additional options to pass to the HTTP client.
* @param \Exception|null $exception
* Any Exceptions throw, passed by reference.
*
* @return \Drupal\bootstrap3\SerializedResponse
* A SerializedResponse object.
*/
public static function checkUrlIsReachable($url, array $options = [], &$exception = NULL) {
$options['method'] = 'HEAD';
$options['ttl'] = 0;
return static::request($url, $options, $exception);
}
/**
* Retrieves a response from a URL, using cached response if available.
*
* @param string $url
* The URL to retrieve.
* @param array $options
* The options to pass to the HTTP client.
* @param \Exception|null $exception
* The exception thrown if there was an error, passed by reference.
*
* @return \Drupal\bootstrap3\SerializedResponse
* A Response object.
*/
public static function request($url, array $options = [], &$exception = NULL) {
$options += [
'method' => 'GET',
'headers' => [
'User-Agent' => 'Drupal Bootstrap ' . static::PROJECT_BRANCH . ' (' . static::PROJECT_PAGE . ')',
],
];
// Determine if a custom TTL value was set.
$ttl = $options['ttl'] ?? NULL;
unset($options['ttl']);
$cache = \Drupal::keyValueExpirable('theme:' . static::getTheme()->getName() . ':http');
// The URL cannot be part of the prefix as the "name" field of
// "key_value_expire" has a max length of 128.
$hash = Crypt::generateBase64HashIdentifier(['url' => $url] + $options, 'request');
$response = $cache->get($hash);
if (!isset($response)) {
/** @var \GuzzleHttp\Client $client */
$client = \Drupal::service('http_client_factory')->fromOptions($options);
$request = new Request($options['method'], $url, $options['headers']);
try {
$response = SerializedResponse::createFromGuzzleResponse($client->send($request, $options), $request);
}
catch (GuzzleException $e) {
$exception = $e;
$response = SerializedResponse::createFromException($e, $request);
}
catch (\Exception $e) {
$exception = $e;
$response = SerializedResponse::createFromException($e, $request);
}
// Only cache if a maximum age has been detected.
$maxAge = $ttl ?? $response->getMaxAge();
if ($response->getStatusCode() == 200 && $maxAge > 0) {
// Due to key_value_expire setting the "expire" field to "INT(11)", it
// is technically limited to a 32bit max value (Y2K38 bug).
// @todo Remove this once this is no longer an issue.
// @see https://www.drupal.org/project/drupal/issues/65474
// @see https://www.drupal.org/project/drupal/issues/1003692
$requestTime = \Drupal::time()->getRequestTime();
if (($requestTime + $maxAge) > 2147483647) {
$maxAge = 2147483647 - $requestTime;
}
try {
$cache->setWithExpire($hash, $response, $maxAge);
}
catch (\Exception $e) {
// Intentionally do nothing, tried to cache response... it failed.
}
}
}
return $response;
}
/**
* Matches a Bootstrap class based on a string value.
*
* @param string|array $value
* The string to match against to determine the class. Passed by reference
* in case it is a render array that needs to be rendered and typecast.
* @param string $default
* The default class to return if no match is found.
*
* @return string
* The Bootstrap class matched against the value of $haystack or $default
* if no match could be made.
*/
public static function cssClassFromString(&$value, $default = '') {
static $lang;
if (!isset($lang)) {
$lang = \Drupal::languageManager()->getCurrentLanguage()->getId();
}
$theme = static::getTheme();
$texts = $theme->getCache('cssClassFromString', [$lang]);
// Ensure it's a string value that was passed.
$string = static::toString($value);
if ($texts->isEmpty()) {
$data = [
// Text that match these specific strings are checked first.
'matches' => [
// Primary class.
t('Download feature')->render() => 'primary',
// Success class.
t('Add effect')->render() => 'success',
t('Add and configure')->render() => 'success',
t('Save configuration')->render() => 'success',
t('Install and set as default')->render() => 'success',
// Info class.
t('Save and add')->render() => 'info',
t('Add another item')->render() => 'info',
t('Update style')->render() => 'info',
],
// Text containing these words anywhere in the string are checked last.
'contains' => [
// Primary class.
t('Confirm')->render() => 'primary',
t('Filter')->render() => 'primary',
t('Log in')->render() => 'primary',
t('Submit')->render() => 'primary',
t('Search')->render() => 'primary',
t('Settings')->render() => 'primary',
t('Upload')->render() => 'primary',
// Danger class.
t('Delete')->render() => 'danger',
t('Remove')->render() => 'danger',
t('Reset')->render() => 'danger',
t('Uninstall')->render() => 'danger',
// Success class.
t('Add')->render() => 'success',
t('Create')->render() => 'success',
t('Install')->render() => 'success',
t('Save')->render() => 'success',
t('Write')->render() => 'success',
// Warning class.
t('Export')->render() => 'warning',
t('Import')->render() => 'warning',
t('Restore')->render() => 'warning',
t('Rebuild')->render() => 'warning',
// Info class.
t('Apply')->render() => 'info',
t('Update')->render() => 'info',
],
];
// Allow sub-themes to alter this array of patterns.
/** @var \Drupal\Core\Theme\ThemeManager $theme_manager */
$theme_manager = \Drupal::service('theme.manager');
$theme_manager->alter('bootstrap_colorize_text', $data);
$texts->setMultiple($data);
}
// Iterate over the array.
foreach ($texts as $pattern => $strings) {
foreach ($strings as $text => $class) {
switch ($pattern) {
case 'matches':
if ($string === $text) {
return $class;
}
break;
case 'contains':
if (strpos(mb_strtolower($string), mb_strtolower($text)) !== FALSE) {
return $class;
}
break;
}
}
}
// Return the default if nothing was matched.
return $default;
}
/**
* Logs and displays a warning about a deprecated function/method being used.
*
* @param string $caller
* Optional. The function or Class::method that should be shown as
* deprecated. If not set, it will be extrapolated automatically from
* the backtrace. This is primarily used when this method is being invoked
* from inside another method that isn't technically deprecated but has to
* support deprecated functionality.
* @param bool $show_message
* Flag indicating whether to show a message to the user. If TRUE, it will
* force show the message. If FALSE, it will only log the message. If not
* set, the message will be shown based on whether the current user is an
* administrator and if the theme has suppressed deprecated warnings.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup $message
* Optional. The message to show/log. If not set, it will be determined
* automatically based on the caller.
*/
public static function deprecated($caller = NULL, $show_message = NULL, ?TranslatableMarkup $message = NULL) {
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
// Extrapolate the caller.
if (!isset($caller) && !empty($backtrace[1]) && ($info = $backtrace[1])) {
$caller = (!empty($info['class']) ? $info['class'] . '::' : '') . $info['function'];
}
// Remove class namespace.
$method = FALSE;
if (is_string($caller) && strpos($caller, '::') !== FALSE && ($parts = explode('\\', $caller))) {
$method = TRUE;
$caller = array_pop($parts);
}
if (!isset($message)) {
$message = t('The following @type has been deprecated: <a href=":url" target="_blank">@title</a>. Please check the logs for a more detailed backtrace on where it is being invoked.', [
'@type' => $method ? 'method' : 'function',
':url' => static::apiSearchUrl($caller),
'@title' => $caller,
]);
}
if ($show_message || (!isset($show_message) && static::isAdmin() && !static::getTheme()->getSetting('suppress_deprecated_warnings', FALSE))) {
\Drupal::messenger()->addMessage($message, 'warning');
}
// Log message and accompanying backtrace.
\Drupal::logger('bootstrap')->warning('<p>@message</p><pre><code>@backtrace</code></pre>', [
'@message' => $message,
'@backtrace' => Markup::create(print_r($backtrace, TRUE)),
]);
}
/**
* Provides additional variables to be used in elements and templates.
*
* @return array
* An associative array containing key/default value pairs.
*/
public static function extraVariables() {
return [
// @see https://www.drupal.org/node/2035055
'context' => [],
// @see https://www.drupal.org/node/2219965
'icon' => NULL,
'icon_position' => 'before',
'icon_only' => FALSE,
];
}
/**
* Retrieves the File System service, if it exists.
*
* @param string $method
* Optional. A specific method on the file system service to check for
* its existence.
*
* @return \Drupal\Core\File\FileSystemInterface
* The File System service, if it exists and if $method exists if it was
* passed.
*
* @deprecated in bootstrap:8.x-3.22 and is removed from bootstrap:5.0.0.
* Use the "file_system" service instead.
* @see https://www.drupal.org/project/bootstrap/issues/3096963
*/
public static function fileSystem($method = NULL) {
if (!isset(static::$fileSystem)) {
static::$fileSystem = \Drupal::hasService('file_system') ? \Drupal::service('file_system') : FALSE;
}
if ($method) {
return static::$fileSystem && method_exists(static::$fileSystem, $method) ? static::$fileSystem : FALSE;
}
return static::$fileSystem;
}
/**
* Retrieves a theme instance of \Drupal\bootstrap3.
*
* @param string $name
* The machine name of a theme. If omitted, the active theme will be used.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler object.
*
* @return \Drupal\bootstrap3\Theme
* A theme object.
*/
public static function getTheme($name = NULL, ?ThemeHandlerInterface $theme_handler = NULL) {
// Immediately return if theme passed is already instantiated.
if ($name instanceof Theme) {
return $name;
}
static $themes = [];
// Retrieve the active theme.
// Do not statically cache this as the active theme may change.
if (!isset($name)) {
$name = \Drupal::theme()->getActiveTheme()->getName();
}
if (!isset($theme_handler)) {
$theme_handler = self::getThemeHandler();
}
if (!isset($themes[$name])) {
$themes[$name] = new Theme($theme_handler->getTheme($name), $theme_handler);
}
return $themes[$name];
}
/**
* Retrieves the theme handler instance.
*
* @return \Drupal\Core\Extension\ThemeHandlerInterface
* The theme handler instance.
*/
public static function getThemeHandler() {
static $theme_handler;
if (!isset($theme_handler)) {
$theme_handler = \Drupal::service('theme_handler');
}
return $theme_handler;
}
/**
* Returns the theme hook definition information.
*
* This base-theme's custom theme hook implementations. Never define "path"
* as this is automatically detected and added.
*
* @see \Drupal\bootstrap3\Plugin\Alter\ThemeRegistry::alter()
* @see bootstrap_theme_registry_alter()
* @see bootstrap_theme()
* @see hook_theme()
*/
public static function getThemeHooks() {
$hooks['bootstrap_carousel'] = [
'variables' => [
'attributes' => [],
'controls' => TRUE,
'id' => NULL,
'indicators' => TRUE,
'interval' => 5000,
'pause' => 'hover',
'slides' => [],
'start_index' => 0,
'wrap' => TRUE,
],
];
$hooks['bootstrap_dropdown'] = [
'variables' => [
'alignment' => 'down',
'attributes' => [],
'items' => [],
'split' => FALSE,
'toggle' => NULL,
],
];
$hooks['bootstrap_modal'] = [
'variables' => [
'attributes' => [],
'body' => '',
'body_attributes' => [],
'close_button' => TRUE,
'content_attributes' => [],
'description' => NULL,
'description_display' => 'before',
'dialog_attributes' => [],
'footer' => '',
'footer_attributes' => [],
'header_attributes' => [],
'id' => NULL,
'size' => NULL,
'title' => '',
'title_attributes' => [],
],
];
$hooks['bootstrap_panel'] = [
'variables' => [
'attributes' => [],
'body' => [],
'body_attributes' => [],
'collapsible' => FALSE,
'collapsed' => FALSE,
'description' => NULL,
'description_display' => 'before',
'footer' => NULL,
'footer_attributes' => [],
'heading' => NULL,
'heading_attributes' => [],
'id' => NULL,
'panel_type' => 'default',
],
];
return $hooks;
}
/**
* Returns a specific Bootstrap Glyphicon.
*
* @param string $name
* The icon name, minus the "glyphicon-" prefix.
* @param array $default
* (Optional) The default render array to use if $name is not available.
*
* @return array
* The render containing the icon defined by $name, $default value if
* icon does not exist or returns NULL if no icon could be rendered.
*/
public static function glyphicon($name, array $default = []) {
$icon = [];
// Ensure the icon specified is a valid Bootstrap Glyphicon.
// @todo Supply a specific version to _bootstrap3_glyphicons() when Icon API
// supports versioning.
if (self::getTheme()->hasGlyphicons() && in_array($name, self::glyphicons())) {
// Attempt to use the Icon API module, if enabled and it generates output.
if (\Drupal::moduleHandler()->moduleExists('icon')) {
$icon = [
'#type' => 'icon',
'#bundle' => 'bootstrap3',
'#icon' => 'glyphicon-' . $name,
];
}
else {
$icon = [
'#type' => 'html_tag',
'#tag' => 'span',
'#value' => '',
'#attributes' => [
'class' => ['icon', 'glyphicon', 'glyphicon-' . $name],
'aria-hidden' => 'true',
],
];
}
}
return $icon ?: $default;
}
/**
* Matches a Bootstrap Glyphicon based on a string value.
*
* @param string $value
* The string to match against to determine the icon. Passed by reference
* in case it is a render array that needs to be rendered and typecast.
* @param array $default
* The default render array to return if no match is found.
*
* @return array
* The Bootstrap icon matched against the value of $haystack or $default if
* no match could be made.
*/
public static function glyphiconFromString(&$value, array $default = []) {
static $lang;
if (!isset($lang)) {
$lang = \Drupal::languageManager()->getCurrentLanguage()->getId();
}
$theme = static::getTheme();
$texts = $theme->getCache('glyphiconFromString', [$lang]);
// Ensure it's a string value that was passed.
$string = static::toString($value);
if ($texts->isEmpty()) {
$data = [
// Text that match these specific strings are checked first.
'matches' => [],
// Text containing these words anywhere in the string are checked last.
'contains' => [
t('Manage')->render() => 'cog',
t('Configure')->render() => 'cog',
t('Settings')->render() => 'cog',
t('Download')->render() => 'download',
t('Export')->render() => 'export',
t('Filter')->render() => 'filter',
t('Import')->render() => 'import',
t('Save')->render() => 'ok',
t('Update')->render() => 'ok',
t('Edit')->render() => 'pencil',
t('Uninstall')->render() => 'trash',
t('Install')->render() => 'plus',
t('Write')->render() => 'plus',
t('Cancel')->render() => 'remove',
t('Delete')->render() => 'trash',
t('Remove')->render() => 'trash',
t('Reset')->render() => 'trash',
t('Search')->render() => 'search',
t('Upload')->render() => 'upload',
t('Preview')->render() => 'eye-open',
t('Log in')->render() => 'log-in',
],
];
// Allow sub-themes to alter this array of patterns.
/** @var \Drupal\Core\Theme\ThemeManager $theme_manager */
$theme_manager = \Drupal::service('theme.manager');
$theme_manager->alter('bootstrap_iconize_text', $data);
$texts->setMultiple($data);
}
// Iterate over the array.
foreach ($texts as $pattern => $strings) {
foreach ($strings as $text => $icon) {
switch ($pattern) {
case 'matches':
if ($string === $text) {
return self::glyphicon($icon, $default);
}
break;
case 'contains':
if (strpos(mb_strtolower($string), mb_strtolower($text)) !== FALSE) {
return self::glyphicon($icon, $default);
}
break;
}
}
}
// Return a default icon if nothing was matched.
return $default;
}
/**
* Returns a list of available Bootstrap Framework Glyphicons.
*
* @param string $version
* The specific version of glyphicons to return. If not set, the latest
* BOOTSTRAP_VERSION will be used.
*
* @return array
* An associative array of icons keyed by their classes.
*/
public static function glyphicons($version = NULL) {
static $versions;
if (!isset($versions)) {
$versions = [];
$versions['3.0.0'] = [
// Class => Name.
'glyphicon-adjust' => 'adjust',
'glyphicon-align-center' => 'align-center',
'glyphicon-align-justify' => 'align-justify',
'glyphicon-align-left' => 'align-left',
'glyphicon-align-right' => 'align-right',
'glyphicon-arrow-down' => 'arrow-down',
'glyphicon-arrow-left' => 'arrow-left',
'glyphicon-arrow-right' => 'arrow-right',
'glyphicon-arrow-up' => 'arrow-up',
'glyphicon-asterisk' => 'asterisk',
'glyphicon-backward' => 'backward',
'glyphicon-ban-circle' => 'ban-circle',
'glyphicon-barcode' => 'barcode',
'glyphicon-bell' => 'bell',
'glyphicon-bold' => 'bold',
'glyphicon-book' => 'book',
'glyphicon-bookmark' => 'bookmark',
'glyphicon-briefcase' => 'briefcase',
'glyphicon-bullhorn' => 'bullhorn',
'glyphicon-calendar' => 'calendar',
'glyphicon-camera' => 'camera',
'glyphicon-certificate' => 'certificate',
'glyphicon-check' => 'check',
'glyphicon-chevron-down' => 'chevron-down',
'glyphicon-chevron-left' => 'chevron-left',
'glyphicon-chevron-right' => 'chevron-right',
'glyphicon-chevron-up' => 'chevron-up',
'glyphicon-circle-arrow-down' => 'circle-arrow-down',
'glyphicon-circle-arrow-left' => 'circle-arrow-left',
'glyphicon-circle-arrow-right' => 'circle-arrow-right',
'glyphicon-circle-arrow-up' => 'circle-arrow-up',
'glyphicon-cloud' => 'cloud',
'glyphicon-cloud-download' => 'cloud-download',
'glyphicon-cloud-upload' => 'cloud-upload',
'glyphicon-cog' => 'cog',
'glyphicon-collapse-down' => 'collapse-down',
'glyphicon-collapse-up' => 'collapse-up',
'glyphicon-comment' => 'comment',
'glyphicon-compressed' => 'compressed',
'glyphicon-copyright-mark' => 'copyright-mark',
'glyphicon-credit-card' => 'credit-card',
'glyphicon-cutlery' => 'cutlery',
'glyphicon-dashboard' => 'dashboard',
'glyphicon-download' => 'download',
'glyphicon-download-alt' => 'download-alt',
'glyphicon-earphone' => 'earphone',
'glyphicon-edit' => 'edit',
'glyphicon-eject' => 'eject',
'glyphicon-envelope' => 'envelope',
'glyphicon-euro' => 'euro',
'glyphicon-exclamation-sign' => 'exclamation-sign',
'glyphicon-expand' => 'expand',
'glyphicon-export' => 'export',
'glyphicon-eye-close' => 'eye-close',
'glyphicon-eye-open' => 'eye-open',
'glyphicon-facetime-video' => 'facetime-video',
'glyphicon-fast-backward' => 'fast-backward',
'glyphicon-fast-forward' => 'fast-forward',
'glyphicon-file' => 'file',
'glyphicon-film' => 'film',
'glyphicon-filter' => 'filter',
'glyphicon-fire' => 'fire',
'glyphicon-flag' => 'flag',
'glyphicon-flash' => 'flash',
'glyphicon-floppy-disk' => 'floppy-disk',
'glyphicon-floppy-open' => 'floppy-open',
'glyphicon-floppy-remove' => 'floppy-remove',
'glyphicon-floppy-save' => 'floppy-save',
'glyphicon-floppy-saved' => 'floppy-saved',
'glyphicon-folder-close' => 'folder-close',
'glyphicon-folder-open' => 'folder-open',
'glyphicon-font' => 'font',
'glyphicon-forward' => 'forward',
'glyphicon-fullscreen' => 'fullscreen',
'glyphicon-gbp' => 'gbp',
'glyphicon-gift' => 'gift',
'glyphicon-glass' => 'glass',
'glyphicon-globe' => 'globe',
'glyphicon-hand-down' => 'hand-down',
'glyphicon-hand-left' => 'hand-left',
'glyphicon-hand-right' => 'hand-right',
'glyphicon-hand-up' => 'hand-up',
'glyphicon-hd-video' => 'hd-video',
'glyphicon-hdd' => 'hdd',
'glyphicon-header' => 'header',
'glyphicon-headphones' => 'headphones',
'glyphicon-heart' => 'heart',
'glyphicon-heart-empty' => 'heart-empty',
'glyphicon-home' => 'home',
'glyphicon-import' => 'import',
'glyphicon-inbox' => 'inbox',
'glyphicon-indent-left' => 'indent-left',
'glyphicon-indent-right' => 'indent-right',
'glyphicon-info-sign' => 'info-sign',
'glyphicon-italic' => 'italic',
'glyphicon-leaf' => 'leaf',
'glyphicon-link' => 'link',
'glyphicon-list' => 'list',
'glyphicon-list-alt' => 'list-alt',
'glyphicon-lock' => 'lock',
'glyphicon-log-in' => 'log-in',
'glyphicon-log-out' => 'log-out',
'glyphicon-magnet' => 'magnet',
'glyphicon-map-marker' => 'map-marker',
'glyphicon-minus' => 'minus',
'glyphicon-minus-sign' => 'minus-sign',
'glyphicon-move' => 'move',
'glyphicon-music' => 'music',
'glyphicon-new-window' => 'new-window',
'glyphicon-off' => 'off',
'glyphicon-ok' => 'ok',
'glyphicon-ok-circle' => 'ok-circle',
'glyphicon-ok-sign' => 'ok-sign',
'glyphicon-open' => 'open',
'glyphicon-paperclip' => 'paperclip',
'glyphicon-pause' => 'pause',
'glyphicon-pencil' => 'pencil',
'glyphicon-phone' => 'phone',
'glyphicon-phone-alt' => 'phone-alt',
'glyphicon-picture' => 'picture',
'glyphicon-plane' => 'plane',
'glyphicon-play' => 'play',
'glyphicon-play-circle' => 'play-circle',
'glyphicon-plus' => 'plus',
'glyphicon-plus-sign' => 'plus-sign',
'glyphicon-print' => 'print',
'glyphicon-pushpin' => 'pushpin',
'glyphicon-qrcode' => 'qrcode',
'glyphicon-question-sign' => 'question-sign',
'glyphicon-random' => 'random',
'glyphicon-record' => 'record',
'glyphicon-refresh' => 'refresh',
'glyphicon-registration-mark' => 'registration-mark',
'glyphicon-remove' => 'remove',
'glyphicon-remove-circle' => 'remove-circle',
'glyphicon-remove-sign' => 'remove-sign',
'glyphicon-repeat' => 'repeat',
'glyphicon-resize-full' => 'resize-full',
'glyphicon-resize-horizontal' => 'resize-horizontal',
'glyphicon-resize-small' => 'resize-small',
'glyphicon-resize-vertical' => 'resize-vertical',
'glyphicon-retweet' => 'retweet',
'glyphicon-road' => 'road',
'glyphicon-save' => 'save',
'glyphicon-saved' => 'saved',
'glyphicon-screenshot' => 'screenshot',
'glyphicon-sd-video' => 'sd-video',
'glyphicon-search' => 'search',
'glyphicon-send' => 'send',
'glyphicon-share' => 'share',
'glyphicon-share-alt' => 'share-alt',
'glyphicon-shopping-cart' => 'shopping-cart',
'glyphicon-signal' => 'signal',
'glyphicon-sort' => 'sort',
'glyphicon-sort-by-alphabet' => 'sort-by-alphabet',
'glyphicon-sort-by-alphabet-alt' => 'sort-by-alphabet-alt',
'glyphicon-sort-by-attributes' => 'sort-by-attributes',
'glyphicon-sort-by-attributes-alt' => 'sort-by-attributes-alt',
'glyphicon-sort-by-order' => 'sort-by-order',
'glyphicon-sort-by-order-alt' => 'sort-by-order-alt',
'glyphicon-sound-5-1' => 'sound-5-1',
'glyphicon-sound-6-1' => 'sound-6-1',
'glyphicon-sound-7-1' => 'sound-7-1',
'glyphicon-sound-dolby' => 'sound-dolby',
'glyphicon-sound-stereo' => 'sound-stereo',
'glyphicon-star' => 'star',
'glyphicon-star-empty' => 'star-empty',
'glyphicon-stats' => 'stats',
'glyphicon-step-backward' => 'step-backward',
'glyphicon-step-forward' => 'step-forward',
'glyphicon-stop' => 'stop',
'glyphicon-subtitles' => 'subtitles',
'glyphicon-tag' => 'tag',
'glyphicon-tags' => 'tags',
'glyphicon-tasks' => 'tasks',
'glyphicon-text-height' => 'text-height',
'glyphicon-text-width' => 'text-width',
'glyphicon-th' => 'th',
'glyphicon-th-large' => 'th-large',
'glyphicon-th-list' => 'th-list',
'glyphicon-thumbs-down' => 'thumbs-down',
'glyphicon-thumbs-up' => 'thumbs-up',
'glyphicon-time' => 'time',
'glyphicon-tint' => 'tint',
'glyphicon-tower' => 'tower',
'glyphicon-transfer' => 'transfer',
'glyphicon-trash' => 'trash',
'glyphicon-tree-conifer' => 'tree-conifer',
'glyphicon-tree-deciduous' => 'tree-deciduous',
'glyphicon-unchecked' => 'unchecked',
'glyphicon-upload' => 'upload',
'glyphicon-usd' => 'usd',
'glyphicon-user' => 'user',
'glyphicon-volume-down' => 'volume-down',
'glyphicon-volume-off' => 'volume-off',
'glyphicon-volume-up' => 'volume-up',
'glyphicon-warning-sign' => 'warning-sign',
'glyphicon-wrench' => 'wrench',
'glyphicon-zoom-in' => 'zoom-in',
'glyphicon-zoom-out' => 'zoom-out',
];
$versions['3.0.1'] = $versions['3.0.0'];
$versions['3.0.2'] = $versions['3.0.1'];
$versions['3.0.3'] = $versions['3.0.2'];
$versions['3.1.0'] = $versions['3.0.3'];
$versions['3.1.1'] = $versions['3.1.0'];
$versions['3.2.0'] = $versions['3.1.1'];
$versions['3.3.0'] = array_merge($versions['3.2.0'], [
'glyphicon-eur' => 'eur',
]);
$versions['3.3.1'] = $versions['3.3.0'];
$versions['3.3.2'] = array_merge($versions['3.3.1'], [
'glyphicon-alert' => 'alert',
'glyphicon-apple' => 'apple',
'glyphicon-baby-formula' => 'baby-formula',
'glyphicon-bed' => 'bed',
'glyphicon-bishop' => 'bishop',
'glyphicon-bitcoin' => 'bitcoin',
'glyphicon-blackboard' => 'blackboard',
'glyphicon-cd' => 'cd',
'glyphicon-console' => 'console',
'glyphicon-copy' => 'copy',
'glyphicon-duplicate' => 'duplicate',
'glyphicon-education' => 'education',
'glyphicon-equalizer' => 'equalizer',
'glyphicon-erase' => 'erase',
'glyphicon-grain' => 'grain',
'glyphicon-hourglass' => 'hourglass',
'glyphicon-ice-lolly' => 'ice-lolly',
'glyphicon-ice-lolly-tasted' => 'ice-lolly-tasted',
'glyphicon-king' => 'king',
'glyphicon-knight' => 'knight',
'glyphicon-lamp' => 'lamp',
'glyphicon-level-up' => 'level-up',
'glyphicon-menu-down' => 'menu-down',
'glyphicon-menu-hamburger' => 'menu-hamburger',
'glyphicon-menu-left' => 'menu-left',
'glyphicon-menu-right' => 'menu-right',
'glyphicon-menu-up' => 'menu-up',
'glyphicon-modal-window' => 'modal-window',
'glyphicon-object-align-bottom' => 'object-align-bottom',
'glyphicon-object-align-horizontal' => 'object-align-horizontal',
'glyphicon-object-align-left' => 'object-align-left',
'glyphicon-object-align-right' => 'object-align-right',
'glyphicon-object-align-top' => 'object-align-top',
'glyphicon-object-align-vertical' => 'object-align-vertical',
'glyphicon-oil' => 'oil',
'glyphicon-open-file' => 'open-file',
'glyphicon-option-horizontal' => 'option-horizontal',
'glyphicon-option-vertical' => 'option-vertical',
'glyphicon-paste' => 'paste',
'glyphicon-pawn' => 'pawn',
'glyphicon-piggy-bank' => 'piggy-bank',
'glyphicon-queen' => 'queen',
'glyphicon-ruble' => 'ruble',
'glyphicon-save-file' => 'save-file',
'glyphicon-scale' => 'scale',
'glyphicon-scissors' => 'scissors',
'glyphicon-subscript' => 'subscript',
'glyphicon-sunglasses' => 'sunglasses',
'glyphicon-superscript' => 'superscript',
'glyphicon-tent' => 'tent',
'glyphicon-text-background' => 'text-background',
'glyphicon-text-color' => 'text-color',
'glyphicon-text-size' => 'text-size',
'glyphicon-triangle-bottom' => 'triangle-bottom',
'glyphicon-triangle-left' => 'triangle-left',
'glyphicon-triangle-right' => 'triangle-right',
'glyphicon-triangle-top' => 'triangle-top',
'glyphicon-yen' => 'yen',
]);
$versions['3.3.4'] = array_merge($versions['3.3.2'], [
'glyphicon-btc' => 'btc',
'glyphicon-jpy' => 'jpy',
'glyphicon-rub' => 'rub',
'glyphicon-xbt' => 'xbt',
]);
$versions['3.3.5'] = $versions['3.3.4'];
$versions['3.3.6'] = $versions['3.3.5'];
$versions['3.3.7'] = $versions['3.3.6'];
$versions['3.4.0'] = $versions['3.3.7'];
$versions['3.4.1'] = $versions['3.4.0'];
$versions['3.4.4'] = $versions['3.4.1'];
}
// Return a specific versions icon set.
if (isset($version) && isset($versions[$version])) {
return $versions[$version];
}
// Return the latest version.
return $versions[self::FRAMEWORK_VERSION];
}
/**
* Determines if the "cache_context.url.path.is_front" service exists.
*
* @return bool
* TRUE or FALSE
*
* @see \Drupal\bootstrap3\Bootstrap::isFront
* @see \Drupal\bootstrap3\Bootstrap::preprocess
* @see https://www.drupal.org/node/2829588
*/
public static function hasIsFrontCacheContext() {
static $has_is_front_cache_context;
if (!isset($has_is_front_cache_context)) {
$has_is_front_cache_context = \Drupal::getContainer()->has('cache_context.url.path.is_front');
}
return $has_is_front_cache_context;
}
/**
* Initializes the active theme.
*/
final public static function initialize() {
static $initialized = FALSE;
if (!$initialized) {
// Initialize the active theme.
$active_theme = self::getTheme();
// Include deprecated functions.
foreach ($active_theme->getAncestry() as $ancestor) {
if ($ancestor->getSetting('include_deprecated')) {
$files = $ancestor->fileScan('/^deprecated\.php$/');
if ($file = reset($files)) {
$ancestor->includeOnce($file->uri, FALSE);
}
}
}
$initialized = TRUE;
}
}
/**
* Checks whether a user is an administrator.
*
* @param \Drupal\Core\Session\AccountInterface $account
* Optional. A specific account to check. If not set, the currently logged
* in user account will be used.
*
* @return bool
* TRUE or FALSE
*/
public static function isAdmin(?AccountInterface $account = NULL) {
static $admins = [];
// Use the currently logged in user if no account was explicitly specified.
if (!$account) {
$account = \Drupal::currentUser();
}
$id = (int) $account->id();
if (!isset($admins[$id])) {
$admins[$id] = $account->hasPermission('access administration pages');
}
return $admins[$id];
}
/**
* Determines if the current path is the "front" page.
*
* *Note:* This method will not return `TRUE` if there is not a proper
* "cache_context.url.path.is_front" service defined.
*
* *Note:* If using this method in preprocess/render array logic, the proper
* #cache context must also be defined:
*
* ```php
* $variables['#cache']['contexts'][] = 'url.path.is_front';
* ```
*
* @return bool
* TRUE or FALSE
*
* @see \Drupal\bootstrap3\Bootstrap::hasIsFrontCacheContext
* @see \Drupal\bootstrap3\Bootstrap::preprocess
* @see https://www.drupal.org/node/2829588
*/
public static function isFront() {
static $is_front;
if (!isset($is_front)) {
try {
$is_front = static::hasIsFrontCacheContext() ? \Drupal::service('path.matcher')->isFrontPage() : FALSE;
}
catch (\Exception $e) {
$is_front = FALSE;
}
}
return $is_front;
}
/**
* Wrapper to use new Messenger service or the legacy procedural function.
*
* This is to help support older installations without trigger deprecation
* notices for newer installations.
*
* @param string|\Drupal\Component\Render\MarkupInterface $message
* (optional) The translated message to be displayed to the user. For
* consistency with other messages, it should begin with a capital letter
* and end with a period.
* @param string $type
* (optional) The message's type. Defaults to 'status'. These values are
* supported:
* - 'status'
* - 'warning'
* - 'error'.
* @param bool $repeat
* (optional) If this is FALSE and the message is already set, then the
* message won't be repeated. Defaults to FALSE.
*
* @see \Drupal\Core\Messenger\MessengerInterface
* @see drupal_set_message()
* @see https://www.drupal.org/node/2774931
*
* @deprecated in 8.x-3.18 and will be removed in a future release.
* Use \Drupal\Core\Messenger\MessengerInterface::addMessage() instead.
* @see https://www.drupal.org/project/bootstrap/issues/3096963
*/
public static function message($message, $type = 'status', $repeat = FALSE) {
if (!isset(static::$messenger)) {
static::$messenger = \Drupal::hasService('messenger') ? \Drupal::service('messenger') : FALSE;
}
if (static::$messenger) {
static::$messenger->addMessage($message, $type, $repeat);
}
}
/**
* Preprocess theme hook variables.
*
* @param array $variables
* The variables array, passed by reference.
* @param string $hook
* The name of the theme hook.
* @param array $info
* The theme hook info.
*/
public static function preprocess(array &$variables, $hook, array $info) {
// Do not statically cache this as the active theme may change.
$theme = static::getTheme();
$theme_name = $theme->getName();
// Handle preprocess managers.
static $drupal_static_fast;
if (!isset($drupal_static_fast)) {
$drupal_static_fast['preprocess_managers'] = &drupal_static(__METHOD__ . '__preprocessManagers', []);
$drupal_static_fast['theme_info'] = &drupal_static(__METHOD__ . '__themeInfo', []);
}
/** @var \Drupal\bootstrap3\Plugin\PreprocessManager[] $preprocess_managers */
$preprocess_managers = &$drupal_static_fast['preprocess_managers'];
if (!isset($preprocess_managers[$theme_name])) {
$preprocess_managers[$theme_name] = new PreprocessManager($theme);
}
// Retrieve the theme info that will be used in the variables.
$theme_info = &$drupal_static_fast['theme_info'];
if (!isset($theme_info[$theme_name])) {
$theme_info[$theme_name] = $theme->getInfo();
$theme_info[$theme_name]['dev'] = $theme->isDev();
$theme_info[$theme_name]['livereload'] = $theme->livereloadUrl();
$theme_info[$theme_name]['name'] = $theme->getName();
$theme_info[$theme_name]['path'] = $theme->getPath();
$theme_info[$theme_name]['title'] = $theme->getTitle();
$theme_info[$theme_name]['settings'] = $theme->settings()->get();
$theme_info[$theme_name]['has_glyphicons'] = $theme->hasGlyphicons();
$theme_info[$theme_name]['query_string'] = \Drupal::getContainer()->get('state')->get('system.css_js_query_string') ?: '0';
}
// Retrieve the preprocess manager for this theme.
$preprocess_manager = $preprocess_managers[$theme_name];
// Add a global "is_admin" variable back to all templates.
if (!isset($variables['is_admin'])) {
$variables['is_admin'] = static::isAdmin();
}
// Adds a global "is_front" variable back to all templates.
// @see https://www.drupal.org/node/2829585
if (!isset($variables['is_front'])) {
$variables['is_front'] = static::isFront();
if (static::hasIsFrontCacheContext()) {
$variables['#cache']['contexts'][] = 'url.path.is_front';
}
}
// Ensure that any default theme hook variables exist. Due to how theme
// hook suggestion alters work, the variables provided are from the
// original theme hook, not the suggestion.
if (isset($info['variables'])) {
$variables = NestedArray::mergeDeepArray([$info['variables'], $variables], TRUE);
}
// Add active theme context.
// @see https://www.drupal.org/node/2630870
if (!isset($variables['theme'])) {
$variables['theme'] = $theme_info[$theme_name];
}
// Invoke necessary preprocess plugin.
if (isset($info['bootstrap preprocess'])) {
if ($preprocess_manager->hasDefinition($info['bootstrap preprocess'])) {
$class = $preprocess_manager->createInstance($info['bootstrap preprocess'], ['theme' => $theme]);
/** @var \Drupal\bootstrap3\Plugin\Preprocess\PreprocessInterface $class */
$class->preprocess($variables, $hook, $info);
}
}
}
/**
* Renders a custom Twig template not registered in the theme system.
*
* Note: any template ending in .html.twig will be registered with the theme
* system automatically (that is simply how it works). For HTML based
* standalone Twig templates, just use .twig (without the .html prefix). For
* other file types, you may still use a prefix for the IDE to recognize the
* file type (e.g. .css.twig).
*
* @param string $path
* The path to the template.
* @param array $variables
* The variables to pass to the template.
* @param \Drupal\Core\Render\RenderContext $renderContext
* Optional. A RenderContext object to pass to the renderer.
*
* @return \Drupal\Component\Render\MarkupInterface
* The rendered template.
*
* @throws \RuntimeException
* If $path does not exist.
* @throws \InvalidArgumentException
* If $path references a Twig template already registered in the theme
* system.
*/
public static function renderCustomTemplate($path, array $variables = [], ?RenderContext $renderContext = NULL) {
$realpath = realpath($path);
if (!file_exists($realpath)) {
throw new \RuntimeException(sprintf('Template does not exist: %s', $realpath));
}
// Ensure provided template isn't actually registered in the theme system.
$registry = static::themeRegistry()->get();
foreach ($registry as $hook => $info) {
// Only process template based theme hooks.
if (!isset($info['path']) || !isset($info['template'])) {
continue;
}
$registered = realpath($info['path'] . '/' . $info['template'] . '.html.twig');
if ($registered === $realpath) {
$basename = basename($path);
$example = "\n\n\$build = [\n '#theme' => '$hook',\n /* Other properties */\n];\n\Drupal::service('renderer')->renderPlain(\$build);\n\n";
throw new \InvalidArgumentException(sprintf('The template provided is not a standalone Twig template: "%s". This template is already registered in Drupal\'s Theme System as "%s". If this template is intended to be truly standalone, you can change the file extension from ".html.twig" to just ".twig". Otherwise, if this is a properly registered template in the Theme System, you should render it using Drupal\'s existing Render API and not this method: %s', $basename, $hook, $example));
}
}
$template = file_get_contents($realpath);
if (!isset($renderContext)) {
$renderContext = new RenderContext();
}
// Render the template.
$output = static::renderer()->executeInRenderContext($renderContext, function () use ($template, $variables) {
return static::twig()->createTemplate($template)->render($variables);
});
return Markup::create($output);
}
/**
* Helper function for writing data to the file system.
*
* Note: this is specifically designed with replacing chunks of existing
* data in mind.
*
* @param string $path
* The path to the file where the data will be written.
* @param string $data
* The data to write to $file.
* @param string $start
* Optional. A marker determining where to begin injecting $data.
* Note: this value is used within a regular expression.
* @param string $end
* Optional. A marker determining where to stop injecting $data. This is
* primarily useful for replacing a "chunk" of data within a file.
* Note: this value is used within a regular expression.
*
* @return bool
* TRUE if the file was successfully written, FALSE otherwise.
*/
public static function putContents($path, $data, $start = NULL, $end = NULL) {
$realpath = realpath($path) ?: $path;
// Markers used, build regular expression to split any existing content.
if ($start || $end) {
$regExp = [];
if ($start) {
$regExp[] = preg_quote($start, '/');
}
if ($end) {
$regExp[] = preg_quote($end, '/');
}
$regExp = implode('|', $regExp);
$parts = @preg_split("/$regExp/", @file_get_contents($realpath) ?: '') ?: [];
$replaced = isset($parts[0]) ? trim($parts[0]) . "\n" : '';
$replaced .= "$data\n";
$replaced .= isset($parts[2]) ? trim($parts[2]) . "\n" : '';
$data = $replaced;
}
return !!file_put_contents($realpath, $data) !== FALSE;
}
/**
* Retrieves the Renderer service.
*
* @return \Drupal\Core\Render\Renderer
* The Renderer service.
*/
public static function renderer() {
if (!isset(static::$renderer)) {
static::$renderer = \Drupal::service('renderer');
}
return static::$renderer;
}
/**
* Retrieves the Theme Registry service.
*
* @return \Drupal\Core\Theme\Registry
* The Theme Registry service.
*/
public static function themeRegistry() {
if (!isset(static::$themeRegistry)) {
static::$themeRegistry = \Drupal::service('theme.registry');
}
return static::$themeRegistry;
}
/**
* Ensures a value is typecast to a string, rendering an array if necessary.
*
* @param string|array $value
* The value to typecast, passed by reference.
*
* @return string
* The typecast string value.
*/
public static function toString(&$value) {
return (string) (Element::isRenderArray($value) ? Element::create($value)->renderPlain() : $value);
}
/**
* Retrieves the Twig service.
*
* @return \Drupal\Core\Template\TwigEnvironment
* The Twig service.
*/
public static function twig() {
if (!isset(static::$twig)) {
static::$twig = \Drupal::service('twig');
}
return static::$twig;
}
}
