Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\system\Tests\Cache;
Chris@0: 
Chris@18: @trigger_error(__NAMESPACE__ . '\CacheTestBase is deprecated for removal before Drupal 9.0.0. Use \Drupal\Tests\system\Functional\Cache\CacheTestBase instead. See https://www.drupal.org/node/2999939', E_USER_DEPRECATED);
Chris@18: 
Chris@0: use Drupal\simpletest\WebTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides helper methods for cache tests.
Chris@0:  *
Chris@0:  * @deprecated Scheduled for removal in Drupal 9.0.0.
Chris@0:  *   Use \Drupal\Tests\system\Functional\Cache\CacheTestBase instead.
Chris@18:  *
Chris@18:  * @see https://www.drupal.org/node/2999939
Chris@0:  */
Chris@0: abstract class CacheTestBase extends WebTestBase {
Chris@0: 
Chris@0:   protected $defaultBin = 'render';
Chris@0:   protected $defaultCid = 'test_temporary';
Chris@0:   protected $defaultValue = 'CacheTest';
Chris@0: 
Chris@0:   /**
Chris@0:    * Checks whether or not a cache entry exists.
Chris@0:    *
Chris@0:    * @param $cid
Chris@0:    *   The cache id.
Chris@0:    * @param $var
Chris@0:    *   The variable the cache should contain.
Chris@0:    * @param $bin
Chris@0:    *   The bin the cache item was stored in.
Chris@0:    * @return
Chris@0:    *   TRUE on pass, FALSE on fail.
Chris@0:    */
Chris@0:   protected function checkCacheExists($cid, $var, $bin = NULL) {
Chris@0:     if ($bin == NULL) {
Chris@0:       $bin = $this->defaultBin;
Chris@0:     }
Chris@0: 
Chris@0:     $cached = \Drupal::cache($bin)->get($cid);
Chris@0: 
Chris@0:     return isset($cached->data) && $cached->data == $var;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Asserts that a cache entry exists.
Chris@0:    *
Chris@0:    * @param $message
Chris@0:    *   Message to display.
Chris@0:    * @param $var
Chris@0:    *   The variable the cache should contain.
Chris@0:    * @param $cid
Chris@0:    *   The cache id.
Chris@0:    * @param $bin
Chris@0:    *   The bin the cache item was stored in.
Chris@0:    */
Chris@0:   protected function assertCacheExists($message, $var = NULL, $cid = NULL, $bin = NULL) {
Chris@0:     if ($bin == NULL) {
Chris@0:       $bin = $this->defaultBin;
Chris@0:     }
Chris@0:     if ($cid == NULL) {
Chris@0:       $cid = $this->defaultCid;
Chris@0:     }
Chris@0:     if ($var == NULL) {
Chris@0:       $var = $this->defaultValue;
Chris@0:     }
Chris@0: 
Chris@0:     $this->assertTrue($this->checkCacheExists($cid, $var, $bin), $message);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Asserts that a cache entry has been removed.
Chris@0:    *
Chris@0:    * @param $message
Chris@0:    *   Message to display.
Chris@0:    * @param $cid
Chris@0:    *   The cache id.
Chris@0:    * @param $bin
Chris@0:    *   The bin the cache item was stored in.
Chris@0:    */
Chris@0:   public function assertCacheRemoved($message, $cid = NULL, $bin = NULL) {
Chris@0:     if ($bin == NULL) {
Chris@0:       $bin = $this->defaultBin;
Chris@0:     }
Chris@0:     if ($cid == NULL) {
Chris@0:       $cid = $this->defaultCid;
Chris@0:     }
Chris@0: 
Chris@0:     $cached = \Drupal::cache($bin)->get($cid);
Chris@0:     $this->assertFalse($cached, $message);
Chris@0:   }
Chris@0: 
Chris@0: }