WoW:USERAPI substr - Revision history

Move page script: Move page script moved page USERAPI substr to WoW:USERAPI substr without leaving a redirect

2023-08-15T04:49:14Z

Move page script moved page USERAPI substr to USERAPI substr without leaving a redirect

← Older revision	Revision as of 04:49, 15 August 2023
(No difference)

WoWWiki>Charibot: catfix

2008-07-09T00:44:15Z

catfix

← Older revision		Revision as of 00:44, 9 July 2008
Line 63:		Line 63:

	__NOTOC__		__NOTOC__
	[[Category:User ~~Defined Functions~~]]		[[Category:User defined functions]]

WoWWiki>Pcj at 16:37, 4 December 2007

2007-12-04T16:37:19Z

← Older revision		Revision as of 16:37, 4 December 2007
Line 1:		Line 1:
	{{userfunc}} <!-- Leave this line in! -->		{{userfunc}} <!-- Leave this line in! -->
	~~<center>'''substr''' ''- by [[user:egingell\|egingell]] -''</center>~~

	Imp [[API_strsub\|strsub]]. Returns a string starting from ''start'' to ''length'' characters from ''start'' (identical to the [http://php.net/substr PHP function] of the same name).		Imp [[API_strsub\|strsub]]. Returns a string starting from ''start'' to ''length'' characters from ''start'' (identical to the [http://php.net/substr PHP function] of the same name).

WoWWiki>Egingell: New page: {{userfunc}} '''substr''' ''- by egingell -'' Imp strsub. Returns a string starting from ''start'' to ''leng...

2007-09-30T12:58:28Z

New page: {{userfunc}}  <center>'''substr''' ''- by egingell -''</center> Imp strsub. Returns a string starting from ''start'' to ''leng...

New page

{{userfunc}} 
<center>'''substr''' ''- by [[user:egingell|egingell]] -''</center>

Imp [[API_strsub|strsub]]. Returns a string starting from ''start'' to ''length'' characters from ''start'' (identical to the [http://php.net/substr PHP function] of the same name).

string = ''<PREFIX>''_substr(string, start [, length])

== Function Parameters ==
=== Arguments ===

:;string : String - The subject string.
:;start : Integer - Start here. 0 and 1 have the same effect. Negative values are acceptable.
:;length : Integer - Go this many characters and stop. Negative values are acceptable.
=== Returns ===

:;string: The desired piece of the string. If the resulting string is less than 0 characters long (which can only exist in the Twilight Zone), ''false'' is returned.

== Examples ==
string = ''<PREFIX>''_substr("World of Warcraft", 2, 4)
string = ''<PREFIX>''_substr("World of Warcraft", -2, -4)
string = ''<PREFIX>''_substr("World of Warcraft", -2, 4)
string = ''<PREFIX>''_substr("World of Warcraft", -2, -1)
string = ''<PREFIX>''_substr("World of Warcraft", 4, -1)

====Results====
"orld"
false -- error condition: the resulting string is negative in length and, therefore, cannot exist.
"ft"
"f"
"ld of Warcraf"

==Code==

<pre>
function <PREFIX>_substr(string, start, length)
if not string then
return ''
end
-- Sanity checks: make sure integers are integers.
start = floor(tonumber(start)) or 1
if length == nil then
length = strlen(string)
end
if length < 0 and start < 0 and abs(length) > abs(start) then
return false
end
if start < 0 then
start = strlen(string) + (start + 1)
end
length = floor(tonumber(length))
local String = ''
if length >= 0 then
String = strsub(string, start, (start - 1) + length)
else
String = string
String = strsub(String, start)
String = strsub(String, 1, strlen(String) + length)
end
return String
end
</pre>

__NOTOC__
[[Category:User Defined Functions]]