tinymce.util.URI
This class handles parsing, modification and serialization of URI/URL strings.
Constructors
name | summary | defined by |
---|---|---|
URI() | Constructs a new URI instance. | tinymce.util.URI |
Methods
name | summary | defined by |
---|---|---|
getURI() | Returns the full URI of the internal structure. | tinymce.util.URI |
isDomSafe() | Check to see if a URI is safe to use in the Document Object Model (DOM). This will return true if the URI can be used in the DOM without potentially triggering a security issue. | tinymce.util.URI |
isSameOrigin() | Determine whether the given URI has the same origin as this URI. Based on RFC-6454. Supports default ports for protocols listed in DEFAULT_PORTS. Unsupported protocols will fail safe: they won't match, if the port specifications differ. | tinymce.util.URI |
setPath() | Sets the internal path part of the URI. | tinymce.util.URI |
toAbsPath() | Converts a relative path into a absolute path. | tinymce.util.URI |
toAbsolute() | Converts the specified URI into a absolute URI based on the current URI instance location. | tinymce.util.URI |
toRelPath() | Converts a absolute path into a relative path. | tinymce.util.URI |
toRelative() | Converts the specified URI into a relative URI based on the current URI instance location. | tinymce.util.URI |
Constructors
URI
Constructs a new URI instance.
Parameters
- url (String) - URI string to parse.
- settings (Object) - Optional settings object.
Methods
getURI
Returns the full URI of the internal structure.
Parameters
- noProtoHost (Boolean) - Optional no host and protocol part. Defaults to false.
isDomSafe
Check to see if a URI is safe to use in the Document Object Model (DOM). This will return true if the URI can be used in the DOM without potentially triggering a security issue.
Parameters
- uri (String) - The URI to be validated.
- context (Object) - An optional HTML tag name where the element is being used.
- options (Object) - An optional set of options to use when determining if the URI is safe.
Return value
- Boolean - True if the URI is safe, otherwise false.
isSameOrigin
Determine whether the given URI has the same origin as this URI. Based on RFC-6454. Supports default ports for protocols listed in DEFAULT_PORTS. Unsupported protocols will fail safe: they won't match, if the port specifications differ.
Parameters
- uri (tinymce.util.URI) - Uri instance to compare.
Return value
- Boolean - True if the origins are the same.
setPath
Sets the internal path part of the URI.
Parameters
- path (string) - Path string to set.
toAbsPath
Converts a relative path into a absolute path.
Parameters
- base (String) - Base point to convert the path from.
- path (String) - Relative path to convert into an absolute path.
toAbsolute
Converts the specified URI into a absolute URI based on the current URI instance location.
Examples
// Converts an relative URL to an absolute URL url will be http://www.site.com/dir/somedir/somefile.htm
var url = new tinymce.util.URI('http://www.site.com/dir/').toAbsolute('somedir/somefile.htm');
Parameters
- uri (String) - URI to convert into a relative path/URI.
- noHost (Boolean) - No host and protocol prefix.
Return value
- String - Absolute URI from the point specified in the current URI instance.
toRelPath
Converts a absolute path into a relative path.
Parameters
- base (String) - Base point to convert the path from.
- path (String) - Absolute path to convert into a relative path.
toRelative
Converts the specified URI into a relative URI based on the current URI instance location.
Examples
// Converts an absolute URL to an relative URL url will be somedir/somefile.htm
var url = new tinymce.util.URI('http://www.site.com/dir/').toRelative('http://www.site.com/dir/somedir/somefile.htm');
Parameters
- uri (String) - URI to convert into a relative path/URI.
Return value
- String - Relative URI from the point specified in the current URI instance.
Can't find what you're looking for? Let us know.
Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.