HumHub Documentation (unofficial)

CodeFile extends BaseObject
in package

CodeFile represents a code file to be generated.

Tags
author

Qiang Xue qiang.xue@gmail.com

since
2.0

Table of Contents

Constants

OP_CREATE  = 'create'
The code file is new.
OP_OVERWRITE  = 'overwrite'
The code file already exists, and the new one may need to overwrite it.
OP_SKIP  = 'skip'
The new code file and the existing one are identical.

Properties

$content  : string
$id  : string
$operation  : string
$path  : string
$relativePath  : string
$type  : string

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
diff()  : bool|string
Returns diff or false if it cannot be calculated
getRelativePath()  : string
getType()  : string
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
preview()  : bool|string
Returns preview or false if it cannot be rendered
save()  : string|bool
Saves the code into the file specified by [[path]].
renderDiff()  : string
Renders diff between two sets of lines

Constants

OP_CREATE

The code file is new.

public mixed OP_CREATE = 'create'

OP_OVERWRITE

The code file already exists, and the new one may need to overwrite it.

public mixed OP_OVERWRITE = 'overwrite'

OP_SKIP

The new code file and the existing one are identical.

public mixed OP_SKIP = 'skip'

Properties

$content

public string $content

the newly generated code content

$id

public string $id

an ID that uniquely identifies this code file.

$operation

public string $operation

the operation to be performed. This can be [[OP_CREATE]], [[OP_OVERWRITE]] or [[OP_SKIP]].

$path

public string $path

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

$relativePath read-only

public string $relativePath

The code file path relative to the application base path.

$type read-only

public string $type

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

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct(string $path, string $content[, array<string|int, mixed> $config = [] ]) : mixed
Parameters
$path : string

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

$content : string

the newly generated code content.

$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

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

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

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

public __isset(string $name) : bool

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.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

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

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

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.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

diff()

Returns diff or false if it cannot be calculated

public diff() : bool|string
Return values
bool|string

getRelativePath()

public getRelativePath() : string
Return values
string —

the code file path relative to the application base path.

getType()

public getType() : string
Return values
string —

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

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

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

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

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

preview()

Returns preview or false if it cannot be rendered

public preview() : bool|string
Return values
bool|string

save()

Saves the code into the file specified by [[path]].

public save() : string|bool
Return values
string|bool —

the error occurred while saving the code file, or true if no error.

renderDiff()

Renders diff between two sets of lines

private renderDiff(mixed $lines1, mixed $lines2) : string
Parameters
$lines1 : mixed
$lines2 : mixed
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results