TheSeer\phpDox\Generator\Project::getIndex PHP Method

getIndex() public method

public getIndex ( ) : TheSeer\phpDox\Generator\Index
return TheSeer\phpDox\Generator\Index
    public function getIndex()
    {
        return new Index($this->index);
    }

Usage Example

示例#1
0
 /**
  * @param Project $project
  * @param bool    $publicOnly
  */
 public function run(Project $project, $publicOnly = FALSE)
 {
     $this->xmlDir = $project->getXmlDir();
     $this->publicOnly = $publicOnly;
     $this->project = $project;
     $this->handleEvent(new PHPDoxStartEvent($project->getIndex(), $project->getSourceTree()));
     if ($this->project->hasNamespaces()) {
         $this->processWithNamespace();
     } else {
         $this->processGlobalOnly();
     }
     $this->processTokenFiles($project->getSourceTree());
     $this->handleEvent(new PHPDoxEndEvent($project->getIndex(), $project->getSourceTree()));
     $this->logger->completed();
 }