Merge pull request #22380 from braders/core-483-show-customised-preferences-on-validation

[civicrm-core.git] / CRM / Core / CodeGen / BaseTask.php

<?php

/**
 * Class CRM_Core_CodeGen_BaseTask
 */
abstract class CRM_Core_CodeGen_BaseTask implements CRM_Core_CodeGen_ITask {
  /**
   * @var CRM_Core_CodeGen_Main
   */
  protected $config;

  protected $tables;

  /**
   * @param CRM_Core_CodeGen_Main $config
   */
  public function __construct($config) {
    $this->setConfig($config);
  }

  /**
   * TODO: this is the most rudimentary possible hack.  CG config should
   * eventually be made into a first-class object.
   *
   * @param object $config
   */
  public function setConfig($config) {
    $this->config = $config;
    $this->tables = $this->config->tables;
  }

  /**
   * @return bool
   *   TRUE if an update is needed.
   */
  public function needsUpdate() {
    return TRUE;
  }

  /**
   * Extract a single regex from a file.
   *
   * @param string $file
   *   File name
   * @param string $regex
   *   A pattern to match. Ex: "foo=([a-z]+)".
   * @return string|NULL
   *   The value matched.
   */
  protected static function extractRegex($file, $regex) {
    $content = file_get_contents($file);
    if (preg_match($regex, $content, $matches)) {
      return $matches[1];
    }
    else {
      return NULL;
    }
  }

  /**
   * Determine if two snippets of PHP code are approximately equivalent.
   *
   * This includes exceptions to equivalence for (a) whitespace and (b)
   * the token "GenCodeChecksum".
   *
   * This is useful for determining if someone has manually mucked with
   * one the files. However, it's not perfect -- because whitespace changes
   * are not detected. Hence, it's good to use in combination with another
   * heuristic.
   *
   * @param $actual
   * @param $expected
   * @return bool
   */
  protected function isApproxPhpMatch($actual, $expected) {
    foreach (['actual', 'expected'] as $var) {
      $$var = CRM_Core_CodeGen_Util_ArraySyntaxConverter::convert($$var);
      $$var = preg_replace("#  '\\d+' => #", "  ", $$var);
      $$var = preg_replace(';\(GenCodeChecksum:([a-zA-Z0-9]+)\);', '', $$var);
      $$var = strtolower(preg_replace(';[ \r\n\t];', '', $$var));
    }
    return $actual === $expected;
  }

}