Класс yii\gii\CodeFile

Все классы | Свойства | Методы | Константы

Наследование	yii\gii\CodeFile » yii\base\Object
Реализует	yii\base\Configurable
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2-gii/blob/master/CodeFile.php

CodeFile представляет собой файл кода, который необходимо сгенерировать.

Публичные свойства

Свойство	Тип	Описание	Определено в
$content	string	Новое содержимое сгенерированного кода	yii\gii\CodeFile
$id	string	Идентификатор, уникально определяющий этот файл кода.	yii\gii\CodeFile
$operation	string	Операция, которая должна быть выполнена.	yii\gii\CodeFile
$path	string	Путь к файлу, в который должен быть сохранен новый код.	yii\gii\CodeFile
$relativePath	string	Путь к файлу кода относительно базового пути приложения.	yii\gii\CodeFile
$type	string	Расширение файла кода (например, php, txt)	yii\gii\CodeFile

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает метод с указанным именем, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\gii\CodeFile
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, задано ли свойство, т. е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в null.	yii\base\Object
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное имя этого класса.	yii\base\Object
diff()	Возвращает diff или false, если его нельзя вычислить	yii\gii\CodeFile
getRelativePath()		yii\gii\CodeFile
getType()		yii\gii\CodeFile
hasMethod()	Возвращает значение, указывающее, определен ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object
preview()	Возвращает представление или false, если его нельзя отобразить	yii\gii\CodeFile
save()	Сохраняет код в файл, указанный свойством $path.	yii\gii\CodeFile

Константы

Константа	Значение	Описание	Определено в
OP_CREATE	'create'	Файл кода новый.	yii\gii\CodeFile
OP_OVERWRITE	'overwrite'	Файл кода уже существует, и новый может потребоваться перезаписать.	yii\gii\CodeFile
OP_SKIP	'skip'	Новый файл кода и существующий идентичны.	yii\gii\CodeFile

Подробности о свойствах

$content публичное свойство

Новое содержимое сгенерированного кода

public string $content = null

$id публичное свойство

Идентификатор, уникально определяющий этот файл кода.

public string $id = null

$operation публичное свойство

Операция, которая должна быть выполнена. Это может быть OP_CREATE, OP_OVERWRITE или OP_SKIP.

public string $operation = null

$path публичное свойство

Путь к файлу, в который должен быть сохранен новый код.

public string $path = null

$relativePath публичное только для чтения свойство

Путь к файлу кода относительно базового пути приложения.

public string getRelativePath ( )

$type публичное только для чтения свойство

Расширение файла кода (например, php, txt)

public string getType ( )

Подробности о методах

__construct() public method

Конструктор.

public void __construct ( $path, $content, $config = [] )
$path	string	Путь к файлу, в который должен быть сохранён новый код.
$content	string	Содержимое сгенерированного кода.
$config	array	Пара ключ-значение для инициализации свойств объекта.

diff() public method

Возвращает diff или false, если его невозможно вычислить

public boolean\|string diff ( )

getRelativePath() public method

public string getRelativePath ( )
return	string	Путь к файлу кода относительно базового пути приложения.

getType() public method

public string getType ( )
return	string	Расширение файла кода (например, php, txt)

preview() public method

Возвращает предварительный просмотр или false, если его невозможно отобразить

public boolean\|string preview ( )

save() public method

Сохраняет код в файл, указанный параметром $path.

public string\|boolean save ( )
return	string\|boolean	Возвращает сообщение об ошибке, произошедшей во время сохранения файла кода, или true, если ошибок нет.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-gii-codefile.html