/**
* Maps the properties of the Function reflector onto the Descriptor.
*
* @param FunctionReflector $reflector
* @param FunctionDescriptor $descriptor
*
* @return void
*/
protected function mapReflectorPropertiesOntoDescriptor($reflector, $descriptor)
{
$packages = new Collection();
$package = $this->extractPackageFromDocBlock($reflector->getDocBlock());
if ($package) {
$tag = new TagDescriptor('package');
$tag->setDescription($package);
$packages->add($tag);
}
$descriptor->getTags()->set('package', $packages);
$descriptor->setFullyQualifiedStructuralElementName($reflector->getName() . '()');
$descriptor->setName($reflector->getShortName());
$descriptor->setLine($reflector->getLinenumber());
$descriptor->setNamespace($this->getFullyQualifiedNamespaceName($reflector));
}
/**
* Creates a Descriptor from the provided data.
*
* @param FunctionReflector $data
*
* @return FunctionDescriptor
*/
public function create($data)
{
$functionDescriptor = new FunctionDescriptor();
$functionDescriptor->setFullyQualifiedStructuralElementName($data->getName() . '()');
$functionDescriptor->setName($data->getShortName());
$functionDescriptor->setLine($data->getLinenumber());
// Reflection library formulates namespace as global but this is not wanted for phpDocumentor itself
$functionDescriptor->setNamespace('\\' . (strtolower($data->getNamespace()) == 'global' ? '' : $data->getNamespace()));
$this->assembleDocBlock($data->getDocBlock(), $functionDescriptor);
foreach ($data->getArguments() as $argument) {
$argumentAssembler = new ArgumentAssembler();
$argumentDescriptor = $argumentAssembler->create($argument, $functionDescriptor->getTags()->get('param', array()));
$functionDescriptor->getArguments()->set($argumentDescriptor->getName(), $argumentDescriptor);
}
return $functionDescriptor;
}
/**
* @covers phpDocumentor\Compiler\Pass\PackageTreeBuilder::execute
* @covers phpDocumentor\Compiler\Pass\PackageTreeBuilder::addElementsOfTypeToPackage
*/
public function testAddFunctionToNamespace()
{
$function = new FunctionDescriptor();
$function->setPackage('My\\Space');
$function->setFullyQualifiedStructuralElementName('My\\Space\\Function1');
$this->project->getFiles()->get(0)->getFunctions()->add($function);
// double check if a second function in the same deep namespace ends up at the right location
$function2 = new FunctionDescriptor();
$function2->setPackage('My\\Space');
$function2->setFullyQualifiedStructuralElementName('My\\Space\\Function2');
$this->project->getFiles()->get(0)->getFunctions()->add($function2);
$this->fixture->execute($this->project);
$this->assertSame(array($function, $function2), $this->project->getIndexes()->get('packages')->get('\\My\\Space')->getFunctions()->getAll());
}
/**
* @covers phpDocumentor\Compiler\Pass\ElementsIndexBuilder::execute
* @covers phpDocumentor\Compiler\Pass\ElementsIndexBuilder::addElementsToIndexes
* @covers phpDocumentor\Compiler\Pass\ElementsIndexBuilder::getIndexKey
*/
public function testAddFunctionsToIndex()
{
$file1 = $this->project->getFiles()->get(0);
$functionDescriptor1 = new FunctionDescriptor();
$functionDescriptor1->setFullyQualifiedStructuralElementName('function1');
$file1->getFunctions()->add($functionDescriptor1);
$file2 = $this->project->getFiles()->get(1);
$functionDescriptor2 = new FunctionDescriptor();
$functionDescriptor2->setFullyQualifiedStructuralElementName('function2');
$file2->getFunctions()->add($functionDescriptor2);
$this->fixture->execute($this->project);
$elements = $this->project->getIndexes()->get('elements')->getAll();
$this->assertCount(2, $elements);
$this->assertSame(array('function1', 'function2'), array_keys($elements));
$this->assertSame(array($functionDescriptor1, $functionDescriptor2), array_values($elements));
$elements = $this->project->getIndexes()->get('functions')->getAll();
$this->assertCount(2, $elements);
$this->assertSame(array('function1', 'function2'), array_keys($elements));
$this->assertSame(array($functionDescriptor1, $functionDescriptor2), array_values($elements));
}
