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

PhpFile

final class PhpFile

Instance of PHP file.

Generates:

  • opening tag (<?php)
  • doc comments
  • one or more namespaces

Methods

static PhpFile
fromCode(string $code)

No description

ClassType
addClass(string $name)

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

InterfaceType
addInterface(string $name)

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

TraitType
addTrait(string $name)

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

EnumType
addEnum(string $name)

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

GlobalFunction
addFunction(string $name)

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

PhpNamespace
addNamespace(PhpNamespace $namespace)

Adds a namespace to the file. If it already exists, it returns the existing one.

void
removeNamespace(PhpNamespace $namespace)

Removes the namespace from the file.

array
getNamespaces()

No description

array
getClasses()

No description

array
getFunctions()

No description

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

Adds a use statement to the file, to the global namespace.

PhpFile
setStrictTypes(bool $state = true)

Adds declare(strict_types=1) to output.

bool
hasStrictTypes()

No description

string
__toString()

No description

Details

at line 30
static PhpFile fromCode(string $code)

No description

Parameters

string $code

Return Value

PhpFile

at line 40
ClassType addClass(string $name)

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

As a parameter, pass the full name with namespace.

Parameters

string $name

Return Value

ClassType

at line 52
InterfaceType addInterface(string $name)

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

As a parameter, pass the full name with namespace.

Parameters

string $name

Return Value

InterfaceType

at line 64
TraitType addTrait(string $name)

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

As a parameter, pass the full name with namespace.

Parameters

string $name

Return Value

TraitType

at line 76
EnumType addEnum(string $name)

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

As a parameter, pass the full name with namespace.

Parameters

string $name

Return Value

EnumType

at line 88
GlobalFunction addFunction(string $name)

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

As a parameter, pass the full name with namespace.

Parameters

string $name

Return Value

GlobalFunction

at line 99
PhpNamespace addNamespace(PhpNamespace $namespace)

Adds a namespace to the file. If it already exists, it returns the existing one.

Parameters

PhpNamespace $namespace

Return Value

PhpNamespace

at line 116
void removeNamespace(PhpNamespace $namespace)

Removes the namespace from the file.

Parameters

PhpNamespace $namespace

Return Value

void

at line 124
array getNamespaces()

No description

Return Value

array

at line 131
array getClasses()

No description

Return Value

array

at line 146
array getFunctions()

No description

Return Value

array

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

Adds a use statement to the file, to the global namespace.

Parameters

string $name
string|null $alias
string $of

Return Value

PhpFile

at line 173
PhpFile setStrictTypes(bool $state = true)

Adds declare(strict_types=1) to output.

Parameters

bool $state

Return Value

PhpFile

at line 180
bool hasStrictTypes()

No description

Return Value

bool

at line 186
string __toString()

No description

Return Value

string

Traits

CommentAware