Analyzers/Docblock/ReportFile.php

Last updated: 07/05/2017

Rylai\Analyzers\Docblock

Rylai\Analyzers\Docblock\ReportFile
Report of analyzed file

Interfaces
Properties
Methods
  • public __construct()
  • protected _afterParse(Go\ParserReflection\ReflectionFile $target,phpDocumentor\Reflection\DocBlockFactory $factory,phpDocumentor\Reflection\Docblock $docblock)
    • @param \ReflectionFile target
    • @param \DocBlockFactory factory
    • @param \Docblock docblock
    • @return void

    Loop through namespaces to generate namespace report

  • public jsonSerialize()
    • @return array

    Serialize to json

    Rylai\Analyzers\Docblock\AbstractReport

  • protected _isAllowed($property)
    • @param string property
    • @return bool

    Test if property is allowed

    Rylai\Analyzers\Docblock\AbstractReport

  • public __isset($property)
    • @param string property
    • @return bool

    Test if property exists

    Rylai\Analyzers\Docblock\AbstractReport

  • public __set($property,$value)
    • @param string property
    • @param \any value

    Magic method for setter

    Rylai\Analyzers\Docblock\AbstractReport

  • public __get($property)
    • @param string property
    • @return \var

    Magic method for getter

    Rylai\Analyzers\Docblock\AbstractReport

  • public parse($target,phpDocumentor\Reflection\DocBlockFactory $factory)
    • @param mixed target
    • @param \DocBlockFactory factory
    • @return \DocumentorDocblock

    Parse target and read docblock

    We separated some standard tags like params,return,link ... in phpdocumentor for different arrays with special properties . Other tags will just be name,content pairs

    Rylai\Analyzers\Docblock\AbstractReport