Spider Chilkat2 PHP Reference Documentation
Spider
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Spider
Initialize the spider with a domain and crawl only URLs that belong to
that same domain.
Add starting URLs, crawl the next queued URL, skip selected URLs, and
inspect unspidered, spidered, failed, and outbound URL lists.
Add wildcard avoid patterns, must-match patterns, and outbound-link
avoid patterns to control which URLs are crawled or collected.
Read the last fetched HTML, page title, meta description, meta keywords,
final redirect URL, and last-modified timestamp.
Fetch pages from a Chilkat-managed cache, update the cache, detect when a
page was redirected, and inspect whether the last page came from cache.
Configure user-agent, proxy settings, connect/read timeouts, IPv6
preference, maximum URL length, maximum response size, and abort support.
Crawl a website domain, manage URL queues, filter links, cache pages, and inspect fetched HTML.
Chilkat.Spider crawls pages within a single initialized domain.
It maintains internal lists of unspidered, spidered, failed, and outbound
URLs; fetches one page at a time; extracts same-domain links for continued
crawling; collects outbound links separately; respects robots.txt;
supports wildcard include and avoid patterns; can use a dedicated cache
directory; and exposes the last fetched HTML, title, meta description,
keywords, redirect information, cache status, and last-modified date.
Domain-limited crawling
URL queue management
Filtering rules
Page metadata
Caching and redirects
Network controls
Initialize with the target domain, add one or more starting
URLs with AddUnspidered, optionally add filtering patterns, then
repeatedly call CrawlNext. After each successful crawl, inspect
LastUrl, LastHtml, page metadata, redirect state,
and the URL-list counts to decide whether to continue, skip, recrawl, or
process the page.
Spider is intended for controlled, domain-oriented crawling and
link discovery. Use Chilkat.Http or Chilkat.Rest
when the task is a single HTTP request, API call, form post, or download
rather than a crawl of discovered links.
Object Creation
use Chilkat2\Spider;
try {
$spider = new Spider();
// ... use $spider ...
} 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 Spider(['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($spider), $spider = 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 MySpider extends \Chilkat2\Spider); 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\Spider') 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
AbortCurrent
When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)
AvoidHttps
If set the 1 (true) the spider will avoid all HTTPS URLs. The default is 0 (false).
topCacheDir
Specifies a cache directory to use for spidering. If either of the FetchFromCache or UpdateCache properties are true, this is the location of the cache to be used. Note: the Internet Explorer, Netscape, and FireFox caches are completely separate from the Chilkat Spider cache directory. You should specify a new and empty directory.
ChopAtQuery
If equal to 1 (true), then the query portion of all URLs are automatically removed when adding to the unspidered list. The default value is 0 (false).
topConnectTimeout
The maximum number of seconds to wait while connecting to an HTTP server.
topDebugLogFilePath
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.
Domain
The domain name that is being spidered. This is the domain previously set in the Initialize method.
topFetchFromCache
If equal to 1 (true) then pages are fetched from cache when possible. If 0, the cache is ignored. The default value is 1. Regardless, if no CacheDir is set then the cache is not used.
FinalRedirectUrl
If the last URL crawled was redirected (as indicated by the WasRedirected property), this property will contain the final redirect URL.
topHeartbeatMs
The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.
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.
topLastFromCache
Equal to 1 if the last page spidered was fetched from the cache. Otherwise equal to 0.
topLastHtml
The HTML text of the last paged fetched by the spider.
topLastHtmlDescription
The HTML META description from the last page fetched by the spider.
LastHtmlKeywords
LastHtmlTitle
LastMethodSuccess
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.
LastModDateStr
The last modification date/time (RFC822 format) from the last page fetched by the spider.
topLastUrl
The URL of the last page spidered.
topMaxResponseSize
The maximum HTTP response size allowed. The spider will automatically fail any pages larger than this size. The default value is 250,000 bytes.
MaxUrlLen
The maximum URL length allowed. URLs longer than this are not added to the unspidered list. The default value is 200.
NumAvoidPatterns
The number of avoid patterns previously set by calling AddAvoidPattern.
topNumFailed
The number of URLs in the object's failed URL list.
topNumOutboundLinks
The number of URLs in the object's outbound links URL list.
topNumSpidered
The number of URLs in the object's already-spidered URL list.
topNumUnspidered
PreferIpv6
If true, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is false, which will choose IPv4 over IPv6.
ProxyDomain
The domain name of a proxy host if an HTTP proxy is used.
topProxyLogin
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
topProxyPassword
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
topProxyPort
The port number of a proxy server if an HTTP proxy is used.
topReadTimeout
The maximum number of seconds to wait when reading from an HTTP server.
topUpdateCache
If equal to 1 (true) then pages saved to the cache. If 0, the cache is ignored. The default value is 1. Regardless, if no CacheDir is set then the cache is not used.
UserAgent
The value of the HTTP user-agent header field to be sent with HTTP requests. This can be set to any desired value, but be aware that some websites may reject requests from unknown user agents.
topVerboseLogging
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
WasRedirected
Indicates whether the last URL crawled was redirected. (true = yes, false = no)
WindDownCount
The wind-down phase begins when this number of URLs has been spidered. When in the wind-down phase, no new URLs are added to the unspidered list. The default value is 0 which means that there is NO wind-down phase.
Methods
AddAvoidOutboundLinkPattern
Adds a wildcarded pattern to prevent collecting matching outbound link URLs. For example, if *google* is added, then any outbound links containing the word google will be ignored. The * character matches zero or more of any character.
AddAvoidPattern
Adds a wildcarded pattern to prevent spidering matching URLs. For example, if *register* is added, then any url containing the word register is not spidered. The * character matches zero or more of any character.
AddMustMatchPattern
Adds a wildcarded pattern to limit spidering to only URLs that match the pattern. For example, if */products/* is added, then only URLs containing /products/ are spidered. This is helpful for only spidering a portion of a website. The * character matches zero or more of any character.
AddUnspidered
To begin spidering you must call this method one or more times to provide starting points. It adds a single URL to the object's internal queue of URLs to be spidered.
CanonicalizeUrl
Canonicalizes a URL by doing the following:
- Drops username/password if present.
- Drops fragment if present.
- Converts domain to lowercase.
- Removes port 80 or 443
- Remove default.asp, index.html, index.htm, default.html, index.htm, default.htm, index.php, index.asp, default.php, .cfm, .aspx, ,php3, .pl, .cgi, .txt, .shtml, .phtml
- Remove www. from the domain if present.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
ClearFailedUrls
Clears the object's internal list of URLs that could not be downloaded.
topClearOutboundLinks
Clears the object's internal list of outbound URLs that will automatically accumulate while spidering.
topClearSpideredUrls
Clears the object's internal list of already-spidered URLs that will automatically accumulate while spidering.
topCrawlNext
Crawls the next URL in the internal list of unspidered URLs. The URL is moved from the unspidered list to the spidered list. Any new links within the same domain and not yet spidered are added to the unspidered list. (providing that they do not match avoid patterns, etc.) Any new outbound links are added to the outbound URL list.
If successful, the HTML of the downloaded page is available in the LastHtml property. If there are no more URLs left unspidered, the method returns false. Information about the URL crawled is available in the properties LastUrl, LastFromCache, and LastModDate.
Never throws: false is an answer, not a failure.
FetchRobotsText
Returns the contents of the robots.txt file from the domain being crawled. This spider object will not crawl URLs excluded by robots.txt. If you believe the spider is not behaving correctly, please notify us at support@chilkatsoft.com and provide information detailing a case that allows us to reproduce the problem.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetAvoidPattern
Returns the Nth avoid pattern previously added by calling AddAvoidPattern. Indexing begins at 0.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetBaseDomain
Returns the second-level + top-level domain of the $domain. For example, if $domain is xyz.example.com, this returns example.com. For some domains, such as xyz.example.co.uk, the top 3 levels are returned, such as example.co.uk.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetFailedUrl
Returns the Nth URL in the failed URL list. Indexing begins at 0.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetOutboundLink
Returns the Nth URL in the outbound link URL list. Indexing begins at 0.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetSpideredUrl
Returns the Nth URL in the already-spidered URL list. Indexing begins at 0.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetUnspideredUrl
Returns the Nth URL in the unspidered URL list. Indexing begins at 0.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetUrlDomain
Returns the domain name part of a URL. For example, if the URL is https://www.chilkatsoft.com/test.asp, then www.chilkatsoft.com is returned.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
Initialize
Initializes the object to begin spidering a domain. Calling Initialize clears any patterns added via the AddAvoidOutboundLinkPattern, AddAvoidPattern, and AddMustMatchPattern methods. The domain name passed to this method is what is returned by the Domain property. The spider only crawls URLs within the same domain.
RecrawlLast
Re-crawls the last URL spidered. This helpful when cookies set in a previous page load cause the page to be loaded differently the next time.
Never throws: false is an answer, not a failure.
SkipUnspidered
Moves a URL from the unspidered list to the spidered list. This allows an application to skip a specific URL.
topSleepMs
Suspends the execution of the current thread until the time-out interval elapses.
topEvents
All Chilkat methods are synchronous: the call returns when the work is done. During a long-running call, Spider reports progress to handlers installed with three methods, each taking any PHP callable (a closure, an arrow function, $this->method(...), an invokable object) and returning the object, so the calls chain:
$spider->onPercentDone(function (int $pctDone): bool {
echo "$pctDone%\n";
return false; // return true to abort the method in progress
})
->onProgressInfo(function (string $name, string $value): void {
echo "$name: $value\n";
});
$spider->HeartbeatMs = 250; // the AbortCheck handler is called 4 times per secondEach installs the handler for one event, replacing the one installed before; null removes it. A callable that does not exist is a TypeError right away.
The AbortCheck handler is called at the interval set by the HeartbeatMs property (0, the default, disables it); PercentDone is called when an operation's completion percentage is known; ProgressInfo delivers named progress values. A truthy return from the AbortCheck or PercentDone handler aborts the running method, which then fails in the usual way (Chilkat2\Exception, or false / null with RaiseError off). PHP's set_time_limit() does not interrupt a Chilkat call; an AbortCheck handler is how a script enforces its own limit.
Handlers run during the method call, in the same request. Inside a handler, the object's properties (such as $spider->AbortCurrent = true) and other objects may be used, but calling a method of the same object throws Error. An exception thrown by a handler aborts the running method and propagates from it; the object remains usable. A closure that captures $spider itself makes a reference cycle, which PHP's cycle collector frees.
AbortCheck
public function onAbortCheck(?callable $callback): static
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.
Example
$deadline = microtime(true) + 30; // give up after 30 seconds
$spider->HeartbeatMs = 250; // call the handler 4 times per second
$spider->onAbortCheck(fn(): bool => microtime(true) > $deadline);PercentDone
public function onPercentDone(?callable $callback): static
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.
Example
$spider->onPercentDone(function (int $pctDone): bool {
// $pctDone ranges from 0 to 100.
echo "Percent done: $pctDone\n";
return false; // return true to abort the method in progress
});ProgressInfo
public function onProgressInfo(?callable $callback): static
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
Note: Some Chilkat methods don't fire any ProgressInfo events.
Example
$spider->onProgressInfo(function (string $name, string $value): void {
echo "$name: $value\n";
});