actions_tm_get_strings Class Reference

Handler for the tm_get_strings action which provides a REST API to retrieve translations from the translation memory that match a set of strings. More...

Public Member Functions
	handle ($params)
	out ($params)

---

Detailed Description

Handler for the tm_get_strings action which provides a REST API to retrieve translations from the translation memory that match a set of strings.

Request Parameters

Name	Description
--source	The 2-digit ISO code of the source language.
--dest	The 2-digit ISO code of the destination language.
--strings	An array of strings that we wish to retrieve translations for.

Response Structure

This action will return mimetype text/json with a JSON object of the following structure:

 {
   code:  <int>,       // The response code.  200 for success.
   message: <string>,  // The response message.  Error or success.
   strings: <object>, // Object where the keys are the source strings, and the values
                       // are the corresponding translations.  Null if the translation 
                       // was not found.
 }

Permissions

This action requires that the user has the tm:get strings permission.

Definition at line 56 of file tm_get_strings.php.

---

Member Function Documentation

handle

(

$

params

)

Definition at line 58 of file tm_get_strings.php.

out

(

$

params

)

Definition at line 123 of file tm_get_strings.php.

---

The documentation for this class was generated from the following file:

• /Applications/XAMPP/xamppfiles/htdocs/recipedb/modules/tm/actions/tm_get_strings.php