PHP Interface Xpressengine\Config\ConfigRepository

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Show file Open project: xpressengine/xpressengine Interface Usage Examples

Public Methods

Method Description
affiliate ( ConfigEntity $config, string $to ) : void affiliated to another config
clearLike ( ConfigEntity $config, array $excepts = [] ) : void clear all just descendants vars
fetchAncestor ( string $siteKey, string $name ) : array search ancestors getter
fetchDescendant ( string $siteKey, string $name ) : array search descendants getter
find ( string $siteKey, string $name ) : ConfigEntity search getter
foster ( ConfigEntity $config, string $to ) : void Parent Changing with descendant
remove ( string $siteKey, string $name ) : void remove
save ( ConfigEntity $config ) : ConfigEntity save

Method Details

affiliate() public method

affiliated to another config
public affiliate ( ConfigEntity $config, string $to ) : void
$config ConfigEntity config object
$to string parent name
return void

clearLike() public method

clear all just descendants vars
public clearLike ( ConfigEntity $config, array $excepts = [] ) : void
$config ConfigEntity config object
$excepts array target to the except
return void

fetchAncestor() public method

search ancestors getter
public fetchAncestor ( string $siteKey, string $name ) : array
$siteKey string site key
$name string the name
return array

fetchDescendant() public method

search descendants getter
public fetchDescendant ( string $siteKey, string $name ) : array
$siteKey string site key
$name string the name
return array

find() public method

search getter
public find ( string $siteKey, string $name ) : ConfigEntity
$siteKey string site key
$name string the name
return ConfigEntity

foster() public method

Parent Changing with descendant
public foster ( ConfigEntity $config, string $to ) : void
$config ConfigEntity config object
$to string to config prefix
return void

remove() public method

remove
public remove ( string $siteKey, string $name ) : void
$siteKey string site key
$name string the name
return void

save() public method

save
public save ( ConfigEntity $config ) : ConfigEntity
$config ConfigEntity config object
return ConfigEntity