/**
* Exibe a documentação automática para Entidades.
*
* Contém os métodos mágicos e é exibida quando o segundo parâmetro enviados ao
* phpunit é --stderr desde que o método setUpBeforeClass() do teste seja
* implementado conforme exemplo a seguir
*
* <code>
* //...
* public static function setUpBeforeClass()
* {
* self::displayClassDocumentation(new Product());
* }
* //...
* </code>
*
* @param EntityInterface $entity [description]
*/
public static function displayClassDocumentation($entity)
{
global $argv;
if (count($argv) <= 1 || $argv[1] !== '--stderr') {
return false;
}
$docblock = Docblock::getInstance();
$docblock->setResourcesPath(static::getVarPath());
if ($entity instanceof EntityAbstract) {
$json = json_encode($entity->toArray(), JSON_PRETTY_PRINT);
echo $docblock->generate($entity->toDocBLock(), $json);
} else {
echo $docblock->generate();
}
}