/** * @covers phpDocumentor\Descriptor\ProjectDescriptorBuilder::setProjectDescriptor * @covers phpDocumentor\Descriptor\ProjectDescriptorBuilder::getProjectDescriptor */ public function testProvidingAPreExistingDescriptorToBuildOn() { $projectDescriptorName = 'My Descriptor'; $projectDescriptorMock = new ProjectDescriptor($projectDescriptorName); $this->fixture->setProjectDescriptor($projectDescriptorMock); $this->assertSame($projectDescriptorMock, $this->fixture->getProjectDescriptor()); $this->assertEquals($projectDescriptorName, $this->fixture->getProjectDescriptor()->getName()); }
/** * Returns a relative URL from the webroot if the given FQSEN exists in the project. * * Example usage inside template would be (where @link is an attribute called link): * * ``` * <xsl:value-of select="php:function('phpDocumentor\Plugin\Core\Xslt\Extension::path', string(@link))" /> * ``` * * @param string $fqsen * * @return bool|string */ public static function path($fqsen) { $projectDescriptor = self::$descriptorBuilder->getProjectDescriptor(); $elementList = $projectDescriptor->getIndexes()->get('elements'); $node = $fqsen; if (isset($elementList[$fqsen])) { $node = $elementList[$fqsen]; } elseif (isset($elementList['~\\' . $fqsen])) { $node = $elementList['~\\' . $fqsen]; } $rule = self::$routers->match($node); if (!$rule) { return ''; } $generatedUrl = $rule->generate($node); return $generatedUrl ? ltrim($generatedUrl, '/') : false; }
/** * Creates a new FileReflector for the given filename or null if the file contains no modifications. * * @param ProjectDescriptorBuilder $builder * @param string $filename * * @return FileReflector|null Returns a new FileReflector or null if no modifications were detected for the given * filename. */ protected function createFileReflector(ProjectDescriptorBuilder $builder, $filename) { $file = new FileReflector($filename, $this->parser->doValidation(), $this->parser->getEncoding()); $file->setDefaultPackageName($this->parser->getDefaultPackageName()); $file->setMarkers($this->parser->getMarkers()); $file->setFilename($this->getRelativeFilename($filename)); $cachedFiles = $builder->getProjectDescriptor()->getFiles(); $hash = $cachedFiles->get($file->getFilename()) ? $cachedFiles->get($file->getFilename())->getHash() : null; return $hash === $file->getHash() && !$this->parser->isForced() ? null : $file; }
/** * Checks if the settings of the project have changed and forces a complete rebuild if they have. * * @param ProjectDescriptorBuilder $builder * * @return void */ protected function forceRebuildIfSettingsHaveModified(ProjectDescriptorBuilder $builder) { if ($builder->getProjectDescriptor()->getSettings()->isModified()) { $this->setForced(true); $this->log('One of the project\'s settings have changed, forcing a complete rebuild'); } }
/** * Iterates through the given files feeds them to the builder. * * @param ProjectDescriptorBuilder $builder * @param Collection $files A files container to parse. * * @api * * @throws Exception if no files were found. * * @return bool|string */ public function parse(ProjectDescriptorBuilder $builder, Collection $files) { $timer = microtime(true); $paths = $this->getFilenames($files); $this->log(' Project root is: ' . $files->getProjectRoot()); $this->log(' Ignore paths are: ' . implode(', ', $files->getIgnorePatterns()->getArrayCopy())); if ($builder->getProjectDescriptor()->getSettings()->isModified()) { $this->setForced(true); $this->log('One of the project\'s settings have changed, forcing a complete rebuild'); } foreach ($paths as $filename) { if (class_exists('phpDocumentor\\Event\\Dispatcher')) { Dispatcher::getInstance()->dispatch('parser.file.pre', PreFileEvent::createInstance($this)->setFile($filename)); } $this->log('Starting to parse file: ' . $filename); $memory = memory_get_usage(); try { $file = new FileReflector($filename, $this->doValidation(), $this->getEncoding()); $file->setDefaultPackageName($this->getDefaultPackageName()); $file->setMarkers($this->getMarkers()); $file->setFilename($this->getRelativeFilename($filename)); // if the hash is unchanged; continue to the next file $cachedFiles = $builder->getProjectDescriptor()->getFiles(); $hash = $cachedFiles->get($file->getFilename()) ? $cachedFiles->get($file->getFilename())->getHash() : null; if ($hash === $file->getHash() && !$this->isForced()) { $this->log('>> Skipped file ' . $file->getFilename() . ' as no modifications were detected'); continue; } $file->process(); $builder->buildFileUsingSourceData($file); $fileDescriptor = $builder->getProjectDescriptor()->getFiles()->get($file->getFilename()); $errors = $fileDescriptor->getAllErrors(); foreach ($errors as $error) { $this->log($error->getCode(), $error->getSeverity(), $error->getContext()); } } catch (Exception $e) { $this->log(' Unable to parse file "' . $filename . '", an error was detected: ' . $e->getMessage(), LogLevel::ALERT); } $memoryDelta = memory_get_usage() - $memory; $this->log('>> Memory after processing of file: ' . number_format(memory_get_usage() / 1024 / 1024, 2) . ' megabytes (' . ($memoryDelta > -0 ? '+' : '') . number_format($memoryDelta / 1024) . ' kilobytes)', LogLevel::DEBUG); } $this->log('Elapsed time to parse all files: ' . round(microtime(true) - $timer, 2) . 's'); $this->log('Peak memory usage: ' . round(memory_get_peak_usage() / 1024 / 1024, 2) . 'M'); return $builder->getProjectDescriptor(); }