class FileCacheReader

FileCacheReaderTest.php in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Annotations/FileCacheReaderTest.php

PerformanceTest.php in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Annotations/PerformanceTest.php

class FileCacheReader implements Reader {

  /**
   * @var Reader
   */
  private $reader;

  /**
   * @var string
   */
  private $dir;

  /**
   * @var bool
   */
  private $debug;

  /**
   * @var array
   */
  private $loadedAnnotations = array();

  /**
   * Constructor
   *
   * @param Reader $reader
   * @param string $cacheDir
   * @param bool $debug
   *
   * @throws \InvalidArgumentException
   */
  public function __construct(Reader $reader, $cacheDir, $debug = false) {
    $this->reader = $reader;
    if (!is_dir($cacheDir) && !@mkdir($cacheDir, 0777, true)) {
      throw new \InvalidArgumentException(sprintf('The directory "%s" does not exist and could not be created.', $cacheDir));
    }
    if (!is_writable($cacheDir)) {
      throw new \InvalidArgumentException(sprintf('The directory "%s" is not writable. Both, the webserver and the console user need access. You can manage access rights for multiple users with "chmod +a". If your system does not support this, check out the acl package.', $cacheDir));
    }
    $this->dir = rtrim($cacheDir, '\\/');
    $this->debug = $debug;
  }

  /**
   * Retrieve annotations for class
   *
   * @param \ReflectionClass $class
   * @return array
   */
  public function getClassAnnotations(\ReflectionClass $class) {
    $key = $class
      ->getName();
    if (isset($this->loadedAnnotations[$key])) {
      return $this->loadedAnnotations[$key];
    }
    $path = $this->dir . '/' . strtr($key, '\\', '-') . '.cache.php';
    if (!file_exists($path)) {
      $annot = $this->reader
        ->getClassAnnotations($class);
      $this
        ->saveCacheFile($path, $annot);
      return $this->loadedAnnotations[$key] = $annot;
    }
    if ($this->debug && false !== ($filename = $class
      ->getFilename()) && filemtime($path) < filemtime($filename)) {
      @unlink($path);
      $annot = $this->reader
        ->getClassAnnotations($class);
      $this
        ->saveCacheFile($path, $annot);
      return $this->loadedAnnotations[$key] = $annot;
    }
    return $this->loadedAnnotations[$key] = (include $path);
  }

  /**
   * Get annotations for property
   *
   * @param \ReflectionProperty $property
   * @return array
   */
  public function getPropertyAnnotations(\ReflectionProperty $property) {
    $class = $property
      ->getDeclaringClass();
    $key = $class
      ->getName() . '$' . $property
      ->getName();
    if (isset($this->loadedAnnotations[$key])) {
      return $this->loadedAnnotations[$key];
    }
    $path = $this->dir . '/' . strtr($key, '\\', '-') . '.cache.php';
    if (!file_exists($path)) {
      $annot = $this->reader
        ->getPropertyAnnotations($property);
      $this
        ->saveCacheFile($path, $annot);
      return $this->loadedAnnotations[$key] = $annot;
    }
    if ($this->debug && false !== ($filename = $class
      ->getFilename()) && filemtime($path) < filemtime($filename)) {
      unlink($path);
      $annot = $this->reader
        ->getPropertyAnnotations($property);
      $this
        ->saveCacheFile($path, $annot);
      return $this->loadedAnnotations[$key] = $annot;
    }
    return $this->loadedAnnotations[$key] = (include $path);
  }

  /**
   * Retrieve annotations for method
   *
   * @param \ReflectionMethod $method
   * @return array
   */
  public function getMethodAnnotations(\ReflectionMethod $method) {
    $class = $method
      ->getDeclaringClass();
    $key = $class
      ->getName() . '#' . $method
      ->getName();
    if (isset($this->loadedAnnotations[$key])) {
      return $this->loadedAnnotations[$key];
    }
    $path = $this->dir . '/' . strtr($key, '\\', '-') . '.cache.php';
    if (!file_exists($path)) {
      $annot = $this->reader
        ->getMethodAnnotations($method);
      $this
        ->saveCacheFile($path, $annot);
      return $this->loadedAnnotations[$key] = $annot;
    }
    if ($this->debug && false !== ($filename = $class
      ->getFilename()) && filemtime($path) < filemtime($filename)) {
      unlink($path);
      $annot = $this->reader
        ->getMethodAnnotations($method);
      $this
        ->saveCacheFile($path, $annot);
      return $this->loadedAnnotations[$key] = $annot;
    }
    return $this->loadedAnnotations[$key] = (include $path);
  }

  /**
   * Save cache file
   *
   * @param string $path
   * @param mixed $data
   */
  private function saveCacheFile($path, $data) {
    file_put_contents($path, '<?php return unserialize(' . var_export(serialize($data), true) . ');');
  }

  /**
   * Gets a class annotation.
   *
   * @param \ReflectionClass $class The ReflectionClass of the class from which
   *                               the class annotations should be read.
   * @param string $annotationName The name of the annotation.
   *
   * @return mixed The Annotation or NULL, if the requested annotation does not exist.
   */
  public function getClassAnnotation(\ReflectionClass $class, $annotationName) {
    $annotations = $this
      ->getClassAnnotations($class);
    foreach ($annotations as $annotation) {
      if ($annotation instanceof $annotationName) {
        return $annotation;
      }
    }
    return null;
  }

  /**
   * Gets a method annotation.
   *
   * @param \ReflectionMethod $method
   * @param string $annotationName The name of the annotation.
   * @return mixed The Annotation or NULL, if the requested annotation does not exist.
   */
  public function getMethodAnnotation(\ReflectionMethod $method, $annotationName) {
    $annotations = $this
      ->getMethodAnnotations($method);
    foreach ($annotations as $annotation) {
      if ($annotation instanceof $annotationName) {
        return $annotation;
      }
    }
    return null;
  }

  /**
   * Gets a property annotation.
   *
   * @param \ReflectionProperty $property
   * @param string $annotationName The name of the annotation.
   * @return mixed The Annotation or NULL, if the requested annotation does not exist.
   */
  public function getPropertyAnnotation(\ReflectionProperty $property, $annotationName) {
    $annotations = $this
      ->getPropertyAnnotations($property);
    foreach ($annotations as $annotation) {
      if ($annotation instanceof $annotationName) {
        return $annotation;
      }
    }
    return null;
  }

  /**
   * Clear stores annotations
   */
  public function clearLoadedAnnotations() {
    $this->loadedAnnotations = array();
  }

}