class LessphpCompiler in SCSS/Less Compiler 8

Plugin implementation of the Less compiler.

Plugin annotation


@ScssCompilerPlugin(
  id   = "scss_compiler_lessphp",
  name = "LessPhp Compiler",
  description = "PHP port of the official LESS processor",
  extensions = {
    "less" = "less",
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\scss_compiler\ScssCompilerPluginBase implements ContainerFactoryPluginInterface, ScssCompilerPluginInterface uses MessengerTrait, StringTranslationTrait
  - class \Drupal\scss_compiler\Plugin\ScssCompiler\LessphpCompiler

Expanded class hierarchy of LessphpCompiler

File

src/Plugin/ScssCompiler/LessphpCompiler.php, line 20

Namespace

Drupal\scss_compiler\Plugin\ScssCompiler

View source

class LessphpCompiler extends ScssCompilerPluginBase {

  /**
   * Compiler object instance.
   *
   * @var \Less_Parser
   */
  protected $parser;

  /**
   * {@inheritdoc}
   */
  public function init() {
    $status = self::getStatus();
    if ($status !== TRUE) {
      throw new \Exception($status);
    }
    $this->parser = new \Less_Parser();
    $format = $this->scssCompiler
      ->getOption('output_format');
    switch ($format) {
      case 'compressed':
      case 'crunched':
        $this->parser
          ->setOption('compress', TRUE);
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getVersion() {
    if (class_exists('Less_Version')) {
      return \Less_Version::version;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public static function getStatus() {
    $compiler_class_exists = class_exists('Less_Parser');
    if (!$compiler_class_exists && !file_exists(DRUPAL_ROOT . '/libraries/less.php/lessc.inc.php')) {
      return t('LessPhp Compiler library not found. Install it via composer "composer require wikimedia/less.php"');
    }

    // If library didn't autoload from the vendor folder, load it from the
    // libraries folder. Added to manage the library without composer.
    // @see https://www.drupal.org/project/scss_compiler/issues/3213427
    if (!$compiler_class_exists) {
      require_once DRUPAL_ROOT . '/libraries/less.php/lessc.inc.php';
      if (version_compare(PHP_VERSION, '7.2.9', '<')) {
        $error_message = t('LessPhp requires at least php 7.2.9');
      }
    }
    if (!empty($error_message)) {
      return $error_message;
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function compile(array $scss_file) {
    $import_paths = [
      dirname($scss_file['source_path']),
      DRUPAL_ROOT,
    ];
    if ($this->scssCompiler
      ->getAdditionalImportPaths()) {
      $import_paths = array_merge($import_paths, $this->scssCompiler
        ->getAdditionalImportPaths());
    }
    $this->parser
      ->setImportDirs($import_paths);
    $this->parser
      ->setOption('import_callback', [
      $this,
      'importCallback',
    ]);
    $css_folder = dirname($scss_file['css_path']);
    if ($this->scssCompiler
      ->getOption('sourcemaps')) {
      $sourcemap_file = $css_folder . '/' . $scss_file['name'] . '.css.map';
      $this->parser
        ->setOptions([
        'sourceMap' => TRUE,
        'sourceMapWriteTo' => $sourcemap_file,
        'sourceMapURL' => $scss_file['name'] . '.css.map',
        'sourceMapBasepath' => DRUPAL_ROOT,
        'sourceMapRootpath' => '/',
      ]);
    }
    $this->fileSystem
      ->prepareDirectory($css_folder, FileSystemInterface::CREATE_DIRECTORY);
    $this->parser
      ->parseFile($scss_file['source_path'], $scss_file['assets_path']);

    // Alter variables.
    $variables = $this->scssCompiler
      ->getVariables()
      ->getAll($scss_file['namespace'], $scss_file['source_path']);
    $this->parser
      ->ModifyVars($variables);
    $content = $this->parser
      ->getCss();
    return $content;
  }

  /**
   * {@inheritdoc}
   */
  public function checkLastModifyTime(array &$source_file) {
    $last_modify_time = filemtime($source_file['source_path']);
    $source_folder = trim(dirname($source_file['source_path']), '/') . '/';
    $import = [];
    $content = file_get_contents($source_file['source_path']);
    preg_match_all('/@import.*["|\'](.*)["|\'].*;/', $content, $import);
    if (!empty($import[1])) {
      foreach ($import[1] as $file) {

        // Normalize @import path.
        $file_path = trim($file, '\'" ');
        $replaced_path = $this->scssCompiler
          ->replaceTokens($file_path);
        if ($file_path !== $replaced_path) {
          $file_path = $replaced_path;
          $source_folder = '';
        }
        $pathinfo = pathinfo($file_path);
        if (empty($pathinfo['dirname'])) {
          continue;
        }
        $extension = '.less';
        $filename = $pathinfo['filename'];
        $dirname = $pathinfo['dirname'] === '.' ? '' : $pathinfo['dirname'] . '/';
        $file_path = $source_folder . $dirname . $filename . $extension;
        $less_path = $source_folder . $dirname . '_' . $filename . $extension;
        if (file_exists($file_path) || file_exists($file_path = $less_path)) {
          $file_modify_time = filemtime($file_path);
          if ($file_modify_time > $last_modify_time) {
            $last_modify_time = $file_modify_time;
          }
        }
      }
    }
    return $last_modify_time;
  }

  /**
   * Replaces tokens in import paths.
   *
   * @param \Less_Tree_Import $import
   *   Compiler import object.
   */
  public function importCallback(\Less_Tree_Import $import) {
    if (!empty($import->path->value)) {
      $path = $this->scssCompiler
        ->replaceTokens($import->path->value);
      if ($path) {
        $import->path->value = $path;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LessphpCompiler::$parser	protected	property	Compiler object instance.
LessphpCompiler::checkLastModifyTime	public	function	Checks if file was changed. Overrides ScssCompilerPluginInterface::checkLastModifyTime
LessphpCompiler::compile	public	function	Compiles single source file. Overrides ScssCompilerPluginInterface::compile
LessphpCompiler::getStatus	public static	function	Returns status of compiler library. Overrides ScssCompilerPluginInterface::getStatus
LessphpCompiler::getVersion	public static	function	Returns compiler version. Overrides ScssCompilerPluginInterface::getVersion
LessphpCompiler::importCallback	public	function	Replaces tokens in import paths.
LessphpCompiler::init	public	function	Calls a code on plugin initialization. Overrides ScssCompilerPluginBase::init
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
ScssCompilerPluginBase::$fileSystem	protected	property	The file system service.
ScssCompilerPluginBase::$moduleHandler	protected	property	The module handler.
ScssCompilerPluginBase::$request	protected	property	The current request.
ScssCompilerPluginBase::$scssCompiler	protected	property	The scss compiler service.
ScssCompilerPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ScssCompilerPluginBase::__construct	public	function	Constructs a SCSS Compiler base plugin. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class LessphpCompiler in SCSS/Less Compiler 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation