Docs For Class PHPCrawlerMemoryURLCache

Description

Class for caching/storing URLs/links in memory.

Located in /libs/PHPCrawler/UrlCache/PHPCrawlerMemoryURLCache.class.php (line 8)

PHPCrawlerURLCacheBase
   |
   --PHPCrawlerMemoryURLCache

Variable Summary

mixed $urls

mixed $url_map

Method Summary

void addURL (PHPCrawlerURLDescriptor $UrlDescriptor)

void addURLs (array $urls)

void cleanup ()

void clear ()

bool containsURLs ()

array getAllURLs ()

int getMaxPriorityLevel ()

PhpCrawlerURLDescriptor getNextUrl ()

void markUrlAsFollowed (PHPCrawlerURLDescriptor $UrlDescriptor)

void purgeCache ()

Variables

mixed $urls = array() (line 10)

access: protected

mixed $url_map = array() (line 11)

access: protected

Inherited Variables

Inherited from PHPCrawlerURLCacheBase

PHPCrawlerURLCacheBase::$url_distinct_property
PHPCrawlerURLCacheBase::$url_priorities

Methods

addURL (line 77)

Adds an URL to the url-cache

access: public

void addURL (PHPCrawlerURLDescriptor $UrlDescriptor)

PHPCrawlerURLDescriptor $UrlDescriptor

Redefinition of:

PHPCrawlerURLCacheBase::addURL(): Adds an URL to the url-cache

addURLs (line 103)

Adds an bunch of URLs to the url-cache

access: public

void addURLs (array $urls)

array $urls: A numeric array containing the URLs as PHPCrawlerURLDescriptor-objects

Redefinition of:

PHPCrawlerURLCacheBase::addURLs(): Adds an bunch of URLs to the url-cache

cleanup (line 133)

Has no function in this class.

access: public

void cleanup ()

Redefinition of:

PHPCrawlerURLCacheBase::cleanup(): Do cleanups after the cache is not needed anymore

clear (line 65)

Removes all URLs and all priority-rules from the URL-cache.

access: public

void clear ()

Redefinition of:

PHPCrawlerURLCacheBase::clear(): Removes all URLs and all priority-rules from the URL-cache.

containsURLs (line 124)

Checks whether there are URLs left in the cache or not.

access: public

bool containsURLs ()

Redefinition of:

PHPCrawlerURLCacheBase::containsURLs(): Checks whether there are URLs left in the cache or not.

getAllURLs (line 45)

Returns all URLs currently cached in the URL-cache.

return: Numeric array containing all URLs as PHPCrawlerURLDescriptor-objects
access: public

array getAllURLs ()

Redefinition of:

PHPCrawlerURLCacheBase::getAllURLs(): Returns all URLs currently cached in the URL-cache.

getMaxPriorityLevel (line 156)

Returns the highest priority-level an URL exists in cache for.

access: protected

int getMaxPriorityLevel ()

getNextUrl (line 18)

Returns the next URL from the cache that should be crawled.

access: public

PhpCrawlerURLDescriptor getNextUrl ()

Redefinition of:

PHPCrawlerURLCacheBase::getNextUrl(): Returns the next URL from the cache that should be crawled.

markUrlAsFollowed (line 147)

Has no function in this memory-cache.

access: public

void markUrlAsFollowed (PHPCrawlerURLDescriptor $UrlDescriptor)

PHPCrawlerURLDescriptor $UrlDescriptor

Redefinition of:

PHPCrawlerURLCacheBase::markUrlAsFollowed(): Marks the given URL in the cache as "followed"

purgeCache (line 140)

Has no function in this class.

access: public

void purgeCache ()

Redefinition of:

PHPCrawlerURLCacheBase::purgeCache(): Cleans/purges the URL-cache from inconsistent entries.

Inherited Methods

Inherited From PHPCrawlerURLCacheBase

PHPCrawlerURLCacheBase::addLinkPriorities()
PHPCrawlerURLCacheBase::addLinkPriority()
PHPCrawlerURLCacheBase::addURL()
PHPCrawlerURLCacheBase::addURLs()
PHPCrawlerURLCacheBase::cleanup()
PHPCrawlerURLCacheBase::clear()
PHPCrawlerURLCacheBase::containsURLs()
PHPCrawlerURLCacheBase::getAllURLs()
PHPCrawlerURLCacheBase::getDistinctURLHash()
PHPCrawlerURLCacheBase::getNextUrl()
PHPCrawlerURLCacheBase::getUrlPriority()
PHPCrawlerURLCacheBase::markUrlAsFollowed()
PHPCrawlerURLCacheBase::purgeCache()

Class Constants

Inherited Constants

Inherited from PHPCrawlerURLCacheBase

PHPCrawlerURLCacheBase::URLHASH_NONE
PHPCrawlerURLCacheBase::URLHASH_RAWLINK
PHPCrawlerURLCacheBase::URLHASH_URL