# Class yii\gii\CodeFile

Inheritance | yii\gii\CodeFile » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-gii/blob/master/CodeFile.php

CodeFile represents a code file to be generated.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$content | string | The newly generated code content | yii\gii\CodeFile
$id | string | An ID that uniquely identifies this code file. | yii\gii\CodeFile
$operation | string | The operation to be performed. | yii\gii\CodeFile
$path | string | The file path that the new code should be saved to. | yii\gii\CodeFile
$relativePath | string | The code file path relative to the application base path. This property is read-only. | yii\gii\CodeFile
$type | string | The code file extension (e.g. php, txt). This property is read-only. | yii\gii\CodeFile

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\BaseObject
__construct() | Constructor. | yii\gii\CodeFile
__get() | Returns the value of an object property. | yii\base\BaseObject
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject
__set() | Sets value of an object property. | yii\base\BaseObject
__unset() | Sets an object property to null. | yii\base\BaseObject
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
diff() | Returns diff or false if it cannot be calculated | yii\gii\CodeFile
getRelativePath() |  | yii\gii\CodeFile
getType() |  | yii\gii\CodeFile
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject
init() | Initializes the object. | yii\base\BaseObject
preview() | Returns preview or false if it cannot be rendered | yii\gii\CodeFile
save() | Saves the code into the file specified by $path. | yii\gii\CodeFile

## Constants

Hide inherited constants

Constant | Value | Description | Defined By
--- | --- | --- | ---
OP_CREATE | 'create' | The code file is new. | yii\gii\CodeFile
OP_OVERWRITE | 'overwrite' | The code file already exists, and the new one may need to overwrite it. | yii\gii\CodeFile
OP_SKIP | 'skip' | The new code file and the existing one are identical. | yii\gii\CodeFile

## Property Details

$content public property

The newly generated code content

public string $content = null
$id public property

An ID that uniquely identifies this code file.

public string $id = null
$operation public property

The operation to be performed. This can be OP_CREATE, OP_OVERWRITE or OP_SKIP.

public string $operation = null
$path public property

The file path that the new code should be saved to.

public string $path = null
$relativePath public property

The code file path relative to the application base path. This property is read-only.

public string $relativePath = null
$type public property

The code file extension (e.g. php, txt). This property is read-only.

public string $type = null

## Method Details

__construct() public method

Constructor.

public void __construct ( $path, $content, $config = [] )
$path | string | The file path that the new code should be saved to.
$content | string | The newly generated code content.
$config | array | Name-value pairs that will be used to initialize the object properties

diff() public method

Returns diff or false if it cannot be calculated

public boolean|string diff ( )

getRelativePath() public method

public string getRelativePath ( )
return | string | The code file path relative to the application base path.

getType() public method

public string getType ( )
return | string | The code file extension (e.g. php, txt)

preview() public method

Returns preview or false if it cannot be rendered

public boolean|string preview ( )

save() public method

Saves the code into the file specified by $path.

public string|boolean save ( )
return | string|boolean | The error occurred while saving the code file, or true if no error.