Funivan\Cs\Tools\Php\FileStartLine\PhpFileStartLineReview

Complexity

Total Complexity

6

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Test Coverage

Coverage

73.32%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	getDescription()	0	3	1
A	canProcess()	0	3	1
A	process()	0	13	3

<?php

  namespace Funivan\Cs\Tools\Php\FileStartLine;

  use Funivan\Cs\FileTool\FileTool;
  use Funivan\Cs\Fs\File;
  use Funivan\Cs\Fs\FileFilter;
  use Funivan\Cs\Report\Report;

  /**
   * @author Ivan Shcherbak <dev@funivan.com> 2016
   */
  class PhpFileStartLineReview implements FileTool {

    const NAME = 'php_file_start_line_review';

    const REGEXP = [
      '~^<\?php(\s+|$)~',
      '~^<\?(\s+|$)~',
      '~#!/usr/bin/env php(\s+|$)~',
    ];


    /**
     * @inheritdoc
     */
    public function getName() {
      return self::NAME;
    }


    /**
     * @inheritdoc
     */
    public function getDescription() {
      return 'Check php files first line';
    }


    /**
     * @inheritdoc
     */
    public function canProcess(File $file) {
      return (new FileFilter())->notDeleted()->extension(['php'])->isValid($file);
    }


    /**
     * @inheritdoc
     */
    public function process(File $file, Report $report) {
      $fileContent = $file->getContent()->get();

      foreach (self::REGEXP as $regexp) {
        if (preg_match($regexp, $fileContent) === 1) {
          return;
        }
      }

      $message = 'File must begin with `<?php` or `<?` or `#!/usr/bin/env php`';
      $report->addMessage($file, $this, $message, 1);

    }

  }