PHP Класс ProcessWire, ProcessWire

Gets ProcessWire's API ready for use
Наследование: extends Wire
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_fuel Fuel | null This will replace the static $fuel from the Wire class in PW 3.0. Currently it is just here as a placeholder.
$debug boolean Whether debug mode is on or off
$pathSave string Saved path, for includeFile() method
$updater SystemUpdater | null

Открытые методы

Метод Описание
__call ( $method, $arguments )
__construct ( Config $config ) Given a Config object, instantiates ProcessWire and it's API
__toString ( )
load ( Config $config ) Load's ProcessWire using the supplied Config and populates all API fuel
set ( $key, $value, boolean $lock = false ) Set a new API variable
setStatus ( $status ) Set the system status to one of the ProcessWire::status* constants

Защищенные методы

Метод Описание
___finished ( ) Hookable ready for anyone that wants to hook when the request is finished
___init ( ) Hookable init for anyone that wants to hook immediately before any autoload modules initialized or after all modules initialized
___ready ( ) Hookable ready for anyone that wants to hook immediately before any autoload modules ready or after all modules ready
config ( Config $config ) Populate ProcessWire's configuration with runtime and optional variables
getHttpHost ( Config $config ) : string Safely determine the HTTP host
includeFile ( $file ) : boolean Include a PHP file, giving it all PW API varibles in scope
initVar ( string $name, Wire $value ) Initialize the given API var

Описание методов

___finished() защищенный Метод

Hookable ready for anyone that wants to hook when the request is finished
protected ___finished ( )

___init() защищенный Метод

Hookable init for anyone that wants to hook immediately before any autoload modules initialized or after all modules initialized
protected ___init ( )

___ready() защищенный Метод

Hookable ready for anyone that wants to hook immediately before any autoload modules ready or after all modules ready
protected ___ready ( )

__call() публичный Метод

public __call ( $method, $arguments )

__construct() публичный Метод

Given a Config object, instantiates ProcessWire and it's API
public __construct ( Config $config )
$config Config

__toString() публичный Метод

public __toString ( )

config() защищенный Метод

$param Config $config
protected config ( Config $config )
$config Config

getHttpHost() защищенный Метод

Safely determine the HTTP host
protected getHttpHost ( Config $config ) : string
$config Config
Результат string

includeFile() защищенный Метод

File is executed in the directory where it exists.
protected includeFile ( $file ) : boolean
$file Full path and filename
Результат boolean True if file existed and was included, false if not.

initVar() защищенный Метод

Initialize the given API var
protected initVar ( string $name, Wire $value )
$name string
$value Wire

load() публичный Метод

Load's ProcessWire using the supplied Config and populates all API fuel
public load ( Config $config )
$config Config

set() публичный Метод

Alias of $this->wire(), but for setting only, for syntactic convenience. i.e. $this->wire()->set($key, $value);
public set ( $key, $value, boolean $lock = false )
$key API variable name to set
$value Value of API variable
$lock boolean Whether to lock the value from being overwritten

setStatus() публичный Метод

This also triggers init/ready functions for modules, when applicable.
public setStatus ( $status )
$status

Описание свойств

$_fuel защищенное свойство

This will replace the static $fuel from the Wire class in PW 3.0. Currently it is just here as a placeholder.
protected Fuel|null $_fuel
Результат Fuel | null

$debug защищенное свойство

Whether debug mode is on or off
protected bool $debug
Результат boolean

$pathSave защищенное свойство

Saved path, for includeFile() method
protected string $pathSave
Результат string

$updater защищенное свойство

protected SystemUpdater|null $updater
Результат SystemUpdater | null