Url Perl Reference Documentation

CkUrl

Current Version: 11.5.0

Chilkat.Url

Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.

Chilkat.Url is a focused URL parsing class. Given a full URL, it extracts the hostname, host type, login, password, path, query string, fragment, port, and SSL/TLS status into easy-to-read properties. It is useful when application code needs to inspect, validate, route, log, or pass URL parts to lower-level networking or API code.

Parse full URLs

Call ParseUrl to break a complete URL into structured properties that can be inspected individually.

Host and host type

Read the hostname and determine whether it is a DNS name, IPv4 address, or IPv6 address.

Path and query

Access the URL path, query string, and combined path-with-query value for request construction or routing.

Login and password

Extract embedded userinfo credentials when a URL contains a login and password component.

Port and TLS status

Determine the explicit or implied port and whether the URL represents an SSL/TLS connection.

Fragment handling

Read the URL fragment separately from the path and query for workflows that need anchor or client-side state information.

Common pattern: Use Url when the application needs to decompose a URL before making a request or applying custom logic. Parse the full URL, read the properties needed by the caller, then pass the relevant pieces to classes such as Chilkat.Http, Chilkat.Rest, or Chilkat.Socket. Use Url for parsing; use the higher-level networking classes to actually send the request.

For an extended overview, see Url Class Overview.

Object Creation

$obj = chilkat::CkUrl->new();

Properties

DebugLogFilePath

# $strVal is a string
# $ckStr is a CkString
$url->get_DebugLogFilePath($ckStr);
$strVal = $url->debugLogFilePath();
$url->put_DebugLogFilePath($strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

Frag

# $strVal is a string
# $ckStr is a CkString
$url->get_Frag($ckStr);
$strVal = $url->frag();

Introduced in version 9.5.0.49

Contains any text following a fragment marker (#) in the URL, excluding the fragment marker. Given the URI http://www.contoso.com/index.htm#main, the fragment is main.

Host

# $strVal is a string
# $ckStr is a CkString
$url->get_Host($ckStr);
$strVal = $url->host();

Introduced in version 9.5.0.49

The DNS host name or IP address part of the URL. For example, if the URL is http://www.contoso.com:8080/, the Host is www.contoso.com. If the URL is https://192.168.1.124/test.html, the Host is 192.168.1.124.

More Information and Examples

Parse a URL into its Component Parts

HostType

# $strVal is a string
# $ckStr is a CkString
$url->get_HostType($ckStr);
$strVal = $url->hostType();

Introduced in version 9.5.0.49

The type of the host name specified in the URL. Possible values are:

dns: The host name is a domain name system (DNS) style host name.
ipv4: The host name is an Internet Protocol (IP) version 4 host address.
ipv6: The host name is an Internet Protocol (IP) version 6 host address.

LastErrorHtml

# $strVal is a string
# $ckStr is a CkString
$url->get_LastErrorHtml($ckStr);
$strVal = $url->lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

# $strVal is a string
# $ckStr is a CkString
$url->get_LastErrorText($ckStr);
$strVal = $url->lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

# $strVal is a string
# $ckStr is a CkString
$url->get_LastErrorXml($ckStr);
$strVal = $url->lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

# $boolVal is a boolean
$boolVal = $url->get_LastMethodSuccess();
$url->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Login

# $strVal is a string
# $ckStr is a CkString
$url->get_Login($ckStr);
$strVal = $url->login();

Introduced in version 9.5.0.49

If the URL contains a login and password, this is the login part. For example, if the URL is http://user:password@www.contoso.com/index.htm , then the login is user.

Password

# $strVal is a string
# $ckStr is a CkString
$url->get_Password($ckStr);
$strVal = $url->password();

Introduced in version 9.5.0.49

If the URL contains a login and password, this is the password part. For example, if the URL is http://user:password@www.contoso.com/index.htm , then the password is password.

Path

# $strVal is a string
# $ckStr is a CkString
$url->get_Path($ckStr);
$strVal = $url->path();

Introduced in version 9.5.0.49

The path (and params) part of the URL, excluding the query and fragment. If the URL is: http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1, then the path is /gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3.

More Information and Examples

Parse a URL into its Component Parts

PathWithQueryParams

# $strVal is a string
# $ckStr is a CkString
$url->get_PathWithQueryParams($ckStr);
$strVal = $url->pathWithQueryParams();

Introduced in version 9.5.0.58

The path (and params) part of the URL, including the query params, but excluding the fragment. If the URL is: http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1, then then this property returns /gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1.

Port

# $intVal is an integer
$intVal = $url->get_Port();

Introduced in version 9.5.0.49

The port number of the URL.

For example, if the URL is http://www.contoso.com:8080/, the port number is 8080.
If the URL is https://192.168.1.124/test.html, the port number is the default 80.
If the URL is https://www.amazon.com/, the port number is the default SSL/TLS port 443.

Query

# $strVal is a string
# $ckStr is a CkString
$url->get_Query($ckStr);
$strVal = $url->query();

Introduced in version 9.5.0.49

The query part of the URL, excluding the fragment. If the URL is: http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1#frag, then the query is pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1.

Ssl

# $boolVal is a boolean
$boolVal = $url->get_Ssl();

Introduced in version 9.5.0.49

1 if the URL indicates SSL/TLS, otherwise false. A URL beginning with https:// indicates SSL/TLS.

Utf8

# $boolVal is a boolean
$boolVal = $url->get_Utf8();
$url->put_Utf8($boolVal);

When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.

More Information and Examples

Strings in Perl: Encoding, UTF-8, and Source File Format Considerations

VerboseLogging

# $boolVal is a boolean
$boolVal = $url->get_VerboseLogging();
$url->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

# $strVal is a string
# $ckStr is a CkString
$url->get_Version($ckStr);
$strVal = $url->version();

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

ParseUrl

# $url is a string
$status = $url->ParseUrl($url);

Introduced in version 9.5.0.49

Parses a full URL. After parsing, the various parts of the URL are available iin the properties.

Returns 1 for success, 0 for failure.

More Information and Examples

Parse a URL into its Component Parts