Differences

This shows you the differences between two versions of the page.

--- functions:character_string_functions [2022/02/20 20:10] – benjamin
+++ functions:character_string_functions [2022/02/20 20:55] (current) – benjamin
@@ Line 4: / Line 4: @@
 There are 3 groups of functions :\\
-  -[[functions:character_string_functions|Character String Functions]]
+  -**Character string functions**
-  -[[functions:mathematics_functions|Mathematic functions]]
+  -[[functions:mathematics_functions|Mathematics functions]]
-  -**Other functions**
+  -[[functions:other_functions|Other functions]]
 ------
-====== Other Functions ======
+===== Character string functions =====
-===== $exists =====
+  * ALL string inputs containing alphabetic characters (a-z, A-Z) must be encapsulated with single or double quotes.\\
+  * If numeric character(s) (0-9) are used in functions that accept strings then the number will be treated as a string.\\
+  *All functions can be nested ([[character_string_functions#Nested functions|functions within functions]]).\\
-  * This is a file function that will tell if file(s) exists. Returns the amount of files found and and 0 if it there is no match. Support recursing and returning a file list in array.
+    Usage description : $function(input-1 = "string", input-2 = integer[, optional input-3 = "string"/integer])
-Usage:\\
+  * Escaping Doublequotes: If you need to provide a doublequote within your string, you need to escape them by just providing two doublequotes instead of one. Example:
-$exists(input string = "string/%variable%")
+    * your string is: [this is my "string"]
+    * in a function, you need to use it this way:  ["this is my ""string"""]
+    * as you see, the string was wrapped into double quotes, just as any string inside functions. Additionally the real doublequotes in the string just have been doubled.
-$exists("C:\Windows\explorer.exe")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  1
+*** If you want to read and store an entire text file (xml, txt, etc), see [[other_functions#$read|"$read" function]].**
+===== $left vs $triml =====
-$exists("C:\Windows\system32\win*")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  98
+  *$left  : Get string n-characters from the left side.
+  *$triml : Trim string n-characters from the left side.
-%%$exists("\\NAS\MOVIES\ORIGINAL\FILM1.MXF",1 ,1)%%  {{:functions:FFAStrans_compute.jpg?nolink&50|}} %%\\NAS\MOVIES\ORIGINAL\FILM1.MXF%% \\
+Usages:\\
-(First ",1" tell the function to output ONE file, which is the first match it can find. Second ",1" tells the function to look into subfolders.)
+$left(input string = "string/%variable%", number of characters to extract = integer/%i_variable%)\\
+$triml(input string = "string/%variable%", number of characters to trim = integer/%i_variable%)
-%%$exists("\\NAS\MOVIES\ORIGINAL\FILM*.MXF",2 ,1)%%  {{:functions:FFAStrans_compute.jpg?nolink&50|}} ["\\NAS\\MOVIES\\ORIGINAL\\FILM1.MXF","\\NAS\\MOVIES\\ORIGINAL\\FILM2.MXF","\\NAS\\MOVIES\\ORIGINAL\\FILM3.MXF"]\\
-",2" tells the function to return an array (list) of matches.\\
-",3" tells the function to return a basic string list of files separated with an <enter>.
------------------------------
+{{:functions:left-triml.jpg?nolink&800|}}
-===== $base64 =====
+------
-  * Encodes the input UTF-8 string as terminated base64 string.
+===== $right vs $trimr =====
-Usage:\\
+  *$right : Get string n-characters from the right side.
+  *$trimr : Trim string n-characters from the right side.
-$base64(input string ="string/%variable%")
+Usages:\\
+$right(input string = "string/%variable%", number of characters to extract = integer/%i_variable%)\\
+$trimr(input string = "string/%variable%", number of characters to trim = integer/%i_variable%)
-$base64("FFAStrans")= {{:functions:FFAStrans_compute.jpg?nolink&50|}} RkZBU3RyYW5z
+{{:functions:right-trimr.jpg?nolink&800 |}}
+------
+===== $middle vs $between =====
+  *$middle : Get string n-characters from n-position.
+  *$between: Get string between two strings.
--------
+Usages:\\
-===== $base64dec =====
+$middle(input string = "string/%variable%", start position = integer/%i_variable%, number of characters to extract from start position = integer/%i_variable%)\\
+$between(input string = "string/%variable%", from string = "string/%variable%", to string = "string/%variable%"[, instance found= integer/%i_variable%])\\
-  * Decodes the input base 64 encoded string to a UTF-8 string.
+{{:functions:middle-between.jpg?nolink&800|}}
+------
-Usage :\\
+===== $upper vs $lower and $proper =====
-$base64dec(input string ="string/%variable%")
-$base64dec("RkZBU3RyYW5z")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  FFAStrans
+  *$upper : Force string to upper case.
+  *$lower : Force string to lower case.
+  *$proper: Capitalizes every first letter following a non-alphanumeric character.
----------------------------
-===== $jsonencode, $jsonget and $jsonput=====
-  * $jsonencode : Converts the input string to an JSON friendly string.
-<note> That this does not produce any JSON data structure but one can use the result as a "Value" in a JSON data structure.
-This can be used in order to produce a JSON string for further automatic processing, e.g. send a POST request to some 3rdparty API using the HTTP Request processor. Or to write a JSON File using the Write File processor.</note>
-  * $jsonget : Retrieves the value from a JSON object key. The first argumenst accept a string or a variable representing a valid JSON string. In the second section you refer to the object/key/array you want to get.
-  * $jsonput : Puts a value to a JSON object. The first arguments accept a string or a variable representing a valid JSON string. If and empty string is used FFAStrans will create a new json object. The second argument refer to the object/key/array you want put the value. Third argument is the value to put in the json object. Note that this parameter will return the new updated or created json string object.
-**Understanding FFAStrans JSON functions** : \\
-{{:functions:jsonput_variable.png?nolink&700|}}\\
-\\
-{{:functions:json_variable2.png?nolink&700|}}\\
 Usages:\\
-$jsonencode(input string = "string/%variable%")\\
+$upper(input string = "string/%variable%")\\
-$jsonget(input string = "string/%variable%"[, input string = "string/%variable%"])\\
+$lower(input string = "string/%variable%")\\
-$jsonput(input string ="string/%variable%", input string = "string/%variable%", input string = "string/%variable%")\\
+$proper(input string = "string/%variable%")\\
-$jsonencode("D:\My\Media\folder")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  D:\\My\\Media\\folder
+{{:functions:lower-upper-proper.jpg?nolink&800|}}
+-----
+===== $replace and $alrep =====
-$jsonencode('Hello "World"')  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  Hello \"World\"
+  *$replace : Replace string in string. If "type" is set to 1 then the string to replace are split into characters.
+  *$alrep   : Replace all non-alphanumeric characters and add optional exceptions.
-$jsonget('{"things":{"myStuff":"some other stuff"}}', "things.myStuff")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  some other stuff
+Usage:\\
+$replace(input string = "string/%variable%", string to replace = "string/%variable%" [, replace with string = "string/%variable%", type = 0])\\
+$alrep(input string = "string/%variable%"[, replace with string = "string/%variable%"][, except characters = "string/%variable%"])\\
-==== jsonget Usage Example to retrieve values from ffprobe: ====
-$jsonget('%s_info_ffprobe%', 'streams[1].format_name')  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
- mov,mp4,m4a,3gp,3g2,mj2
-You can use online tools to generate the selection string (streams[1].format_name) like this:
+{{:functions:replace.jpg?nolink&800|}}
-http://jsonpathfinder.com/
-Best Practice is to use a Write File Processor and write %s_info_ffprobe% to a file. This gives you the full JSON structure of your file. You can use the resulting JSON in above mentioned online tools.
+{{:functions:alrep.jpg?nolink&800|}}
+-----
+===== $regreplace =====
-------------------------
+    *$regreplace : Replace string in string by regex pattern.
-===== $readarray =====
-  * Returns an instance from a valid array which must be in the form of "["data", data, etc...]". All JSON formated data is valid. By default the function will return the first instance. If none is found it will return an empty string: "".
-This can be used in combination with another processor which generates JSON on output, for example loudness filter or in combination again with a HTTP Get processor that receives JSON data from a 3rdparty API.
 Usage:\\
-$readarray(input string = "string/%variable%"[, input integer = integer/%variable%])
+$regreplace(input string ="string/%variable%", string to replace ="string/%variable%" [, replace with string ="string/%variable%")
-$readarray("[23, 55.5, 19]", 2)  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  55.5
+{{:functions:regreplace.png?nolink&800|}}
+-------------
+===== $leads vs $trails =====
-$readarray('["make", "my", "day"]', 3)  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  day
+  *$leads  : Add leading character(s) to a string. If string to fill is omitted a zero (0) will be used.
+  *$trails : Add trailing character(s) to a string. If fill-string is omitted a zero (0) will be used.
-------------------------
+Usage:\\
-===== $regext =====
+$leads(input string = "string/%variable%", total number of output characters = integer/%i_variable%[, string to fill = "string/%variable%"])\\
+$trails(input string = "string/%variable%", total number of output characters = integer/%i_variable% [, string to fill = "string/%variable%"])\\
-  * This is regular expression function. It extracts text based on recognition patterns. It uses the Perl Compatible Regular Expressions (PCRE) engine. http://www.pcre.org/
+{{:functions:leads-trails.jpg?nolink&800|}}
+--------
-Usage :\\
+===== $stripws and $stripcrlf =====
-$regext(input string = "string/%variable%", pattern = "string/%variable%")
-$regext("<Duration value="1214"/>", "<Duration value="(\d+)"/>")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  1214
+  *$stripws   : Removes leading and trailing white spaces.
+  *$stripcrlf : Removes carriage returns and line feeds from string.
-$regext("TVShow_EP0013.mxf", "/(EP\d{4})/")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  EP0013\\
+Usage:\\
+$stripws(input string = "string/%variable%")\\
+$stripcrlf(input string = "string/%variable%")\\
-----------------------
+{{:functions:stripws-stripcrif.jpg?nolink&800|}}
+------
-===== $hex and $dec =====
+===== $isdigit and $isalpha =====
-    * $hex : Converts a decimal integer to hexadecimal number.
+  *$isdigit   : Check if string is only numbers. Success returns 1, failure returns 0.
-    * $dec : Converts a hexadecimal number to decimal integer. Function accepts both quoted and unquoted input.
+  *$isalpha   : Check if string is only alphabetic letters. Success returns 1, failure returns 0.
-Usages : \\
-$hex(input integer = integer/%variable%)\\
-$dec(input string/integer = "string"/integer/%variable%)
+Usage:\\
+$isdigit(input string = "string/%variable%")\\
+$isalpha(input string = "string/%variable%")\\
-$hex(8)  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  8 <html>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</html>
+{{:functions:isdigit-isalpha.jpg?nolink&800|}}
-$hex(15)  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  f
+-------
-$dec(8) {{:functions:FFAStrans_compute.jpg?nolink&50|}}  8
+===== $length and $reverse =====
-<html>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</html>
-$dec("f")   {{:functions:FFAStrans_compute.jpg?nolink&50|}}  15
---------------------------
+  *$length   : List the number of characters.
+  *$reverse   : Reverse a string.
-===== $guid =====
+Usage:\\
+$length(input string = "string/%variable%")\\
-  * Returns a random GUID/UUID.
+$reverse(input string = "string/%variable%")\\
-Usage : \\
-$guid()
-$guid()  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  bc067580-f7de-4e12-9f84-7e905bd60378
---------------------------
-===== $xxhash =====
-    * Returns an eight character hash for any file. Must include full path. The hash is created using Yann Collet's xxHash which is very fast and suits large video files.
-Usage : \\
-$xxhash(input string = "string/%variable%")
-$xxhash("x:\path\to\file.mxf")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}  61abf926
--------------------------------------------
-===== $read =====
-  * Reads the contents of any file. Function supports all kinds of files, not just text based.
-Usage : \\
-$read(input string = "string/%variable%")
-$read("metadata.xml")  {{:functions:read_visual.png?nolink&180|}}
------------------------------
-===== $urlencode =====
-  * Converts the input string to an URL friendly string.
-Usage : \\
-$urlencode(input string = "string/%variable%")
-$urlencode("FFAStrans is #supercool!")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
- FFAStrans%20is%20%23supercool!
------------------------------
-===== $week =====
-  * Returns the week number from the date specified in the parameters. If no date is specified, the function returns the current week number.
-Usage : \\
-$week([input number=YEAR/"%variable%", input number=MONTH/"%variable%", input number=MONTH DAY/"%variable%"])
-$week(2020, 10, 15) {{:functions:FFAStrans_compute.jpg?nolink&50|}}
-<note>
-A week goes from Monday to Sunday.
-</note>
------------------------------
-===== $weekday =====
-  * Returns the week day number from the date specified in the parameters. If no date is specified, the function returns the current week day number.
-Usage : \\
-$weekday([input number=YEAR/"%variable%", input number=MONTH/"%variable%", input number=MONTH DAY/"%variable%"])
-$weekday(2020, 10, 15) {{:functions:FFAStrans_compute.jpg?nolink&50|}}
-<note>
-The number 1 is Sunday. Monday is 2, Tuesday is 3, etc.
-</note>
--------------------------------
-===== $lookup =====
-  * Loopup table for mapping data to other data. The function will only operate on array formated strings.
-Usage : \\
-$lookup(input array ="REFERENCE/%variable%", inputarray ="TABLE/%variable%", input string ="SEARCH/%variable%")
-$lookup('["joe", "bill", "greg"]', '["lucy", "evy", "jane"]', "evy")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
-bill
------------------------------
-===== $lookuprep =====
-  * Loopup table for replacing strings with strings from lookup tables.
-Usage : \\
-$lookuprep(input array ="REFERENCE/%variable%", input array ="TABLE/%variable%", input string ="SEARCH/%variable%")
-$lookuprep('["joe", "bill", "greg"]', '["lucy", "evy", "jane"]', "lucylindajane")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
-joelindagreg
------------------------------
-===== $sort =====
-  * Sorts an array formated string or a regular string. String sorting use crlf as base separator but a custom separator can be specified.
-Usage : \\
-$sort(input string/array ="string/%variable%"[, input string ="SEPARATOR/%variable%"])
-$sort("[6,2,4,3,5]")  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
-[2,3,4,5,6]
-$sort('["jack", "joe", "jill", "jane", "james", "jules"]') {{:functions:FFAStrans_compute.jpg?nolink&50|}}
-["jack", "james", "jane", "jill", "joe", "jules"]
------------------------------
-===== $count =====
-  * Counts the occurrences of any string in a string.
-Usage : \\
-$count(input string ="string/%variable%", input string ="SEARCH/%variable%")
-$count('jack, joe, jill, jane, james, jules', 'ja')  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
------------------------------
-===== $foreach =====
-  * This function will iterate and perform the desired operation on each data value. The result of each iteration will be put back into the array and presented as the new resulting array. Please note that the special keyword "%$%" represents unique data value of each iteration. The special keyword "%i%" represents each iteration number.
-Usage : \\
-$foreach(input string ="string/%variable%", input string ="OPERATION/%variable%")
-$foreach('["jack", "joe", "jill", "jane", "james", "jules"]', '$triml("%$%", 2)')  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
-["ck", "e", "ll", "ne", "mes", "les"]
+{{:functions:length-reverse.jpg?nolink&800}}
+-------
-$foreach('["jack", "joe", "jill", "jane", "james", "jules"]', '%i% - %$%')  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
+===== Nested Functions =====
-["1 - jack", "2 - joe", "3 - jill", "4 - jane", "5 - james", "6 - jules"]
+ All functions can be nested (functions within functions).
-$foreach('[10, 11, 12, 10, 20, -6]', '%$%-%i%')  {{:functions:FFAStrans_compute.jpg?nolink&50|}}
+__Example 1__:
-[9, 9, 9, 6, 15, -12]
+$replace($left("my strings", 6), "my", "your") {{:functions:FFAStrans_compute.jpg?nolink&50|}} your str
+__Example 2__:
+$upper($triml($trimr("function number 131 is useful", 10), 9)) {{:functions:FFAStrans_compute.jpg?nolink&50|}} NUMBER 131
------------------------------
+------------------------------------------
-<html>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</html>[[functions:other_functions|Back to top]]
+<html>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</html>[[functions:character_string_functions|Back to top]]