Chilkat.Spider PHP Reference
Chilkat.Spider
* This is a freeware class/component/library.
Chilkat Spider web crawler component.
Object Creation
$obj = new COM("Chilkat.Spider");
Properties
bool AvoidHttps
If set the 1 (true) the spider will avoid all HTTPS URLs. The default is 0 (false).
string CacheDir
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.
bool 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).
int ConnectTimeout
The maximum number of seconds to wait while connecting to an HTTP server.
string Domain (read-only)
The domain name that is being spidered. This is the domain previously set in the Initialize method.
bool FetchFromCache
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.
int HeartbeatMs
To be documented soon...
string LastErrorHtml (read-only)
Error information in HTML format for the last method called.
string LastErrorText (read-only)
Error information in plain-text format for the last method called.
string LastErrorXml (read-only)
Error information in XML format for the last method called.
bool LastFromCache (read-only)
Equal to 1 if the last page spidered was fetched from the cache. Otherwise equal to 0.
string LastHtml (read-only)
The HTML text of the last paged fetched by the spider.
string LastHtmlDescription (read-only)
The HTML META description from the last page fetched by the spider.
string LastHtmlKeywords (read-only)
The HTML META keywords from the last page fetched by the spider.
string LastHtmlTitle (read-only)
The HTML title from the last page fetched by the spider.
Date LastModDate (read-only)
The last-modification date of the last URL spidered.
string LastUrl (read-only)
The URL of the last page spidered.
int MaxResponseSize
The maximum HTTP response size allowed. The spider will automatically fail any pages larger than this size. The default value is 250,000 bytes.
int MaxUrlLen
The maximum URL length allowed. URLs longer than this are not added to the unspidered list. The default value is 200.
int NumAvoidPatterns (read-only)
The number of avoid patterns previously set by calling AddAvoidPattern.
int NumFailed (read-only)
The number of URLs in the component's failed URL list.
int NumOutboundLinks (read-only)
The number of URLs in the component's outbound links URL list.
int NumSpidered (read-only)
The number of URLs in the component's already-spidered URL list.
int NumUnspidered (read-only)
The number of URLs in the component's unspidered URL list.
string ProxyDomain
(PreRelease) The domain name of a proxy host if an HTTP proxy is used.
string ProxyLogin
(PreRelease) If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
string ProxyPassword
(PreRelease) If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
int ProxyPort
(PreRelease) The port number of a proxy server if an HTTP proxy is used.
int ReadTimeout
The maximum number of seconds to wait when reading from an HTTP server.
bool UpdateCache
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.
string UserAgent
To be documented soon...
string Version (read-only)
The version (such as "1.0") of the spider component.
int 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
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.
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.
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.
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.
string CanonicalizeUrl(string url)
To be documented soon...
void ClearFailedUrls()
Clears the component's internal list of URLs that could not be downloaded.
void ClearOutboundLinks()
Clears the component's internal list of outbound URLs that will automatically accumulate while spidering.
void ClearSpideredUrls()
Clears the component's internal list of already-spidered URLs that will automatically accumulate while spidering.
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.
This method returns the HTML of the page downloaded. If there are no more URLs left unspidered, a NULL value is returned. Information about the URL crawled is available in the properties LastUrl, LastFromCache, and LastModDate.
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 a null on failure
string GetAvoidPattern(int index)
Returns the Nth avoid pattern previously added by calling AddAvoidPattern. Indexing begins at 0. Returns a null on failure
string GetBaseDomain(string domain)
To be documented soon...
string GetDomain(string url)
To be documented soon...
string GetFailedUrl(int index)
Returns the Nth URL in the failed URL list. Indexing begins at 0. Returns a null on failure
string GetOutboundLink(int index)
Returns the Nth URL in the outbound link URL list. Indexing begins at 0. Returns a null on failure
string GetSpideredUrl(int index)
Returns the Nth URL in the already-spidered URL list. Indexing begins at 0. Returns a null on failure
string GetUnspideredUrl(int index)
Returns the Nth URL in the unspidered URL list. Indexing begins at 0. Returns a null on failure
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.
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.
bool SaveLastError(string filename)
Saves the last error information to an XML formatted file.
void SkipUnspidered(int index)
Moves a URL from the unspidered list to the spidered list. This allows an application to skip a specific URL.
void Sleep(int numSeconds)
To be documented soon...
void SleepMs(int millisec)
To be documented soon...
|