PHP Class Devise\Languages\LocaleDetector

Show file Open project: devisephp/cms

Protected Properties

Property Type Description
$cookieKey string The cookie we store the locale under

Public Methods

Method Description
__construct ( Framework $Framework ) Construct a new LocaleDetector
cookie ( ) : string Get the locale from a cookie
current ( ) : string Get the current locale. At first we try to use the cookie if one is set. If a cookie is not set then we attempt to deduce the locale in this order: url segment, http headers, and finally we fall back to the universal locale which is set in laravel's app.locale (defaults to en).
header ( ) : string Get locale from header accept string
segment ( ) : string We don't use this, but we could use it later if we wanted to. It would get the locale from the first segment of the url, e.g.
universal ( ) : string Get the universal locale set by developer and laravel
update ( string $locale ) : string Updates the locale stored in this cookie

Method Details

__construct() public method

Construct a new LocaleDetector
public __construct ( Framework $Framework )
$Framework Devise\Support\Framework

current() public method

Get the current locale. At first we try to use the cookie if one is set. If a cookie is not set then we attempt to deduce the locale in this order: url segment, http headers, and finally we fall back to the universal locale which is set in laravel's app.locale (defaults to en).
public current ( ) : string
return string

header() public method

Get locale from header accept string
public header ( ) : string
return string

segment() public method

http://somesite.com/en/cool/page
public segment ( ) : string
return string

universal() public method

Get the universal locale set by developer and laravel
public universal ( ) : string
return string

update() public method

Updates the locale stored in this cookie
public update ( string $locale ) : string
$locale string
return string

Property Details

$cookieKey protected property

The cookie we store the locale under
protected string $cookieKey
return string