1. class
  2. Nette
  3. \
  4. PhpGenerator
  5. \
  6. PhpNamespace

PhpNamespace

final class PhpNamespace

Definition of a PHP namespace.

Generates:

  • namespace statement
  • variable amount of use statements
  • one or more class declarations

Constants

NameNormal

NameFunction

NameConstant

NAME_NORMAL

NAME_FUNCTION

NAME_CONSTANT

Methods

__construct(string $name)

No description

string
getName()

No description

PhpNamespace
setBracketedSyntax(bool $state = true)

No description

bool
hasBracketedSyntax()

No description

PhpNamespace
addUse(string $name, string|null $alias = null, string $of = self::NameNormal)

Adds a use statement to the namespace for class, function or constant.

void
removeUse(string $name, string $of = self::NameNormal)

No description

PhpNamespace
addUseFunction(string $name, string|null $alias = null)

Adds a use statement to the namespace for function.

PhpNamespace
addUseConstant(string $name, string|null $alias = null)

Adds a use statement to the namespace for constant.

array
getUses(string $of = self::NameNormal)

No description

string
resolveName(string $name, string $of = self::NameNormal)

Resolves relative name to full name.

string
simplifyType(string $type, string $of = self::NameNormal)

Simplifies type hint with relative names.

string
simplifyName(string $name, string $of = self::NameNormal)

Simplifies the full name of a class, function, or constant to a relative name.

PhpNamespace
add(GlobalFunction $item)

Adds a class-like type or function to the namespace. If it already exists, throws an exception.

ClassType
addClass(string $name)

Adds a class to the namespace. If it already exists, throws an exception.

InterfaceType
addInterface(string $name)

Adds an interface to the namespace. If it already exists, throws an exception.

TraitType
addTrait(string $name)

Adds a trait to the namespace. If it already exists, throws an exception.

EnumType
addEnum(string $name)

Adds an enum to the namespace. If it already exists, throws an exception.

EnumType
getClass(string $name)

Returns a class-like type from the namespace.

array
getClasses()

Returns all class-like types in the namespace.

PhpNamespace
removeClass(string $name)

Removes a class-like type from namespace.

GlobalFunction
addFunction(string $name)

Adds a function to the namespace. If it already exists, throws an exception.

GlobalFunction
getFunction(string $name)

Returns a function from the namespace.

array
getFunctions()

Returns all functions in the namespace.

PhpNamespace
removeFunction(string $name)

Removes a function type from namespace.

string
__toString()

No description

Details

at line 58
__construct(string $name)

No description

Parameters

string $name

at line 68
string getName()

No description

Return Value

string

at line 77
PhpNamespace setBracketedSyntax(bool $state = true)

internal  
 

No description

Parameters

bool $state

Return Value

PhpNamespace

at line 84
bool hasBracketedSyntax()

No description

Return Value

bool

at line 95
PhpNamespace addUse(string $name, string|null $alias = null, string $of = self::NameNormal)

Adds a use statement to the namespace for class, function or constant.

Parameters

string $name
string|null $alias
string $of

Return Value

PhpNamespace

Exceptions

InvalidStateException

at line 136
void removeUse(string $name, string $of = self::NameNormal)

No description

Parameters

string $name
string $of

Return Value

void

at line 149
PhpNamespace addUseFunction(string $name, string|null $alias = null)

Adds a use statement to the namespace for function.

Parameters

string $name
string|null $alias

Return Value

PhpNamespace

at line 158
PhpNamespace addUseConstant(string $name, string|null $alias = null)

Adds a use statement to the namespace for constant.

Parameters

string $name
string|null $alias

Return Value

PhpNamespace

at line 168
array getUses(string $of = self::NameNormal)

No description

Parameters

string $of

Return Value

array

at line 183
string resolveName(string $name, string $of = self::NameNormal)

Resolves relative name to full name.

Parameters

string $name
string $of

Return Value

string

at line 208
string simplifyType(string $type, string $of = self::NameNormal)

Simplifies type hint with relative names.

Parameters

string $type
string $of

Return Value

string

at line 218
string simplifyName(string $name, string $of = self::NameNormal)

Simplifies the full name of a class, function, or constant to a relative name.

Parameters

string $name
string $of

Return Value

string

at line 265
PhpNamespace add(GlobalFunction $item)

Adds a class-like type or function to the namespace. If it already exists, throws an exception.

Parameters

GlobalFunction $item

Return Value

PhpNamespace

at line 290
ClassType addClass(string $name)

Adds a class to the namespace. If it already exists, throws an exception.

Parameters

string $name

Return Value

ClassType

at line 300
InterfaceType addInterface(string $name)

Adds an interface to the namespace. If it already exists, throws an exception.

Parameters

string $name

Return Value

InterfaceType

at line 310
TraitType addTrait(string $name)

Adds a trait to the namespace. If it already exists, throws an exception.

Parameters

string $name

Return Value

TraitType

at line 320
EnumType addEnum(string $name)

Adds an enum to the namespace. If it already exists, throws an exception.

Parameters

string $name

Return Value

EnumType

at line 330
EnumType getClass(string $name)

Returns a class-like type from the namespace.

Parameters

string $name

Return Value

EnumType

at line 340
array getClasses()

Returns all class-like types in the namespace.

Return Value

array

at line 356
PhpNamespace removeClass(string $name)

Removes a class-like type from namespace.

Parameters

string $name

Return Value

PhpNamespace

at line 366
GlobalFunction addFunction(string $name)

Adds a function to the namespace. If it already exists, throws an exception.

Parameters

string $name

Return Value

GlobalFunction

at line 376
GlobalFunction getFunction(string $name)

Returns a function from the namespace.

Parameters

string $name

Return Value

GlobalFunction

at line 386
array getFunctions()

Returns all functions in the namespace.

Return Value

array

at line 400
PhpNamespace removeFunction(string $name)

Removes a function type from namespace.

Parameters

string $name

Return Value

PhpNamespace

at line 413
string __toString()

No description

Return Value

string