class Blocache in Blocache (Block Cache Control) 8

Class Blocache.

Hierarchy

• class \Drupal\blocache\Blocache

2 string references to 'Blocache'

blocache.info.yml in ./blocache.info.yml

blocache.info.yml

blocache.services.yml in ./blocache.services.yml

blocache.services.yml

1 service uses Blocache

blocache in ./blocache.services.yml

Drupal\blocache\Blocache

File

src/Blocache.php, line 8

Namespace

Drupal\blocache

class Blocache {

  /**
   * Gets the available cache contexts.
   *
   * @return array
   *   Returns the available cache contexts.
   */
  public function cacheContexts() {
    $contexts = [];
    $container = \Drupal::getContainer();
    $services = $container
      ->getServiceIds();
    foreach ($services as $id) {
      if (strpos($id, 'cache_context.') !== 0) {
        continue;
      }
      $service = $container
        ->get($id);
      $class_name = get_class($service);
      $class = new \ReflectionClass($class_name);
      $parameters = $class
        ->getMethod('getContext')
        ->getParameters();
      $params = [];
      foreach ($parameters as $param) {
        $params[] = $param->name;
      }
      $context = substr($id, 14);
      $contexts[$context] = [
        'id' => $context,
        'params' => $params,
      ];
    }
    return $contexts;
  }

  /**
   * Prepares the cache contexts for storage into third-party setting.
   *
   * @param array $values
   *   The context values from block configuration.
   *
   *   The array must have key => value pairs respecting the standard:
   *     - {cache_context_name} => 'cache context name'
   *     - {cache_context_name}_arg => 'cache context argument'.
   *
   * @return array
   *   Returns an array with values respecting the standard:
   *   {cache_context_name}:{cache_context_name_arg}
   */
  public function prepareContextsToStorage(array $values) {
    $contexts = [];
    $i = 0;
    foreach ($values as $key => $value) {
      $count = strlen('__arg');
      if (substr($key, -$count) === '__arg') {
        continue;
      }
      if ($value === 1) {
        $contexts[$i] = $key;
        if ($arg = $values[$key . '__arg']) {
          $contexts[$i] .= ':' . $arg;
        }
        $i++;
      }
    }
    return $contexts;
  }

  /**
   * Prepares cache contexts to display them on the block configuration form.
   *
   * @param array $values
   *   The contexts from third-party setting. An array with the following
   *   pattern of values: {cache_context_name}:{cache_context_name_arg}.
   *
   * @return array
   *   Returns an array with key => value pairs respecting the standard:
   *   {cache_context_name} => {cache_context_name_arg}.
   */
  public function prepareContextsFromStorage(array $values) {
    $contexts = [];
    foreach ($values as $key => $value) {
      $value = explode(':', $value);
      $contexts[$value[0]] = isset($value[1]) ? $value[1] : '';
    }
    return $contexts;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Blocache::cacheContexts	public	function	Gets the available cache contexts.
Blocache::prepareContextsFromStorage	public	function	Prepares cache contexts to display them on the block configuration form.
Blocache::prepareContextsToStorage	public	function	Prepares the cache contexts for storage into third-party setting.