ShowResults class
This class is used to get search results and display them
getTMXResults(array $entities, array $array_strings) : array
Create an array for search results with this format: 'entity' => ['string_locale 1', 'string_locale 2']
| array | $entities | Haystack of entities to search in |
| array | $array_strings | The strings to look into [locale1 strings, locale2 strings] |
Results with entities as keys and translations as values
getSuggestionsResults(array $source_strings, array $target_strings, string $search, integer $max_results = 10) : array
Return an array of suggestions from our Translation Memory API. Unlike other services, we return values from both source and target languages.
| array | $source_strings | Matches from source strings |
| array | $target_strings | Matches from target strings |
| string | $search | The string to search for |
| integer | $max_results | Optional, default to 10, the max number of results we return |
An array of strings
getTranslationMemoryResults(array $strings, string $search, integer $max_results = 200, integer $min_quality) : array
Return an array of search results from our Translation Memory API service with a quality index based on the levenshtein distance.
| array | $strings | The source and target strings to look into |
| string | $search | The string to search for |
| integer | $max_results | Optional, default to 200, the max number of results we return |
| integer | $min_quality | Optional, default to 0, The minimal quality index to filter result |
An array of strings as [source => string, target => string, quality=> Levenshtein index]
getRepositorySearchResults(array $entities, array $array_strings) : array
Return search results in a repository on strings/entities for the API
| array | $entities | An array of all the entities we want to return |
| array | $array_strings | The strings to look into [locale1 strings, locale2 strings] |
An array of strings with the entity as key [entity => [English => French]]
getStringFromEntity(string $entity, array $strings) : string
Returns the string from its entity or false
| string | $entity | Entity we are looking for |
| array | $strings | Haystack of strings to search in |
The string for the entity or false if no matching result
formatEntity(string $entity, boolean $highlight = false) : string
Nicely format entities for tables by splitting them in subpaths and styling them
| string | $entity | |
| boolean | $highlight | Optional. Default to false. Use a highlighting style |
Entity reformated with html markup and css classes for styling
getEditLink(string $tool, string $repo, string $key, string $text, string $locale) : string
Return link to edit a message on external tool used by requested locale
| string | $tool | Tool name |
| string | $repo | Repository |
| string | $key | Key of the current string |
| string | $text | Text of the current strings |
| string | $locale | Current locale |
HTML link to edit the string inside the tool used by this locale
resultsTable(object $search_object, object $search_id, array $search_results, string $page) : string
Html table of search results used by the main view (needs a lot of refactoring)
| object | $search_object | The Search object that contains all the options for the query |
| object | $search_id | Search ID |
| array | $search_results | List of rows |
| string | $page | The page we are generating, used to output results for 2 or 3 locales |
html table to insert in the view
searchEntities(array $source_strings, string $regex) : array
Search entity names: search full entity IDs (including path and filename), then search entity names (without the full path) if there are no results.
| array | $source_strings | Array of source strings |
| string | $regex | Regular expression to search entity names |
List of matching entity names
buildErrorString(string $source_string, string $target_string) : string
Build the error message for target string. Can return a combination of errors, including missing final dot, long string and short string.
| string | $source_string | String from the source locale |
| string | $target_string | String from the target locale |
A concatenated string of errors or an empty string if there is no error.