PregReplace: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
{{New feature/item|4.014|1.4|5106|
{{New feature/item|4.014|1.4|5106|
This function replace all matches and return replaced string.
This function performs a regular expression search and replace on an input string and returns the replaced string.
}}
}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string pregReplace ( string base, string pattern, string replace )
string pregReplace ( string subject, string pattern, string replacement )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''base:''' The base [[string]] for replace.
*'''subject:''' The input [[string]].
*'''pattern:''' The pattern for replace in base string.
*'''pattern:''' The pattern [[string]] to search for in the input [[string]].
*'''replace:''' The [[string]] for replace.
*'''replacement:''' The replacement [[string]] to replace all matches within the input [[string]].


===Returns===
===Returns===
Returns an replaced ''[[string]]'', ''false'' otherwise.
Returns the replaced ''[[string]]'', or [[bool]] ''false'' otherwise.


==Example==  
==Example==  
Line 24: Line 24:
addCommandHandler( 'examples',
addCommandHandler( 'examples',
function( )
function( )
                 -- Replace doh to done
                 -- Replace doh with done
outputDebugString( pregReplace( 'I doh this, guys.', 'doh', 'done' ) or 'not replaced' ) -- I done this, guys
outputDebugString( pregReplace( 'I doh this, guys.', 'doh', 'done' ) or 'not replaced' ) -- Result: I done this, guys
                 -- Replace all A-Z symbols to none string
                 -- Remove all uppercase alphabetic characters
                 outputDebugString( pregReplace( 'AaaBbbZzz', '[A-Z]{1,}', '' ) or 'not replaced' ) -- aabbzz
                 outputDebugString( pregReplace( 'AaaBbbZzz', '[A-Z]{1,}', '' ) or 'not replaced' ) -- Result: aabbzz
end
end
)
)

Revision as of 11:04, 6 June 2013

ADDED/UPDATED IN VERSION 1.4 r5106:

This function performs a regular expression search and replace on an input string and returns the replaced string.

Syntax

string pregReplace ( string subject, string pattern, string replacement )

Required Arguments

  • subject: The input string.
  • pattern: The pattern string to search for in the input string.
  • replacement: The replacement string to replace all matches within the input string.

Returns

Returns the replaced string, or bool false otherwise.

Example

Click to collapse [-]
Shared ( client and server )

Some examples: 

addCommandHandler( 'examples',
	function( )
                -- Replace doh with done
		outputDebugString( pregReplace( 'I doh this, guys.', 'doh', 'done' ) or 'not replaced' ) -- Result: I done this, guys
                -- Remove all uppercase alphabetic characters
                outputDebugString( pregReplace( 'AaaBbbZzz', '[A-Z]{1,}', '' ) or 'not replaced' ) -- Result: aabbzz
	end
)

Requirements

Minimum server version 1.4-9.05106
Minimum client version 1.4-9.05106

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.4-9.05106" client="1.4-9.05106" />

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/PregReplace?oldid=36355"