CkSpider PHP Extension Reference Documentation

CkSpider

Current Version: 9.5.0.73

Chilkat Spider web crawler component.

Object Creation

$obj = new CkSpider();

Properties

AbortCurrent
bool get_AbortCurrent()
void put_AbortCurrent(bool boolVal);
Introduced in version 9.5.0.58

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.)

top
AvoidHttps
bool get_AvoidHttps()
void put_AvoidHttps(bool boolVal);

If set the 1 (true) the spider will avoid all HTTPS URLs. The default is 0 (false).

top
CacheDir
string cacheDir();
void put_CacheDir(string strVal);

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.

More Information and Examples
top
ChopAtQuery
bool get_ChopAtQuery()
void put_ChopAtQuery(bool boolVal);

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).

top
ConnectTimeout
int get_ConnectTimeout()
void put_ConnectTimeout(int intVal);

The maximum number of seconds to wait while connecting to an HTTP server.

top
DebugLogFilePath
string debugLogFilePath();
void put_DebugLogFilePath(string strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
Domain
(read-only)
string domain();

The domain name that is being spidered. This is the domain previously set in the Initialize method.

top
FetchFromCache
bool get_FetchFromCache()
void put_FetchFromCache(bool boolVal);

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.

More Information and Examples
top
LastErrorHtml
(read-only)
string lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
(read-only)
string lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
(read-only)
string lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastFromCache
(read-only)
bool get_LastFromCache()

Equal to 1 if the last page spidered was fetched from the cache. Otherwise equal to 0.

top
LastHtml
(read-only)
string lastHtml();

The HTML text of the last paged fetched by the spider.

top
LastHtmlDescription
(read-only)
string lastHtmlDescription();

The HTML META description from the last page fetched by the spider.

More Information and Examples
top
LastHtmlKeywords
(read-only)
string lastHtmlKeywords();

The HTML META keywords from the last page fetched by the spider.

More Information and Examples
top
LastHtmlTitle
(read-only)
string lastHtmlTitle();

The HTML title from the last page fetched by the spider.

More Information and Examples
top
LastMethodSuccess
bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastModDateStr
(read-only)
string lastModDateStr();

The last modification date/time from the last page fetched by the spider.

top
LastUrl
(read-only)
string lastUrl();

The URL of the last page spidered.

top
MaxResponseSize
int get_MaxResponseSize()
void put_MaxResponseSize(int intVal);

The maximum HTTP response size allowed. The spider will automatically fail any pages larger than this size. The default value is 250,000 bytes.

More Information and Examples
top
MaxUrlLen
int get_MaxUrlLen()
void put_MaxUrlLen(int intVal);

The maximum URL length allowed. URLs longer than this are not added to the unspidered list. The default value is 200.

More Information and Examples
top
NumAvoidPatterns
(read-only)
int get_NumAvoidPatterns()

The number of avoid patterns previously set by calling AddAvoidPattern.

top
NumFailed
(read-only)
int get_NumFailed()

The number of URLs in the component's failed URL list.

top
NumOutboundLinks
(read-only)
int get_NumOutboundLinks()

The number of URLs in the component's outbound links URL list.

top
NumSpidered
(read-only)
int get_NumSpidered()

The number of URLs in the component's already-spidered URL list.

top
NumUnspidered
(read-only)
int get_NumUnspidered()

The number of URLs in the component's unspidered URL list.

More Information and Examples
top
PreferIpv6
bool get_PreferIpv6()
void put_PreferIpv6(bool boolVal);

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.

top
ProxyDomain
string proxyDomain();
void put_ProxyDomain(string strVal);

The domain name of a proxy host if an HTTP proxy is used.

top
ProxyLogin
string proxyLogin();
void put_ProxyLogin(string strVal);

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

top
ProxyPassword
string proxyPassword();
void put_ProxyPassword(string strVal);

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

top
ProxyPort
int get_ProxyPort()
void put_ProxyPort(int intVal);

The port number of a proxy server if an HTTP proxy is used.

top
ReadTimeout
int get_ReadTimeout()
void put_ReadTimeout(int intVal);

The maximum number of seconds to wait when reading from an HTTP server.

top
UpdateCache
bool get_UpdateCache()
void put_UpdateCache(bool boolVal);

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.

More Information and Examples
top
UserAgent
string userAgent();
void put_UserAgent(string strVal);

The value of the HTTP user-agent header field to be sent with HTTP requests. The default value is "Chilkat/1.0.0 (+http://www.chilkatsoft.com/ChilkatHttpUA.asp)"

top
Utf8
bool get_Utf8()
void put_Utf8(bool boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

top
VerboseLogging
bool get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

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.

top
Version
(read-only)
string version();

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

top
WindDownCount
int get_WindDownCount()
void put_WindDownCount(int intVal);

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.

top

Methods

AddAvoidOutboundLinkPattern
void AddAvoidOutboundLinkPattern(string pattern);

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.

More Information and Examples
top
AddAvoidPattern
void AddAvoidPattern(string pattern);

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.

More Information and Examples
top
AddMustMatchPattern
void AddMustMatchPattern(string pattern);

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.

More Information and Examples
top
AddUnspidered
void AddUnspidered(string url);

To begin spidering you must call this method one or more times to provide starting points. It adds a single URL to the component's internal queue of URLs to be spidered.

More Information and Examples
top
CanonicalizeUrl
bool CanonicalizeUrl(string url, CkString outStr);
string canonicalizeUrl(string url);

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.

Returns true for success, false for failure.

More Information and Examples
top
ClearFailedUrls
void ClearFailedUrls();

Clears the component's internal list of URLs that could not be downloaded.

top
ClearOutboundLinks
void ClearOutboundLinks();

Clears the component's internal list of outbound URLs that will automatically accumulate while spidering.

top
ClearSpideredUrls
void ClearSpideredUrls();

Clears the component's internal list of already-spidered URLs that will automatically accumulate while spidering.

top
CrawlNext
bool CrawlNext();

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.

More Information and Examples
top
CrawlNextAsync (1)
CkTask CrawlNextAsync();

Creates an asynchronous task to call the CrawlNext method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
FetchRobotsText
bool FetchRobotsText(CkString outStr);
string fetchRobotsText();

Returns the contents of the robots.txt file from the domain being crawled. This spider component 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.

Returns true for success, false for failure.

More Information and Examples
top
FetchRobotsTextAsync (1)
CkTask FetchRobotsTextAsync();

Creates an asynchronous task to call the FetchRobotsText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
GetAvoidPattern
bool GetAvoidPattern(int index, CkString outStr);
string getAvoidPattern(int index);

Returns the Nth avoid pattern previously added by calling AddAvoidPattern. Indexing begins at 0.

Returns true for success, false for failure.

top
GetBaseDomain
bool GetBaseDomain(string domain, CkString outStr);
string getBaseDomain(string domain);

To be documented soon.

Returns true for success, false for failure.

More Information and Examples
top
GetFailedUrl
bool GetFailedUrl(int index, CkString outStr);
string getFailedUrl(int index);

Returns the Nth URL in the failed URL list. Indexing begins at 0.

Returns true for success, false for failure.

top
GetOutboundLink
bool GetOutboundLink(int index, CkString outStr);
string getOutboundLink(int index);

Returns the Nth URL in the outbound link URL list. Indexing begins at 0.

Returns true for success, false for failure.

top
GetSpideredUrl
bool GetSpideredUrl(int index, CkString outStr);
string getSpideredUrl(int index);

Returns the Nth URL in the already-spidered URL list. Indexing begins at 0.

Returns true for success, false for failure.

top
GetUnspideredUrl
bool GetUnspideredUrl(int index, CkString outStr);
string getUnspideredUrl(int index);

Returns the Nth URL in the unspidered URL list. Indexing begins at 0.

Returns true for success, false for failure.

top
GetUrlDomain
bool GetUrlDomain(string url, CkString outStr);
string getUrlDomain(string url);

Returns the domain name part of a URL. For example, if the URL is "http://www.chilkatsoft.com/test.asp", then "www.chilkatsoft.com" is returned.

Returns true for success, false for failure.

top
Initialize
void Initialize(string domain);

Initializes the component 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.

More Information and Examples
top
RecrawlLast
bool 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.

top
RecrawlLastAsync (1)
CkTask RecrawlLastAsync();

Creates an asynchronous task to call the RecrawlLast method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SaveLastError
bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SkipUnspidered
void SkipUnspidered(int index);

Moves a URL from the unspidered list to the spidered list. This allows an application to skip a specific URL.

top
SleepMs
void SleepMs(int numMilliseconds);

Suspends the execution of the current thread until the time-out interval elapses.

top