Utils class
Various static methods that don't belong yet to a specialized class
checkboxDefaultOption(string $option, string $cookie) : string
Helper function to set checkboxes value for the default option in source locale, target locale and repository depending on the cookie
| string | $option | The checkbox |
| string | $cookie | Out cookie |
Checked html attribute if cookie matches $option or false
checkboxState(string $str, string $extra = '') : string
Helper function to set checkboxes value in <input> on main search form Example: <input type="checkbox" id="case_sensitive" value="case_sensitive" <?=Utils::checkboxState($check['case_sensitive'])?>> />
| string | $str | Usually the value of a GET/POST parameter setting a box |
| string | $extra | Optional. Defaults to empty string. |
Checked attribute or empty string.
getHtmlSelectOptions(array $options, string $selected, boolean $nice_labels = false) : string
Generate a list of <option> html tags from an array and mark one as selected
| array | $options | All the values we want in |
| string | $selected | put selected tag on a specific |
| boolean | $nice_labels | Optional. Defaults to False. Use nice labels for the option. Indicates if $options is an associative array with the array value as the text inside the |
html
getRepoStrings(string $locale, string $repository) : array
Return an array of strings for a locale from a repository
| string | $locale | Locale we want to have strings for |
| string | $repository | string repository such as central, mozilla_org... |
Localized strings or empty array if no match
getRepoEntities(string $locale, string $repository) : array
Return an array of entities for a locale from a repository
| string | $locale | Locale we want to have entities for |
| string | $repository | string repository such as central, mozilla_org... |
Entities or empty array if no match
checkAbnormalStringLength(string $origin, string $translated) : string
Compare original and translated strings to check abnormal length.
This is used in search views to warn of strings that look much wider or much shorter than English
| string | $origin | The source string |
| string | $translated | The string we want to compare to |
'large' or 'small' or false if it doesn't look abnormal
getOrSet(array $arr, string $value, string $fallback) : string
Check if a parameter exists, if not, return fallback value
| array | $arr | Array in which we want to check $value |
| string | $value | Parameter we want to check |
| string | $fallback | Default value |
$value if $value into $arr, $fallback otherwise
logScriptPerformances() : void
Utility function to log to stderr the memory used by a script and the time needed to generate the page.
This is used only when the constants DEBUG and PERF_CHECK are set to True because we don't want to fill our logs with debug data on production.
ago(\DateTime $datetime, \DateTime $ref_time = '') : string
Get the elapsed/remaining time from a DateTime vs. now
| \DateTime | $datetime | The DateTime object to check against current time |
| \DateTime | $ref_time | Reference time to calculate the difference (optional) |
String containing the value concatenated with the pluralized unit
APIPromotion(string $source_locale, string $target_locale) : string
Return the current URL with the json GET variable appended and also adds locale codes if they are not already provided by redirectToAPI()
| string | $source_locale | Locale code for source |
| string | $target_locale | Locale code for target |
URL with 'json' appended as part of the query string