/** * Generates a URL from the given node or returns false if unable. * * @param string|Descriptor\MethodDescriptor $node * * @return string|false */ public function __invoke($node) { if (!$node instanceof Descriptor\MethodDescriptor) { return false; } $converter = new QualifiedNameToUrlConverter(); $className = $node->getParent()->getFullyQualifiedStructuralElementName(); return '/classes/' . $converter->fromClass($className) . '.html#method_' . $node->getName(); }
/** * @covers phpDocumentor\Descriptor\MethodDescriptor::getCopyright * @covers phpDocumentor\Descriptor\DescriptorAbstract::getCopyright */ public function testCopyrightTagsInheritWhenNoneArePresent() { // Arrange $copyrightTagDescriptor = new TagDescriptor('copyright'); $copyrightCollection = new Collection(array($copyrightTagDescriptor)); $this->fixture->getTags()->clear(); $parentProperty = $this->whenFixtureHasMethodInParentClassWithSameName($this->fixture->getName()); $parentProperty->getTags()->set('copyright', $copyrightCollection); // Act $result = $this->fixture->getCopyright(); // Assert $this->assertSame($copyrightCollection, $result); }
/** * Export the given reflected method definition to the provided parent element. * * @param \DOMElement $parent Element to augment. * @param MethodDescriptor $method Element to export. * * @return \DOMElement */ public function convert(\DOMElement $parent, MethodDescriptor $method) { $fullyQualifiedNamespaceName = $method->getNamespace() instanceof NamespaceDescriptor ? $method->getNamespace()->getFullyQualifiedStructuralElementName() : $parent->getAttribute('namespace'); $child = new \DOMElement('method'); $parent->appendChild($child); $child->setAttribute('final', var_export($method->isFinal(), true)); $child->setAttribute('abstract', var_export($method->isAbstract(), true)); $child->setAttribute('static', var_export($method->isStatic(), true)); $child->setAttribute('visibility', $method->getVisibility()); $child->setAttribute('namespace', $fullyQualifiedNamespaceName); $child->setAttribute('line', $method->getLine()); $child->appendChild(new \DOMElement('name', $method->getName())); $child->appendChild(new \DOMElement('full_name', $method->getFullyQualifiedStructuralElementName())); $this->docBlockConverter->convert($child, $method); foreach ($method->getArguments() as $argument) { $this->argumentConverter->convert($child, $argument); } return $child; }
/** * Export the given reflected method definition to the provided parent element. * * @param \DOMElement $parent Element to augment. * @param MethodDescriptor $method Element to export. * * @return \DOMElement */ public function buildMethod(\DOMElement $parent, MethodDescriptor $method) { $child = new \DOMElement('method'); $parent->appendChild($child); $child->setAttribute('final', $method->isFinal() ? 'true' : 'false'); $child->setAttribute('abstract', $method->isAbstract() ? 'true' : 'false'); $child->setAttribute('static', $method->isStatic() ? 'true' : 'false'); $child->setAttribute('visibility', $method->getVisibility()); $namespaceFqnn = $method->getNamespace() ? $method->getNamespace()->getFullyQualifiedStructuralElementName() : $parent->getAttribute('namespace'); $child->setAttribute('namespace', $namespaceFqnn); $child->setAttribute('line', $method->getLine()); $child->appendChild(new \DOMElement('name', $method->getName())); $child->appendChild(new \DOMElement('full_name', $method->getFullyQualifiedStructuralElementName())); $this->buildDocBlock($child, $method); foreach ($method->getArguments() as $argument) { $this->buildArgument($child, $argument); } return $child; }
/** * Generates a URL from the given node or returns false if unable. * * @param \phpDocumentor\Descriptor\MethodDescriptor $node * * @return string|false */ public function __invoke($node) { $className = $node->getParent()->getFullyQualifiedStructuralElementName(); $name = $node->getName(); return '/classes/' . str_replace('\\', '.', ltrim($className, '\\')) . '.html#property_' . $name; }