The parent is a locale which is more generic than the one given as
parameter. For example, the parent for locale en_GB will be locale en, of
course if it exists in the locale tree of available locales.
This method returns NULL when no parent locale is available, or when
Locale object provided is not in the tree (ie it's not in a group of
available locales).
Note: to find a best-matching locale to one which doesn't exist in the
system, please use findBestMatchingLocale() method of this class.
|
public getParentLocaleOf ( |
||
| $locale | The Locale to search parent for | |
| return | mixed | Existing Locale instance or NULL on failure |
/**
* @test
*/
public function returnsNullWhenNoParentLocaleCouldBeFound()
{
foreach ($this->locales as $locale) {
$this->localeCollection->addLocale($locale);
}
$this->assertNull($this->localeCollection->getParentLocaleOf(new I18n\Locale('sv')));
$this->assertNull($this->localeCollection->getParentLocaleOf($this->locales[0]));
}
/**
* Returns a parent Locale object of the locale provided.
*
* @param Locale $locale The Locale to search parent for
* @return Locale Existing Locale instance or NULL on failure
* @api
*/
public function getParentLocaleOf(Locale $locale)
{
return $this->localeCollection->getParentLocaleOf($locale);
}