PHP Class Xpressengine\Plugin\Composer\ComposerFileWriter

Author: XE Team (developers) ([email protected])
ファイルを表示 Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property Type Description
$data array
$path string

Public Methods

Method Description
__construct ( string $path, PluginScanner $scanner, string $packagistUrl ) ComposerFileWriter constructor.
addRequire ( string $name, string $version ) add plugin to require
all ( ) : array get all data
cleanOperation ( ) 현재 실행중인 작업에 대한 정보를 초기화 한다.
get ( string $key, mixed $default = null ) : mixed retreive data
getPath ( ) : string
install ( string $name, string $version, string $expiredTime ) register plugin to install list
load ( ) : void json 파일의 내용을 메모리에 읽어온다.
makeFile ( ) : void generate plugin composer file
removeRequire ( string $name ) remove plugin from require
reset ( ) 현재 설치된 플러그인들의 정보를 조회하여 반영한다.
set ( string $key, mixed $value ) : void set data
setFixMode ( ) : void setFixMode
setUpdateMode ( ) : void setUpdateMode
uninstall ( string $name, string $expiredTime ) register plugin to uninstall list
update ( string $name, string $version, string $expiredTime ) register plugin to update list
write ( ) : void save loaded data to plugin composer file

Method Details

__construct() public method

ComposerFileWriter constructor.
public __construct ( string $path, PluginScanner $scanner, string $packagistUrl )
$path string path of plugin composer file
$scanner Xpressengine\Plugin\PluginScanner plugin scanner
$packagistUrl string packagist url

addRequire() public method

add plugin to require
public addRequire ( string $name, string $version )
$name string package name of plugin
$version string version of plugin

all() public method

get all data
public all ( ) : array
return array

cleanOperation() public method

현재 실행중인 작업에 대한 정보를 초기화 한다.
public cleanOperation ( )

get() public method

retreive data
public get ( string $key, mixed $default = null ) : mixed
$key string data field key
$default mixed default data
return mixed

getPath() public method

public getPath ( ) : string
return string

install() public method

register plugin to install list
public install ( string $name, string $version, string $expiredTime )
$name string package name of plugin
$version string plugin version
$expiredTime string deadline

load() public method

json 파일의 내용을 메모리에 읽어온다.
public load ( ) : void
return void

makeFile() public method

generate plugin composer file
public makeFile ( ) : void
return void

removeRequire() public method

remove plugin from require
public removeRequire ( string $name )
$name string package name of plugin

reset() public method

현재 설치된 플러그인들의 정보를 조회하여 반영한다.
public reset ( )

set() public method

set data
public set ( string $key, mixed $value ) : void
$key string data field key
$value mixed data value
return void

setFixMode() public method

setFixMode
public setFixMode ( ) : void
return void

setUpdateMode() public method

setUpdateMode
public setUpdateMode ( ) : void
return void

uninstall() public method

register plugin to uninstall list
public uninstall ( string $name, string $expiredTime )
$name string package name of plugin
$expiredTime string deadline*

update() public method

register plugin to update list
public update ( string $name, string $version, string $expiredTime )
$name string package name of plugin
$version string plugin version
$expiredTime string deadline

write() public method

save loaded data to plugin composer file
public write ( ) : void
return void

Property Details

$data protected_oe property

protected array $data
return array

$path protected_oe property

protected string $path
return string