Class yii\gii\CodeFile

All Classes | Properties | Methods | Constants
Inheritanceyii\gii\CodeFile » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.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. yii\gii\CodeFile
$type string The code file extension (e.g. php, txt). 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

Hide inherited properties

$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.

public string $relativePath = null
$type public property

The code file extension (e.g. php, txt).

public string $type = null

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name
$params array

Method parameters
return mixed

The method return value
throws yii\base\UnknownMethodException

when calling unknown method

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__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

 

                public function __construct($path, $content, $config = [])
{
    parent::__construct($config);
    $this->path = strtr($path, '/\\', DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR);
    $this->content = $content;
    $this->id = md5($this->path);
    if (is_file($path)) {
        $this->operation = file_get_contents($path) === $content ? self::OP_SKIP : self::OP_OVERWRITE;
    } else {
        $this->operation = self::OP_CREATE;
    }
}
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name
return mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is write-only

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name
return boolean

Whether the named property is set (not null).

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name
$value mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is read-only

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name
throws yii\base\InvalidCallException

if the property is read only.

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be read

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be written

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

 

                public static function className()
{
    return get_called_class();
}
diff() public method

Returns diff or false if it cannot be calculated

public boolean|string diff ( )

                public function diff()
{
    $type = strtolower($this->getType());
    if (in_array($type, ['jpg', 'gif', 'png', 'exe'])) {
        return false;
    } elseif ($this->operation === self::OP_OVERWRITE) {
        return $this->renderDiff(file($this->path), $this->content);
    }
    return '';
}
getRelativePath() public method

public string getRelativePath ( )
return string

The code file path relative to the application base path.

 

                public function getRelativePath()
{
    if (strpos($this->path, Yii::$app->basePath) === 0) {
        return substr($this->path, strlen(Yii::$app->basePath) + 1);
    }
    return $this->path;
}
getType() public method

public string getType ( )
return string

The code file extension (e.g. php, txt)

 

                public function getType()
{
    if (($pos = strrpos($this->path, '.')) !== false) {
        return substr($this->path, $pos + 1);
    }
    return 'unknown';
}
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name
return boolean

Whether the method is defined

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

public boolean hasProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property is defined

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}
preview() public method

Returns preview or false if it cannot be rendered

public boolean|string preview ( )

                public function preview()
{
    if (($pos = strrpos($this->path, '.')) !== false) {
        $type = substr($this->path, $pos + 1);
    } else {
        $type = 'unknown';
    }
    if ($type === 'php') {
        return highlight_string($this->content, true);
    } elseif (!in_array($type, ['jpg', 'gif', 'png', 'exe'])) {
        return nl2br(Html::encode($this->content));
    }
    return false;
}
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.

 

                public function save()
{
    $module = isset(Yii::$app->controller) ? Yii::$app->controller->module : null;
    if ($this->operation === self::OP_CREATE) {
        $dir = dirname($this->path);
        if (!is_dir($dir)) {
            if ($module instanceof \yii\gii\Module) {
                $mask = @umask(0);
                $result = @mkdir($dir, $module->newDirMode, true);
                @umask($mask);
            } else {
                $result = @mkdir($dir, 0777, true);
            }
            if (!$result) {
                return "Unable to create the directory '$dir'.";
            }
        }
    }
    if (@file_put_contents($this->path, $this->content) === false) {
        return "Unable to write the file '{$this->path}'.";
    }
    if ($module instanceof \yii\gii\Module) {
        $mask = @umask(0);
        @chmod($this->path, $module->newFileMode);
        @umask($mask);
    }
    return true;
}