smalot / drush-cerbere

lib/Cerbere/Model/Hacked/HackedFileHasher.php

<?php

namespace Cerbere\Model\Hacked;

/**
 * Base class for the different ways that files can be hashed.
 *
 * Class HackedFileHasher
 * @package Cerbere\Model\Hacked
 */
abstract class HackedFileHasher {
  /**
   * Returns a hash of the given filename.
   *
   * Ignores file line endings
   */
  public function hash($filename) {
    if (file_exists($filename)) {
      if ($hash = $this->getCache($filename)) {
        return $hash;
      }
      else {
        $hash = $this->performHash($filename);
        $this->setCache($filename, $hash);

        return $hash;
      }
    }

    return false;
  }

  /**
   * @param string $filename
   * @param string $hash
   */
  public function setCache($filename, $hash) {

The parameter $filename is not used and could be removed.

The parameter $hash is not used and could be removed.

    //cache_set($this->getCacheKey($filename), $hash, HACKED_CACHE_TABLE, strtotime('+7 days'));

69% of this comment could be valid code. Did you maybe forget this after debugging?

  }

  /**
   * @param string $filename
   * @return string|false
   */
  public function getCache($filename) {

The parameter $filename is not used and could be removed.

    $cache = false;//cache_get($this->getCacheKey($filename), HACKED_CACHE_TABLE);

70% of this comment could be valid code. Did you maybe forget this after debugging?

    if (!empty($cache->data)) {
      return $cache->data;
    }

    return false;
  }

  /**
   * @param string $filename
   * @return string
   */
  public function getCacheKey($filename) {
    $key = array(
      'filename' => $filename,
      'mtime' => filemtime($filename),
      'class_name' => get_class($this),
    );

    return sha1(serialize($key));
  }

  /**
   * Compute and return the hash of the given file.
   *
   * @param string $filename
   *   A fully-qualified filename to hash.
   *
   * @return string
   *   The computed hash of the given file.
   */
  abstract public function performHash($filename);

  /**
   * Compute and return the lines of the given file.
   *
   * @param string $filename
   *   A fully-qualified filename to return.
   *
   * @return array|false
   *   The lines of the given filename or FALSE on failure.
   */
  abstract public function fetchLines($filename);
}