Show:

String Class

Defined in: platform/plugins/Q/web/js/Q.js:150
Module: Q

Q extended methods for Strings

Methods

decodeHTML

(
  • [convert]
)
String

Defined in platform/plugins/Q/web/js/Q.js:208

Reverses what encodeHTML does

Parameters:

  • [convert] Array optional

    Array of codes to unconvert. Can include '&', '<', '>, '"', ''', "
    ", "
    "

Returns:

String:

encodeHTML

(
  • [convert]
)
String

Defined in platform/plugins/Q/web/js/Q.js:186

Returns a copy of the string with special HTML characters escaped

Parameters:

  • [convert] Array optional

    Array of characters to convert. Can include '&', '<', '>', '"', "'", "\n"

Returns:

String:

hashCode

() Number

Defined in platform/plugins/Q/web/js/Q.js:336

Obtain some unique hash from a string, analogous to Q_Utils::hashCode

Returns:

Number:

interpolate

(
  • fields
)
String

Defined in platform/plugins/Q/web/js/Q.js:231

Interpolates some fields into the string wherever "{{fieldName}}" appears or {{index}} appears.

Parameters:

  • fields Object | Array

    Can be an object with field names and values, or an array corresponding to {{0}}, {{1}}, etc. If the string is missing {{0}} then {{1}} is mapped to the first element of the array.

Returns:

String:

isUrl

() Boolean

Defined in platform/plugins/Q/web/js/Q.js:177

Determins whether the string's contents are an IP address

Returns:

Boolean:

isUrl

() Boolean

Defined in platform/plugins/Q/web/js/Q.js:168

Determins whether the string's contents are a URL

Returns:

Boolean:

parseUrl

(
  • component
)
Object

Defined in platform/plugins/Q/web/js/Q.js:361

Analogous to PHP's parse_url function

Parameters:

  • component String

    Optional name of component to return

Returns:

Object:

queryField

(
  • name
  • [value]
)
String | Object

Defined in platform/plugins/Q/web/js/Q.js:268

Get or set querystring fields from a string, usually from location.search or location.hash

Parameters:

  • name String | Array | Object

    The name of the field. If it's an array, returns an object of {name: value} pairs. If it's an object, then they are added onto the querystring and the result is returned. If it's a string, it's the name of the field to get. And if it's an empty string, then we get the array of field names with no value, e.g. ?123&456&a=b returns [123,456]

  • [value] String optional

    Optional, provide a value to set in the querystring, or null to delete any fields that match name as a RegExp

Returns:

String | Object:

the value of the field in the string, or if value was not undefined, the resulting querystring. Finally, if

replaceAll

() String

Defined in platform/plugins/Q/web/js/Q.js:255

Similar to String.prototype.replace, but replaces globally

Returns:

String:

sameDomain

(
  • url2
  • options
)
Boolean private

Defined in platform/plugins/Q/web/js/Q.js:383

Parameters:

  • url2 String

    The url to compare against

  • options Object

    can include the following:

    • [compareScheme] Boolean optional

      boolean for whether the url scheme should be compared also

Returns:

Boolean:

startsWith

(
  • prefix
)
Boolean

Defined in platform/plugins/Q/web/js/Q.js:403

Parameters:

Returns:

Boolean:

toCapitalized

() String

Defined in platform/plugins/Q/web/js/Q.js:157

Returns a copy of the string with Every Word Capitalized

Returns:

String:

trim

() String

Defined in platform/plugins/Q/web/js/Q.js:353

Returns:

String: