diff --git a/cache_example/src/Forms/CacheExampleForm.php b/cache_example/src/Forms/CacheExampleForm.php index 11c5f4c..aa49b95 100644 --- a/cache_example/src/Forms/CacheExampleForm.php +++ b/cache_example/src/Forms/CacheExampleForm.php @@ -11,6 +11,10 @@ use Drupal\Core\Form\FormBase; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Cache\Cache; use Drupal\Core\Cache\CacheBackendInterface; +use Drupal\Core\Session\AccountProxyInterface; +use Drupal\Core\StringTranslation\TranslationInterface; +use Symfony\Component\DependencyInjection\ContainerInterface; +use Symfony\Component\HttpFoundation\RequestStack; /** @@ -19,6 +23,61 @@ use Drupal\Core\Cache\CacheBackendInterface; class CacheExampleForm extends FormBase { /** + * The current user. + * + * @var \Drupal\Core\Session\AccountProxyInterface + */ + protected $currentUser; + + /** + * The cache.default cache backend. + * + * @var \Drupal\Core\Cache\CacheBackendInterface + */ + protected $cacheBackend; + + /** + * Dependency injection through the constructor. + * + * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack + * The request stack service. + * @param \Drupal\Core\StringTranslation\TranslationInterface $translation + * The string translation service. + * @param \Drupal\Core\Session\AccountProxyInterface $current_user + * The current active user service. + * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend + * The cache object associated with the default bin. + */ + public function __construct( + RequestStack $request_stack, + TranslationInterface $translation, + AccountProxyInterface $current_user, + CacheBackendInterface $cache_backend + ) { + $this->setRequestStack($request_stack); + $this->setStringTranslation($translation); + $this->currentUser = $current_user; + $this->cacheBackend = $cache_backend; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + // Forms that require a Drupal service or a custom service should access + // the service using dependency injection. + // @link https://www.drupal.org/node/2203931. + // Those services are passed in the $container through the static create + // method. + return new static( + $container->get('request_stack'), + $container->get('string_translation'), + $container->get('current_user'), + $container->get('cache.default') + ); + } + + /** * {@inheritdoc} */ public function getFormID() { @@ -39,7 +98,7 @@ class CacheExampleForm extends FormBase { // the object is to be saved. // // cache_get() returns the cached object or FALSE if object does not exist. - if ($cache = \Drupal::cache()->get('cache_example_files_count')) { + if ($cache = $this->cacheBackend->get('cache_example_files_count')) { /* * Get cached data. Complex data types will be unserialized automatically. */ @@ -55,109 +114,114 @@ class CacheExampleForm extends FormBase { // being saved into cache. // Here we use the default setting and create an unexpiring cache item. // See below for an example that creates an expiring cache item. - \Drupal::cache()->set('cache_example_files_count', $files_count, CacheBackendInterface::CACHE_PERMANENT); + $this->cacheBackend->set('cache_example_files_count', $files_count, CacheBackendInterface::CACHE_PERMANENT); } $end_time = microtime(TRUE); $duration = $end_time - $start_time; // Format intro message. - $intro_message = '

' . t('This example will search the entire drupal folder and display a count of the files in it.') . ' '; - $intro_message .= t('This can take a while, since there are a lot of files to be searched.') . ' '; - $intro_message .= t('We will search filesystem just once and save output to the cache. We will use cached data for later requests.') . '

'; - $intro_message .= '

' . t('Reload this page to see cache in action.', array('@url' => \Drupal::request()->getRequestUri())) . ' '; - $intro_message .= t('You can use the button below to remove cached data.') . '

'; + $intro_message = '

' . $this->t('This example will search the entire drupal folder and display a count of the files in it.') . ' '; + $intro_message .= $this->t('This can take a while, since there are a lot of files to be searched.') . ' '; + $intro_message .= $this->t('We will search filesystem just once and save output to the cache. We will use cached data for later requests.') . '

'; + $intro_message .= '

' + . $this->t( + 'Reload this page to see cache in action.', + array('@url' => $this->getRequest()->getRequestUri()) + ) + . ' '; + $intro_message .= $this->t('You can use the button below to remove cached data.') . '

'; $form['file_search'] = array( '#type' => 'fieldset', - '#title' => t('File search caching'), + '#title' => $this->t('File search caching'), ); $form['file_search']['introduction'] = array( '#markup' => $intro_message, ); $color = empty($cache) ? 'red' : 'green'; - $retrieval = empty($cache) ? t('calculated by traversing the filesystem') : t('retrieved from cache'); + $retrieval = empty($cache) ? $this->t('calculated by traversing the filesystem') : $this->t('retrieved from cache'); $form['file_search']['statistics'] = array( '#type' => 'item', - '#markup' => t('%count files exist in this Drupal installation; @retrieval in @time ms.
(Source: @source)', array( + '#markup' => $this->t('%count files exist in this Drupal installation; @retrieval in @time ms.
(Source: @source)', array( '%count' => $files_count, '@retrieval' => $retrieval, '@time' => number_format($duration * 1000, 2), '@color' => $color, - '@source' => empty($cache) ? t('actual file search') : t('cached'), + '@source' => empty($cache) ? $this->t('actual file search') : $this->t('cached'), ) ), ); $form['file_search']['remove_file_count'] = array( '#type' => 'submit', '#submit' => array(array($this, 'expireFiles')), - '#value' => t('Explicitly remove cached file count'), + '#value' => $this->t('Explicitly remove cached file count'), ); $form['expiration_demo'] = array( '#type' => 'fieldset', - '#title' => t('Cache expiration settings'), + '#title' => $this->t('Cache expiration settings'), ); $form['expiration_demo']['explanation'] = array( - '#markup' => t('A cache item can be set as CACHE_PERMANENT, meaning that it will only be removed when explicitly cleared, or it can have an expiration time (a Unix timestamp).'), + '#markup' => $this->t('A cache item can be set as CACHE_PERMANENT, meaning that it will only be removed when explicitly cleared, or it can have an expiration time (a Unix timestamp).'), ); - $item = \Drupal::cache()->get('cache_example_expiring_item', TRUE); + $item = $this->cacheBackend->get('cache_example_expiring_item', TRUE); if ($item == FALSE) { - $item_status = t('Cache item does not exist'); + $item_status = $this->t('Cache item does not exist'); } else { - $item_status = $item->valid ? t('Cache item exists and is set to expire at %time', array('%time' => $item->data)) : - t('Cache_item is invalid'); + $item_status = $item->valid ? $this->t('Cache item exists and is set to expire at %time', array('%time' => $item->data)) : + $this->t('Cache_item is invalid'); } $form['expiration_demo']['current_status'] = array( '#type' => 'item', - '#title' => t('Current status of cache item "cache_example_expiring_item"'), + '#title' => $this->t('Current status of cache item "cache_example_expiring_item"'), '#markup' => $item_status, ); $form['expiration_demo']['expiration'] = array( '#type' => 'select', - '#title' => t('Time before cache expiration'), + '#title' => $this->t('Time before cache expiration'), '#options' => array( - 'never_remove' => t('CACHE_PERMANENT'), - -10 => t('Immediate expiration'), - 10 => t('10 seconds from form submission'), - 60 => t('1 minute from form submission'), - 300 => t('5 minutes from form submission'), + 'never_remove' => $this->t('CACHE_PERMANENT'), + -10 => $this->t('Immediate expiration'), + 10 => $this->t('10 seconds from form submission'), + 60 => $this->t('1 minute from form submission'), + 300 => $this->t('5 minutes from form submission'), ), '#default_value' => -10, - '#description' => t('Any cache item can be set to only expire when explicitly cleared, or to expire at a given time.'), + '#description' => $this->t('Any cache item can be set to only expire when explicitly cleared, or to expire at a given time.'), ); $form['expiration_demo']['create_cache_item'] = array( '#type' => 'submit', - '#value' => t('Create a cache item with this expiration'), + '#value' => $this->t('Create a cache item with this expiration'), '#submit' => array(array($this, 'createExpiringItem')), ); $form['cache_clearing'] = array( '#type' => 'fieldset', - '#title' => t('Expire and remove options'), - '#description' => t("We have APIs to expire cached items and also to just remove them. Unfortunately, they're all the same API, cache_clear_all"), + '#title' => $this->t('Expire and remove options'), + '#description' => $this->t("We have APIs to expire cached items and also to just remove them. Unfortunately, they're all the same API, cache_clear_all"), ); $form['cache_clearing']['cache_clear_type'] = array( '#type' => 'radios', - '#title' => t('Type of cache clearing to do'), + '#title' => $this->t('Type of cache clearing to do'), '#options' => array( - 'expire' => t('Remove items from the "cache" bin that have expired'), - 'remove_all' => t('Remove all items from the "cache" bin regardless of expiration'), - 'remove_tag' => t('Remove all items in the "cache" bin with the tag "cache_example" set to 1'), + 'expire' => $this->t('Remove items from the "cache" bin that have expired'), + 'remove_all' => $this->t('Remove all items from the "cache" bin regardless of expiration'), + 'remove_tag' => $this->t('Remove all items in the "cache" bin with the tag "cache_example" set to 1'), ), '#default_value' => 'expire', ); // Submit button to clear cached data. $form['cache_clearing']['clear_expired'] = array( '#type' => 'submit', - '#value' => t('Clear or expire cache'), + '#value' => $this->t('Clear or expire cache'), '#submit' => array(array($this, 'cacheClearing')), - '#access' => \Drupal::currentUser()->hasPermission('administer site configuration'), + '#access' => $this->currentUser->hasPermission('administer site configuration'), ); return $form; @@ -175,10 +239,10 @@ class CacheExampleForm extends FormBase { // expiration time. The second argument (required here) is the cache bin. // Using cache_clear_all() explicitly in this way // forces removal of the cached item. - \Drupal::cache()->delete('cache_example_files_count'); + $this->cacheBackend->delete('cache_example_files_count'); // Display message to the user. - drupal_set_message(t('Cached data key "cache_example_files_count" was cleared.'), 'status'); + drupal_set_message($this->t('Cached data key "cache_example_files_count" was cleared.'), 'status'); } /** @@ -193,7 +257,7 @@ class CacheExampleForm extends FormBase { $interval = $form_state->getValue('expiration'); if ($interval == 'never_remove') { $expiration = CacheBackendInterface::CACHE_PERMANENT; - $expiration_friendly = t('Never expires'); + $expiration_friendly = $this->t('Never expires'); } else { $expiration = time() + $interval; @@ -202,8 +266,8 @@ class CacheExampleForm extends FormBase { // Set the expiration to the actual Unix timestamp of the end of the // required interval. Also add a tag to it to be able to clear caches more // precise. - \Drupal::cache()->set('cache_example_expiring_item', $expiration_friendly, $expiration, $tags); - drupal_set_message(t('cache_example_expiring_item was set to expire at %time', array('%time' => $expiration_friendly))); + $this->cacheBackend->set('cache_example_expiring_item', $expiration_friendly, $expiration, $tags); + drupal_set_message($this->t('cache_example_expiring_item was set to expire at %time', array('%time' => $expiration_friendly))); } /** @@ -214,15 +278,15 @@ class CacheExampleForm extends FormBase { case 'expire': // Here we'll remove all cache keys in the 'cache' bin that have // expired. - \Drupal::cache()->garbageCollection(); - drupal_set_message(t('\Drupal::cache()->garbageCollection() was called, removing any expired cache items.')); + $this->cacheBackend->garbageCollection(); + drupal_set_message($this->t('\Drupal::cache()->garbageCollection() was called, removing any expired cache items.')); break; case 'remove_all': // This removes all keys in a bin using a super-wildcard. This // has nothing to do with expiration. It's just brute-force removal. - \Drupal::cache()->deleteAll(); - drupal_set_message(t('ALL entries in the "cache" bin were removed with \Drupal::cache()->deleteAll().')); + $this->cacheBackend->deleteAll(); + drupal_set_message($this->t('ALL entries in the "cache" bin were removed with \Drupal::cache()->deleteAll().')); break; case 'remove_tag': @@ -232,7 +296,7 @@ class CacheExampleForm extends FormBase { 'cache_example:1', ); Cache::invalidateTags($tags); - drupal_set_message(t('Cache entries with the tag "cache_example" set to 1 in the "cache" bin were invalidated with \Drupal\Core\Cache\Cache::invalidateTags($tags).')); + drupal_set_message($this->t('Cache entries with the tag "cache_example" set to 1 in the "cache" bin were invalidated with \Drupal\Core\Cache\Cache::invalidateTags($tags).')); break; } }