mirror_php/Faker
1
0
Fork 0
mirror of https://github.com/fzaninotto/Faker.git synced 2025-03-21 15:59:52 +01:00
Code Issues Releases Wiki Activity

No need to look for phpDoc to get an exemple output for methods that generate output at will

Browse Source
This commit is contained in:
Francois Zaninotto 2011-10-15 20:44:52 +02:00
parent cd9a008559
commit 201dbaed57
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/Documentor.php
View File

@ -19,16 +19,18 @@ class Documentor
$formatters[$providerClass] = array();
$refl = new \ReflectionObject($provider);
foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC) as $reflmethod) {
if ($reflmethod->name == '__construct') {
$methodName = $reflmethod->name;
if ($methodName == '__construct') {
continue;
}
$comment = $reflmethod->getDocComment();
if (preg_match('/^\s+\*\s+@example\s+(.*)$/mi', $comment, $matches)) {
$example = $matches[1];
} else {
$example = '';
$example = $this->generator->format($methodName);
if (is_array($example)) {
$example = 'array('. join(', ', $example) . ')';
}
$formatters[$providerClass][$reflmethod->name] = $example;
if (is_string($example)) {
$example = var_export($example, true);
}
$formatters[$providerClass][$methodName] = $example;
}
ksort($formatters[$providerClass]);
}