Url Chilkat2 PHP Reference Documentation
Url
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Url
Call
Read the hostname and determine whether it is a DNS name, IPv4 address,
or IPv6 address.
Access the URL path, query string, and combined path-with-query value for
request construction or routing.
Extract embedded userinfo credentials when a URL contains a login and
password component.
Determine the explicit or implied port and whether the URL represents an
SSL/TLS connection.
Read the URL fragment separately from the path and query for workflows
that need anchor or client-side state information.
For an extended overview, see
Url Class Overview.
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
ParseUrl to break a complete URL into structured
properties that can be inspected individually.
Host and host type
Path and query
Login and password
Port and TLS status
Fragment handling
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.
Object Creation
use Chilkat2\Url;
try {
$url = new Url();
// ... use $url ...
} catch (\Chilkat2\Exception $e) {
echo $e->getClass(), '::', $e->getMethod(), " failed\n";
echo $e->getMessage(), "\n"; // the LastErrorText of the failed call
}Creates the object. The optional array sets properties in order, as if assigned one by one (new Url(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.
There is no close(): PHP frees the object when its last reference goes (unset($url), $url = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyUrl extends \Chilkat2\Url); objects cannot be cloned or serialized.
When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.
Errors
Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\Url') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.
Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.
Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.
Properties
DebugLogFilePath
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.
Frag
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
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.
HostType
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
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.
topLastErrorText
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.
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.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: true means success, false 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
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
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
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.
PathWithQueryParams
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
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
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.
Scheme
The scheme part of the URL. For example, if the URL is https://www.contoso.com:8080/, the Scheme is https.
Ssl
true if the URL indicates SSL/TLS, otherwise false. A URL beginning with https:// indicates SSL/TLS.
VerboseLogging
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
ParseUrl
Parses a full URL. After parsing, the various parts of the URL are available iin the properties.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.