Schemas.php in Express 8
Contains \Drupal\bootstrap\Plugin\Setting\Schemas.
Namespace
Drupal\bootstrap\Plugin\SettingFile
themes/contrib/bootstrap/src/Plugin/Setting/Schemas.phpView source
<?php
/**
* @file
* Contains \Drupal\bootstrap\Plugin\Setting\Schemas.
*/
namespace Drupal\bootstrap\Plugin\Setting;
use Drupal\bootstrap\Annotation\BootstrapSetting;
use Drupal\bootstrap\Bootstrap;
use Drupal\bootstrap\Plugin\Form\SystemThemeSettings;
use Drupal\bootstrap\Utility\Element;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Form\FormStateInterface;
/**
* The "schemas" theme setting.
*
* @ingroup plugins_setting
* @ingroup plugins_update
*
* @BootstrapSetting(
* id = "schemas",
* type = "hidden",
* weight = -20,
* groups = false,
* )
*/
class Schemas extends SettingBase {
/**
* {@inheritdoc}
*/
public function alterFormElement(Element $form, FormStateInterface $form_state, $form_id = NULL) {
parent::alterFormElement($form, $form_state, $form_id);
$updates = [];
foreach ($this->theme
->getPendingUpdates() as $version => $update) {
$row = [];
$row[] = $update
->getSchema();
$row[] = new FormattableMarkup('<strong>@title</strong><p class="help-block">@description</p>', [
'@title' => $update
->getLabel(),
'@description' => $update
->getDescription(),
]);
$row[] = $update
->getTheme()
->getTitle();
$updates[] = [
'class' => [
$update
->getSeverity() ?: 'default',
],
'data' => $row,
];
}
$form['update'] = [
'#type' => 'details',
'#title' => $this
->t('Theme Updates'),
'#panel_type' => !!$updates ? 'primary' : 'default',
'#open' => !!$updates,
'#weight' => -20,
];
$form['update']['table'] = [
'#type' => 'table',
'#header' => [
t('Schema'),
t('Description'),
t('Provider'),
],
'#empty' => t('There are currently no pending updates for this theme.'),
'#rows' => $updates,
];
if ($updates) {
$form['update']['actions'] = [
'#type' => 'actions',
];
$form['update']['actions']['update'] = [
'#type' => 'submit',
'#value' => t('Update theme'),
'#icon' => Bootstrap::glyphicon('open'),
// @todo Setting a class like this is undesirable, create a suggestion.
'#attributes' => [
'class' => [
'btn-primary',
],
],
'#submit' => [
[
get_class($this),
'updateTheme',
],
],
];
}
}
/**
* Callback for updating a theme.
*
* @param array $form
* Nested array of form elements that comprise the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
public static function updateTheme(array $form, FormStateInterface $form_state) {
if ($theme = SystemThemeSettings::getTheme($form, $form_state)) {
// Due to the fact that the batch API stores it's arguments in DB storage,
// theme based objects cannot be passed as an operation argument here.
// During _batch_page(), the DB item will attempt to restore the arguments
// using unserialize() and the autoload fix include added below may not
// yet have been invoked to register the theme namespaces. So instead,
// we capture the relevant information needed to reconstruct these objects
// in the batch processing callback.
$theme_name = $theme
->getName();
// Create an operation for each update.
$operations = [];
foreach ($theme
->getPendingUpdates() as $update) {
$operations[] = [
[
__CLASS__,
'batchProcessUpdate',
],
[
$theme_name,
$update
->getProvider() . ':' . $update
->getSchema(),
],
];
}
if ($operations) {
$variables = [
'@theme_title' => $theme
->getTitle(),
];
batch_set([
'operations' => $operations,
'finished' => [
__CLASS__,
'batchFinished',
],
'title' => t('Updating @theme_title', $variables),
'init_message' => \Drupal::translation()
->formatPlural(count($operations), 'Initializing 1 theme update for @theme_title...', 'Initializing @count theme updates for @theme_title...', $variables),
'progress_message' => t('Processing update @current of @total...', $variables),
'error_message' => t('An error was encountered while attempting to update the @theme_title theme.', $variables),
'file' => Bootstrap::autoloadFixInclude(),
]);
}
}
}
/**
* Processes an update in a batch operation.
*
* @param string $theme_name
* The machine name of the theme this update is being applied to.
* @param string $update_id
* The combined identifier of the update being applied, e.g.
* provider:schema.
* @param array $context
* The batch context.
*/
public static function batchProcessUpdate($theme_name, $update_id, array &$context) {
// Reconstruct the theme object this update is being applied to.
$theme = Bootstrap::getTheme($theme_name);
// Reconstruct the update plugin that is being applied.
list($provider, $plugin_id) = explode(':', $update_id);
$provider = Bootstrap::getTheme($provider);
/** @type \Drupal\bootstrap\Plugin\Update\UpdateInterface $update */
$update = $provider
->getUpdateManager()
->createInstance($plugin_id, [
'theme' => $provider,
]);
// Initialize results with theme name and installed schemas.
if (!isset($context['results']['theme_name'])) {
$context['results']['theme_name'] = $theme_name;
}
if (!isset($context['results']['schemas'])) {
$context['results']['schemas'] = $theme
->getSetting('schemas', []);
}
$schemas =& $context['results']['schemas'];
$variables = [
'@theme' => $update
->getTheme()
->getName(),
'@schema' => $update
->getSchema(),
'@label' => $update
->getLabel(),
];
// Perform the update.
try {
// Attempt to perform the update.
if ($update
->update($theme, $context) === FALSE) {
throw new \Exception(t('Update failed'));
}
// Store the results.
$schemas[$update
->getTheme()
->getName()] = $update
->getSchema();
$context['results']['success'][] = t('<strong>[@theme][@schema] @label</strong>', $variables);
} catch (\Exception $e) {
$variables['@message'] = $e
->getMessage();
$context['results']['errors'][] = t('<strong>[@theme][@schema] @label</strong> - @message', $variables);
}
}
/**
* Batch 'finished' callback
*
* @param bool $success
* A boolean indicating whether the batch has completed successfully.
* @param array $results
* The value(s) set in $context['results'] in
* \Drupal\bootstrap\Plugin\Setting\Update::batchProcess().
* @param $operations
* If $success is FALSE, contains the operations that remained unprocessed.
*/
public static function batchFinished($success, $results, $operations) {
/** @type \Drupal\bootstrap\Theme $theme */
// Reconstruct the theme object this update is being applied to.
$theme = Bootstrap::getTheme($results['theme_name']);
// Save the current state of the installed schemas.
$theme
->setSetting('schemas', $results['schemas']);
// Show successful updates.
if (!empty($results['success'])) {
$list = Element::createStandalone([
'#theme' => 'item_list__theme_update',
'#items' => $results['success'],
'#context' => [
'type' => 'success',
],
]);
drupal_set_message(new FormattableMarkup('@message' . $list
->renderPlain(), [
'@message' => t('Successfully completed the following theme updates:'),
]));
}
// Show failed errors.
if (!empty($results['errors'])) {
$list = Element::createStandalone([
'#theme' => 'item_list__theme_update',
'#items' => $results['errors'],
'#context' => [
'type' => 'errors',
],
]);
drupal_set_message(new FormattableMarkup('@message' . $list
->renderPlain(), [
'@message' => t('The following theme updates could not be completed:'),
]), 'error');
}
}
}