/**
* Creates a Descriptor from the provided data.
*
* @param TraitReflector $data
*
* @return TraitDescriptor
*/
public function create($data)
{
$traitDescriptor = new TraitDescriptor();
$traitDescriptor->setFullyQualifiedStructuralElementName($data->getName());
$traitDescriptor->setName($data->getShortName());
$traitDescriptor->setLine($data->getLinenumber());
$traitDescriptor->setPackage($this->extractPackageFromDocBlock($data->getDocBlock()) ?: '');
// Reflection library formulates namespace as global but this is not wanted for phpDocumentor itself
$traitDescriptor->setNamespace('\\' . (strtolower($data->getNamespace()) == 'global' ? '' : $data->getNamespace()));
$this->assembleDocBlock($data->getDocBlock(), $traitDescriptor);
$this->addProperties($data->getProperties(), $traitDescriptor);
$this->addMethods($data->getMethods(), $traitDescriptor);
return $traitDescriptor;
}
/**
* @covers phpDocumentor\Compiler\Pass\PackageTreeBuilder::execute
* @covers phpDocumentor\Compiler\Pass\PackageTreeBuilder::addElementsOfTypeToPackage
*/
public function testAddTraitToNamespace()
{
$trait = new TraitDescriptor();
$trait->setPackage('My\\Space');
$trait->setFullyQualifiedStructuralElementName('My\\Space\\Trait1');
$this->project->getFiles()->get(0)->getTraits()->add($trait);
// double check if a second trait in the same deep namespace ends up at the right location
$trait2 = new TraitDescriptor();
$trait2->setPackage('My\\Space');
$trait2->setFullyQualifiedStructuralElementName('My\\Space\\Trait2');
$this->project->getFiles()->get(0)->getTraits()->add($trait2);
$this->fixture->execute($this->project);
$this->assertSame(array($trait, $trait2), $this->project->getIndexes()->get('packages')->get('\\My\\Space')->getTraits()->getAll());
}
/**
* @covers phpDocumentor\Compiler\Pass\ElementsIndexBuilder::execute
* @covers phpDocumentor\Compiler\Pass\ElementsIndexBuilder::addElementsToIndexes
* @covers phpDocumentor\Compiler\Pass\ElementsIndexBuilder::getIndexKey
*/
public function testAddTraitsToIndex()
{
$file1 = $this->project->getFiles()->get(0);
$traitDescriptor1 = new TraitDescriptor();
$traitDescriptor1->setFullyQualifiedStructuralElementName('My\\Space\\Trait1');
$file1->getTraits()->add($traitDescriptor1);
$file2 = $this->project->getFiles()->get(1);
$traitDescriptor2 = new TraitDescriptor();
$traitDescriptor2->setFullyQualifiedStructuralElementName('My\\Space\\Trait2');
$file2->getTraits()->add($traitDescriptor2);
$this->fixture->execute($this->project);
$elements = $this->project->getIndexes()->get('elements')->getAll();
$this->assertCount(2, $elements);
$this->assertSame(array('My\\Space\\Trait1', 'My\\Space\\Trait2'), array_keys($elements));
$this->assertSame(array($traitDescriptor1, $traitDescriptor2), array_values($elements));
$elements = $this->project->getIndexes()->get('traits')->getAll();
$this->assertCount(2, $elements);
$this->assertSame(array('My\\Space\\Trait1', 'My\\Space\\Trait2'), array_keys($elements));
$this->assertSame(array($traitDescriptor1, $traitDescriptor2), array_values($elements));
}
