phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\Descriptor\InterfacesProjectInterface

Describes the public interface for the description of a project.

Summary

Methods
Constants
setName()
getName()
getFiles()
getIndexes()
getPackage()
getNamespace()
getVersions()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setName()

setName(string  $name) : void

Parameters

string $name

getName()

getName() : string

Returns

string —

getFiles()

getFiles() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface> —

getIndexes()

getIndexes() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> —

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\Interfaces\PackageInterface

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\Interfaces\PackageInterface —

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Returns

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string —

getVersions()

getVersions() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —