Documentation

Versions
in package

FinalYes

Grav Versions

NOTE: This class can be initialized during upgrade from an older version of Grav. Make sure it runs there!

Table of Contents

Properties

$filename  : string
$instance  : array<string|int, self>
$items  : array<string|int, mixed>
$updated  : bool

Methods

getAll()  : array<string|int, mixed>
getExtension()  : array<string|int, mixed>|null
getGrav()  : array<string|int, mixed>|null
getHistory()  : array<string|int, mixed>
getPlugin()  : array<string|int, mixed>|null
getPlugins()  : array<string|int, mixed>
getSchema()  : string|null
getTheme()  : array<string|int, mixed>|null
getThemes()  : array<string|int, mixed>
getVersion()  : string|null
instance()  : self
removeHistory()  : void
Clears extension history. Useful when creating skeletons.
save()  : bool
setExtension()  : void
setSchema()  : void
setVersion()  : void
updateHistory()  : void
updateVersion()  : void
NOTE: Updates also history.
__construct()  : mixed
fixHistory()  : array<string|int, mixed>
get()  : mixed
Get value by using dot notation for nested arrays/objects.
set()  : void
Set value by using dot notation for nested arrays/objects.
undef()  : void
Unset value by using dot notation for nested arrays/objects.

Properties

$instance

protected static array<string|int, self> $instance

$items

protected array<string|int, mixed> $items

$updated

protected bool $updated = false

Methods

getAll()

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

getExtension()

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

getGrav()

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

getHistory()

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

getPlugin()

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

getPlugins()

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

getSchema()

public getSchema(string $extension) : string|null
Parameters
$extension : string
Return values
string|null

getTheme()

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

getThemes()

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

getVersion()

public getVersion(string $extension) : string|null
Parameters
$extension : string
Return values
string|null

instance()

public static instance([string|null $filename = null ]) : self
Parameters
$filename : string|null = null
Return values
self

removeHistory()

Clears extension history. Useful when creating skeletons.

public removeHistory(string $extension) : void
Parameters
$extension : string

save()

public save() : bool
Return values
bool —

True if the file was updated.

setExtension()

public setExtension(string $extension, array<string|int, mixed>|null $value) : void
Parameters
$extension : string
$value : array<string|int, mixed>|null

setSchema()

public setSchema(string $extension, string|null $schema) : void
Parameters
$extension : string
$schema : string|null

setVersion()

public setVersion(string $extension, string|null $version) : void
Parameters
$extension : string
$version : string|null

updateHistory()

public updateHistory(string $extension, string|null $version) : void
Parameters
$extension : string
$version : string|null

updateVersion()

NOTE: Updates also history.

public updateVersion(string $extension, string|null $version) : void
Parameters
$extension : string
$version : string|null

__construct()

private __construct(string $filename) : mixed
Parameters
$filename : string

fixHistory()

private fixHistory(array<string|int, mixed> $history) : array<string|int, mixed>
Parameters
$history : array<string|int, mixed>
Return values
array<string|int, mixed>

get()

Get value by using dot notation for nested arrays/objects.

private get(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string

Slash separated path to the requested value.

$default : mixed = null

Default value (or null).

Return values
mixed —

Value.

set()

Set value by using dot notation for nested arrays/objects.

private set(string $name, mixed $value) : void
Parameters
$name : string

Slash separated path to the requested value.

$value : mixed

New value.

undef()

Unset value by using dot notation for nested arrays/objects.

private undef(string $name) : void
Parameters
$name : string

Dot separated path to the requested value.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results