PHP Class BcSite

Datei anzeigen Open project: baserproject/basercms Class Usage Examples

Public Properties

Property Type Description
$alias string エイリアス
$autoLink boolean 自動リンク
$autoRedirect boolean 自動リダイレクト
$device string デバイス
$domainType
$enabled boolean 利用可否
$id integer サイトID
$lang string 言語
$mainSiteId integer メインサイトID
$name string 名前
$sameMainUrl boolean 同一URL
$theme
$useSubDomain

Protected Properties

Property Type Description
$_sites null サブサイトリスト

Public Methods

Method Description
__construct ( string $name, array $config ) コンストラクタ
existsUrl ( CakeRequest $request ) : boolean URLが存在するか確認
findAll ( ) : BcSite[] 関連するサブサイトを全て取得する
findByAlias ( $alias ) : BcSite | null エイリアスからサイトを検索する
findById ( $id )
findByUrl ( $url )
findCurrent ( boolean $direct = true ) : BcSite | null URLからサブサイトを取得する
findCurrentMain ( ) : BcSite | null 現在のサイトに関連するメインサイトを取得
findCurrentSub ( boolean $sameMainUrl = false, BcAgent $agent = null, $lang = null ) : BcSite | null 現在のサイトとユーザーエージェントに関連するサブサイトを取得する
flash ( )
getMain ( ) : BcSite | null メインサイトを取得
getPureUrl ( string $url ) : mixed | string エイリアスを除外したURLを取得
isEnabled ( ) : boolean 設定が有効かどうかを判定
makeUrl ( CakeRequest $request ) : string エイリアスを反映したURLを生成 同一URL設定のみ利用可
shouldRedirects ( CakeRequest $request ) : boolean 与えられたリクエストに対して自動リダイレクトすべきかどうかを返す

Protected Methods

Method Description
_setConfig ( array $config ) : void 設定

Method Details

__construct() public method

コンストラクタ
public __construct ( string $name, array $config )
$name string 名前
$config array 設定の配列

_setConfig() protected method

設定
protected _setConfig ( array $config ) : void
$config array 設定の配列
return void

existsUrl() public method

URLが存在するか確認
public existsUrl ( CakeRequest $request ) : boolean
$request CakeRequest
return boolean

findAll() public static method

関連するサブサイトを全て取得する
public static findAll ( ) : BcSite[]
return BcSite[]

findByAlias() public static method

エイリアスからサイトを検索する
public static findByAlias ( $alias ) : BcSite | null
$alias
return BcSite | null

findById() public static method

public static findById ( $id )

findByUrl() public static method

public static findByUrl ( $url )

findCurrent() public static method

URLからサブサイトを取得する
public static findCurrent ( boolean $direct = true ) : BcSite | null
$direct boolean
return BcSite | null

findCurrentMain() public static method

現在のサイトに関連するメインサイトを取得
public static findCurrentMain ( ) : BcSite | null
return BcSite | null

findCurrentSub() public static method

現在のサイトとユーザーエージェントに関連するサブサイトを取得する
public static findCurrentSub ( boolean $sameMainUrl = false, BcAgent $agent = null, $lang = null ) : BcSite | null
$sameMainUrl boolean
$agent BcAgent
return BcSite | null

flash() public static method

public static flash ( )

getMain() public method

メインサイトを取得
public getMain ( ) : BcSite | null
return BcSite | null

getPureUrl() public method

エイリアスを除外したURLを取得
public getPureUrl ( string $url ) : mixed | string
$url string
return mixed | string

isEnabled() public method

設定が有効かどうかを判定
public isEnabled ( ) : boolean
return boolean

makeUrl() public method

エイリアスを反映したURLを生成 同一URL設定のみ利用可
public makeUrl ( CakeRequest $request ) : string
$request CakeRequest リクエスト
return string

shouldRedirects() public method

与えられたリクエストに対して自動リダイレクトすべきかどうかを返す
public shouldRedirects ( CakeRequest $request ) : boolean
$request CakeRequest リクエスト
return boolean

Property Details

$_sites protected_oe static_oe property

サブサイトリスト
protected static null $_sites
return null

$alias public_oe property

エイリアス
public string $alias
return string

$autoRedirect public_oe property

自動リダイレクト
public bool $autoRedirect
return boolean

$device public_oe property

デバイス
public string $device
return string

$domainType public_oe property

public $domainType

$enabled public_oe property

利用可否
public bool $enabled
return boolean

$id public_oe property

サイトID
public int $id
return integer

$lang public_oe property

言語
public string $lang
return string

$mainSiteId public_oe property

メインサイトID
public int $mainSiteId
return integer

$name public_oe property

名前
public string $name
return string

$sameMainUrl public_oe property

同一URL
public bool $sameMainUrl
return boolean

$theme public_oe property

public $theme

$useSubDomain public_oe property

public $useSubDomain