Documentation

Site_Controller_Template extends Core_Servant_Properties
in package

Sites.

Tags
subpackage

Site

version
7.x
author

Hostmake LLC

copyright

© 2005-2024 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Table of Contents

Properties

$instance  : mixed
The singleton instances.
$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_propertiesValues  : array<string|int, mixed>
Properties values
$_unlimitedProperties  : bool
Object has unlimited number of properties

Methods

__construct()  : mixed
Constructor.
addAllowedProperties()  : self
Add additional allowed properties
addAllowedProperty()  : self
Add additional allowed property
getDriverName()  : string
Get name of the driver
getFields()  : array<string|int, mixed>
Get fields
getFileExtension()  : mixed
Определение расширения файла по его названию без расширения
getSelectedTemplateXml()  : mixed
Get XML of selected template
getTemplateXml()  : string
Get XML of templates list
getTemplateXmlArray()  : array<string|int, mixed>
Convert XML to array
instance()  : object
Register an existing instance as a singleton.
loadFile()  : string
Load file with replace of macroses
loadSelectedTemplateXml()  : SimpleXMLElement
Load selected template
loadTemplatesXml()  : mixed
Load template's XML
macroReplace()  : string
Replace of macroses in input string
replaceFile()  : mixed
Заменяет макросы в уже существующем файле
set()  : self
Run when writing data to inaccessible properties
setUnlimitedProperties()  : self
Set unlimitedProperties

Properties

$instance

The singleton instances.

public static mixed $instance = \NULL

$_allowedProperties

Allowed object properties

protected array<string|int, mixed> $_allowedProperties = array('server', 'chmodFile', 'templatePath', 'templateFilename', 'templateSelectedFilename')

$_propertiesValues

Properties values

protected array<string|int, mixed> $_propertiesValues = array()

$_unlimitedProperties

Object has unlimited number of properties

protected bool $_unlimitedProperties = \FALSE

Methods

__construct()

Constructor.

public __construct() : mixed

addAllowedProperties()

Add additional allowed properties

public addAllowedProperties(array<string|int, mixed> $array) : self
Parameters
$array : array<string|int, mixed>

array of properties' names

Return values
self

addAllowedProperty()

Add additional allowed property

public addAllowedProperty(string $property) : self
Parameters
$property : string

property name

Return values
self

getDriverName()

Get name of the driver

public static getDriverName() : string
Return values
string

getFields()

Get fields

public getFields(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
Return values
array<string|int, mixed>

getFileExtension()

Определение расширения файла по его названию без расширения

public getFileExtension( $path_file_without_extension) : mixed
Parameters
$path_file_without_extension :
  • путь к файлу без расширения

getSelectedTemplateXml()

Get XML of selected template

public getSelectedTemplateXml() : mixed

getTemplateXml()

Get XML of templates list

public getTemplateXml() : string
Return values
string

getTemplateXmlArray()

Convert XML to array

public getTemplateXmlArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

instance()

Register an existing instance as a singleton.

public static instance() : object
Return values
object

loadFile()

Load file with replace of macroses

public loadFile(string $filename[, array<string|int, mixed> $aReplace = array() ]) : string
Parameters
$filename : string

file name

$aReplace : array<string|int, mixed> = array()

macroses

Return values
string

loadSelectedTemplateXml()

Load selected template

public loadSelectedTemplateXml() : SimpleXMLElement
Return values
SimpleXMLElement

loadTemplatesXml()

Load template's XML

public loadTemplatesXml() : mixed

macroReplace()

Replace of macroses in input string

public macroReplace(string $str, array<string|int, mixed> $aReplace) : string
Parameters
$str : string

source string

$aReplace : array<string|int, mixed>

macroses

Return values
string

replaceFile()

Заменяет макросы в уже существующем файле

public replaceFile(string $filename[, array<string|int, mixed> $aReplace = array() ]) : mixed
Parameters
$filename : string

путь к файлу

$aReplace : array<string|int, mixed> = array()

массив замен

set()

Run when writing data to inaccessible properties

public set(string $property, string $value) : self
Parameters
$property : string

property name

$value : string

property value

Return values
self

setUnlimitedProperties()

Set unlimitedProperties

public setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
$value : bool = TRUE

default TRUR

Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results