Description Usage Arguments Format Details Inherit Methods Private fields See Also
This class allows you to preprocess the data of an instance to find the slangs that are in it. Optionally, you can decide whether to delete the data slangs or not.
1 2 3 4 |
propertyName |
(character) Name of the property associated with the pipe. |
propertyLanguageName |
(character) Name of the language property. |
alwaysBeforeDeps |
(list) The dependences alwaysBefore (pipes that must be executed before this one). |
notAfterDeps |
(list) The dependences notAfter (pipes that cannot be executed after this one). |
An object of class R6ClassGenerator
of length 24.
This class needs files in json format that will contain the slangs to be located and the string that will replace them. For this it is necessary that the instance contains a property that indicates the language of the data to be able to correctly choose the list of slangs that apply to the data. The format of the file names of the resources has to be: slang.xxx.json (Being xxx the value of the language property of the instance).
To indicate the path where the associated resources are located, the configuration file is used. It is necessary to indicate in the section called resourcesPath, the path of resourcesSlangsPath.
The pipe will invalidate the instance in the moment that the resulting data is empty.
This class inherits from PipeGeneric
and implements the
pipe
abstract function.
pipe Function that preprocesses the instance to obtain/replace the slangs. The slangs found in the pipe are added to the list of properties of the Instance. If the replaceSlangs parameter is TRUE, the instance data will be modified by replacing the slangs found.
Usage
pipe(instance, replaceSlangs = TRUE)
Value
The instance with the modifications that have occurred in the pipe.
Arguments
instance (Instance) Instance to preproccess.
replaceSlangs (logical) Indicate if the slangs are replace or not.
findSlang Function that checks if the slang is in the data.
Usage
findSlang(data, slang)
Value
TRUE or FALSE depending on whether the slang is on the data.
Arguments
data (character) Text in which the slang is searched.
slang (character) Indicates the slang to find.
replaceSlang Function that replaces the slang in the data for the extendedSlang.
Usage
replaceSlang(slang, extendedSlang, data)
Value
The data with slangs replaced.
Arguments
slang (character) Indicates the slang to replace.
extendedSlang (character) Indicates the string to replace for the slangs found.
data (character) Text in which slangs will be replaced.
getPropertyLanguageName Getter of name of property language.
Usage
getPropertyLanguageName()
Value
Value of name of property language.
getResourcesSlangsPath Getter of path of slangs resources.
Usage
getResourcesSlangsPath()
Value
Value of path of slangs resources.
propertyLanguageName (character) The name of property about language.
resourcesSlangsPath (character) The path where are the resources.
PipeGeneric
, Instance
,
ResourceHandler
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.