PHP Class Xpressengine\Seo\Setting

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

Protected Properties

Property Type Description
$cfg Xpressengine\Config\ConfigManager ConfigManager instance
$config Xpressengine\Config\ConfigEntity ConfigEntity instance
$image Xpressengine\Media\Models\Image Image instance
$key string Key for config
$keygen Xpressengine\Keygen\Keygen Keygen instance
$media Xpressengine\Media\MediaManager MediaManager instance
$storage Xpressengine\Storage\Storage Storage instance

Public Methods

Method Description
__construct ( ConfigManager $cfg, Storage $storage, MediaManager $media, Keygen $keygen ) Constructor
exists ( ) : boolean Check a setting information exists
get ( string $name, mixed $default = null ) : mixed Get setting value
getSiteImage ( ) : Image Get site representative image
set ( array $data ) : void Set setting information
setSiteImage ( Image $image ) : void Set site representative image

Method Details

__construct() public method

Constructor
public __construct ( ConfigManager $cfg, Storage $storage, MediaManager $media, Keygen $keygen )
$cfg Xpressengine\Config\ConfigManager ConfigManager instance
$storage Xpressengine\Storage\Storage Storage instance
$media Xpressengine\Media\MediaManager MediaManager instance
$keygen Xpressengine\Keygen\Keygen Keygen instance

exists() public method

Check a setting information exists
public exists ( ) : boolean
return boolean

get() public method

Get setting value
public get ( string $name, mixed $default = null ) : mixed
$name string key name
$default mixed default value when not exists
return mixed

getSiteImage() public method

Get site representative image
public getSiteImage ( ) : Image
return Xpressengine\Media\Models\Image

set() public method

Set setting information
public set ( array $data ) : void
$data array setting data
return void

setSiteImage() public method

Set site representative image
public setSiteImage ( Image $image ) : void
$image Xpressengine\Media\Models\Image image instance
return void

Property Details

$cfg protected property

ConfigManager instance
protected ConfigManager,Xpressengine\Config $cfg
return Xpressengine\Config\ConfigManager

$config protected property

ConfigEntity instance
protected ConfigEntity,Xpressengine\Config $config
return Xpressengine\Config\ConfigEntity

$image protected property

Image instance
protected Image,Xpressengine\Media\Models $image
return Xpressengine\Media\Models\Image

$key protected property

Key for config
protected string $key
return string

$keygen protected property

Keygen instance
protected Keygen,Xpressengine\Keygen $keygen
return Xpressengine\Keygen\Keygen

$media protected property

MediaManager instance
protected MediaManager,Xpressengine\Media $media
return Xpressengine\Media\MediaManager

$storage protected property

Storage instance
protected Storage,Xpressengine\Storage $storage
return Xpressengine\Storage\Storage