Funivan\Cs\Tools\Php\RedundantNullPropertyValue\RedundantNullPropertyValueReview

Complexity

Total Complexity

6

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	8

Test Coverage

Coverage

69.23%

Importance

Changes

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	16	3

<?php

  namespace Funivan\Cs\Tools\Php\RedundantNullPropertyValue;

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

  /**
   *
   */
  class RedundantNullPropertyValueReview implements FileTool {


    /**
     * Return unique string of the tool
     * You can set any name but we suggest to use following rules:
     *  - Allowed chars [a-z0-9_]+
     *  - Review tools should have ending `_review`
     *  - Fixer tools should have ending `_fixer`
     *
     * @codeCoverageIgnore
     * @return string
     */
    public function getName() {
      return 'redundant_null_property_value_review';
    }


    /**
     * @return string
     */
    public function getDescription() {
      return 'Detect properties defined with null values';
    }


    /**
     * Check if we can process file by this tool
     * Called before file process
     *
     * @param File $file
     * @return boolean
     */
    public function canProcess(File $file) {
      return (new FileFilter())->notDeleted()->extension(['php'])->isValid($file);
    }


    /**
     * @param File $file
     * @param Report $report
     */
    public function process(File $file, Report $report) {
      $collection = Collection::createFromString($file->getContent()->get());


      $invalidProperties = InvalidPropertyFinder::find($collection);
      if (count($invalidProperties) === 0) {
        return;
      }


      foreach ($invalidProperties as $property) {
        $variable = $property->getVariable();
        $report->addMessage($file, $this, 'Invalid property. Redundant NULL value for the property: '.$variable->getValue(), $variable->getLine());
      }

    }

  }