Solar_Sql::locale()
public
string
Solar_Sql::locale
( string $key
, string $num = 1
, array $replace = NULL
)
Looks up class-specific locale strings based on a key.
Inherited from Solar_Base.
Parameters
(string)
$key: The key to get a locale string for.(string)
$num: If 1, returns a singular string; otherwise, returns a plural string (if one exists).(array)
$replace: An array of replacement values for the string.
Returns
(string) The locale string, or the original $key if no string found.
Description
Looks up class-specific locale strings based on a key.
This is a convenient shortcut for calling that automatically uses the current class name.
You can also pass an array of replacement values. If the $replace
array is sequential, this method will use it with vsprintf(); if the
array is associative, this method will replace "{:key}" with the array
value.
For example:
<?php
$page = 2;
$pages = 10;
// given a locale string TEXT_PAGES => 'Page %d of %d'
$replace = array($page, $pages);
return $this->locale('Solar_Example', 'TEXT_PAGES',
$pages, $replace);
// returns "Page 2 of 10"
// given a locale string TEXT_PAGES => 'Page {:page} of {:pages}'
$replace = array('page' => $page, 'pages' => $pages);
return $this->locale('Solar_Example', 'TEXT_PAGES',
$pages, $replace);
// returns "Page 2 of 10"