Class phpGrabComics

Description

Comic grabbing class. Can be overidden by modules that extend the class.

Some values might have to be changed for specific configurations.

Located in /inc/phpgrabcomics.php (line 39)


	
			
Direct descendents
Class Description
Acaseinpoint Defines variables and functions to grab a specific comic strip.
Adamathome Defines variables and functions to grab a specific comic strip.
Agnes Defines variables and functions to grab a specific comic strip.
Alienlovespredator Defines variables and functions to grab a specific comic strip.
Alleyoop Defines variables and functions to grab a specific comic strip.
Altan Defines variables and functions to grab a specific comic strip.
Andycapp Defines variables and functions to grab a specific comic strip.
Animalcrackers Defines variables and functions to grab a specific comic strip.
Annie Defines variables and functions to grab a specific comic strip.
Anntelnaes Defines variables and functions to grab a specific comic strip.
Apartmentthreeg Defines variables and functions to grab a specific comic strip.
Applegeeks Defines variables and functions to grab a specific comic strip.
Archie Defines variables and functions to grab a specific comic strip.
Arlonjanis Defines variables and functions to grab a specific comic strip.
Askshagg Defines variables and functions to grab a specific comic strip.
Babyblues Defines variables and functions to grab a specific comic strip.
Baldo Defines variables and functions to grab a specific comic strip.
Ballardstreet Defines variables and functions to grab a specific comic strip.
Barkeaterlake Defines variables and functions to grab a specific comic strip.
Barneygoogle Defines variables and functions to grab a specific comic strip.
Bc Defines variables and functions to grab a specific comic strip.
Beetlebailey Defines variables and functions to grab a specific comic strip.
Ben Defines variables and functions to grab a specific comic strip.
Bestoflatinamerica Defines variables and functions to grab a specific comic strip.
Betterhalf Defines variables and functions to grab a specific comic strip.
Betty Defines variables and functions to grab a specific comic strip.
Betweenfriends Defines variables and functions to grab a specific comic strip.
Bignate Defines variables and functions to grab a specific comic strip.
Bigtop Defines variables and functions to grab a specific comic strip.
Billday Defines variables and functions to grab a specific comic strip.
Billschorr Defines variables and functions to grab a specific comic strip.
Bizarro Defines variables and functions to grab a specific comic strip.
Blondie Defines variables and functions to grab a specific comic strip.
Bloomcounty Defines variables and functions to grab a specific comic strip.
Bobenglehart Defines variables and functions to grab a specific comic strip.
Bobo Defines variables and functions to grab a specific comic strip.
Bobthesquirrel Defines variables and functions to grab a specific comic strip.
Boffo Defines variables and functions to grab a specific comic strip.
Bonanas Defines variables and functions to grab a specific comic strip.
Boondocks Defines variables and functions to grab a specific comic strip.
Bornloser Defines variables and functions to grab a specific comic strip.
Bornlucky Defines variables and functions to grab a specific comic strip.
Bottomliners Defines variables and functions to grab a specific comic strip.
Boundandgagged Defines variables and functions to grab a specific comic strip.
Brendastarr Defines variables and functions to grab a specific comic strip.
Brevity Defines variables and functions to grab a specific comic strip.
Brewsterrockit Defines variables and functions to grab a specific comic strip.
Brianadcock Defines variables and functions to grab a specific comic strip.
Brianfairrington Defines variables and functions to grab a specific comic strip.
Broomhilda Defines variables and functions to grab a specific comic strip.
Buckets Defines variables and functions to grab a specific comic strip.
Buckles Defines variables and functions to grab a specific comic strip.
Bullsnbears Defines variables and functions to grab a specific comic strip.
Calvinandhobbes Defines variables and functions to grab a specific comic strip.
Camcardow Defines variables and functions to grab a specific comic strip.
Candorville Defines variables and functions to grab a specific comic strip.
Cathy Defines variables and functions to grab a specific comic strip.
Catswithhands Defines variables and functions to grab a specific comic strip.
Cestlavie Defines variables and functions to grab a specific comic strip.
Chanlowe Defines variables and functions to grab a specific comic strip.
cheapthrills Defines variables and functions to grab a specific comic strip.
Chipbok Defines variables and functions to grab a specific comic strip.
chuckasay Defines variables and functions to grab a specific comic strip.
Citizendog Defines variables and functions to grab a specific comic strip.
Clasi Defines variables and functions to grab a specific comic strip.
Clearbluewater Defines variables and functions to grab a specific comic strip.
Cleats Defines variables and functions to grab a specific comic strip.
Clemente Defines variables and functions to grab a specific comic strip.
Closetohome Defines variables and functions to grab a specific comic strip.
Committed Defines variables and functions to grab a specific comic strip.
Computoon Defines variables and functions to grab a specific comic strip.
Condorito Defines variables and functions to grab a specific comic strip.
Cornered Defines variables and functions to grab a specific comic strip.
CowandBoy Defines variables and functions to grab a specific comic strip.
Crankshaft Defines variables and functions to grab a specific comic strip.
Crist Defines variables and functions to grab a specific comic strip.
Crock Defines variables and functions to grab a specific comic strip.
ctrlaltdel Defines variables and functions to grab a specific comic strip.
Curtis Defines variables and functions to grab a specific comic strip.
Danasummers Defines variables and functions to grab a specific comic strip.
Danwasserman Defines variables and functions to grab a specific comic strip.
Darylcagle Defines variables and functions to grab a specific comic strip.
Davidhorsey Defines variables and functions to grab a specific comic strip.
Dennisthemenace Defines variables and functions to grab a specific comic strip.
Dicklocher Defines variables and functions to grab a specific comic strip.
Dicktracy Defines variables and functions to grab a specific comic strip.
Dickwright Defines variables and functions to grab a specific comic strip.
Dilbert Defines variables and functions to grab a specific comic strip.
Dinetteset Defines variables and functions to grab a specific comic strip.
Diogenes Defines variables and functions to grab a specific comic strip.
Dmfa Defines variables and functions to grab a specific comic strip.
Donwright Defines variables and functions to grab a specific comic strip.
Doodles Defines variables and functions to grab a specific comic strip.
Doonesbury Defines variables and functions to grab a specific comic strip.
Dougmarlette Defines variables and functions to grab a specific comic strip.
Drabble Defines variables and functions to grab a specific comic strip.
Drewlitton Defines variables and functions to grab a specific comic strip.
Drewsheneman Defines variables and functions to grab a specific comic strip.
Duplex Defines variables and functions to grab a specific comic strip.
Edgecity Defines variables and functions to grab a specific comic strip.
Edstein Defines variables and functions to grab a specific comic strip.
eightbittheatre Defines variables and functions to grab a specific comic strip.
Elgoonishshive Defines variables and functions to grab a specific comic strip.
Ellingtonway Defines variables and functions to grab a specific comic strip.
Ettahulme Defines variables and functions to grab a specific comic strip.
Facesinthenews Defines variables and functions to grab a specific comic strip.
Familycircus Defines variables and functions to grab a specific comic strip.
Fatcats Defines variables and functions to grab a specific comic strip.
Ferdnand Defines variables and functions to grab a specific comic strip.
Flashgordon Defines variables and functions to grab a specific comic strip.
Flightdeck Defines variables and functions to grab a specific comic strip.
Floandfriends Defines variables and functions to grab a specific comic strip.
Fminus Defines variables and functions to grab a specific comic strip.
Fontanarrosa Defines variables and functions to grab a specific comic strip.
Forattini Defines variables and functions to grab a specific comic strip.
Forbetterorforworse Defines variables and functions to grab a specific comic strip.
Foxtrot Defines variables and functions to grab a specific comic strip.
Franknernest Defines variables and functions to grab a specific comic strip.
Frazz Defines variables and functions to grab a specific comic strip.
Fredbasset Defines variables and functions to grab a specific comic strip.
Funkywinkerbean Defines variables and functions to grab a specific comic strip.
Garfield Defines variables and functions to grab a specific comic strip.
Garyvarvel Defines variables and functions to grab a specific comic strip.
Gasolinealley Defines variables and functions to grab a specific comic strip.
Geech Defines variables and functions to grab a specific comic strip.
Getfuzzy Defines variables and functions to grab a specific comic strip.
Gilthorp Defines variables and functions to grab a specific comic strip.
Girlgenius101 Defines variables and functions to grab a specific comic strip.
Girlgeniusmain Defines variables and functions to grab a specific comic strip.
Glasbergen Defines variables and functions to grab a specific comic strip.
Glennmccoy Defines variables and functions to grab a specific comic strip.
Goats Defines variables and functions to grab a specific comic strip.
Gofish Defines variables and functions to grab a specific comic strip.
Graffiti Defines variables and functions to grab a specific comic strip.
Grandave Defines variables and functions to grab a specific comic strip.
Grassilli Defines variables and functions to grab a specific comic strip.
Grinandbearit Defines variables and functions to grab a specific comic strip.
Grizzwells Defines variables and functions to grab a specific comic strip.
Hagarthehorrible Defines variables and functions to grab a specific comic strip.
Heartofthecity Defines variables and functions to grab a specific comic strip.
Heathcliff Defines variables and functions to grab a specific comic strip.
Hedge Defines variables and functions to grab a specific comic strip.
Helen Defines variables and functions to grab a specific comic strip.
Henrypayne Defines variables and functions to grab a specific comic strip.
Herbnjamaal Defines variables and functions to grab a specific comic strip.
Herman Defines variables and functions to grab a specific comic strip.
Hiandlois Defines variables and functions to grab a specific comic strip.
Housebroken Defines variables and functions to grab a specific comic strip.
Idiotbox Defines variables and functions to grab a specific comic strip.
Inthebleachers Defines variables and functions to grab a specific comic strip.
Jackhiggins Defines variables and functions to grab a specific comic strip.
Jackohman Defines variables and functions to grab a specific comic strip.
James Defines variables and functions to grab a specific comic strip.
Janesworld Defines variables and functions to grab a specific comic strip.
Jasonlove Defines variables and functions to grab a specific comic strip.
Jeffdanziger Defines variables and functions to grab a specific comic strip.
Jeffparker Defines variables and functions to grab a specific comic strip.
Jeffstahler Defines variables and functions to grab a specific comic strip.
Jerryholbert Defines variables and functions to grab a specific comic strip.
Johncole Defines variables and functions to grab a specific comic strip.
Joyoftech Defines variables and functions to grab a specific comic strip.
Judgeparker Defines variables and functions to grab a specific comic strip.
Jumble Defines variables and functions to grab a specific comic strip.
Jumpstart Defines variables and functions to grab a specific comic strip.
Katia Defines variables and functions to grab a specific comic strip.
Kitncarlyle Defines variables and functions to grab a specific comic strip.
Kudzu Defines variables and functions to grab a specific comic strip.
Lacucaracha Defines variables and functions to grab a specific comic strip.
Laloalcaraz Defines variables and functions to grab a specific comic strip.
Lanelly Defines variables and functions to grab a specific comic strip.
Larrywright Defines variables and functions to grab a specific comic strip.
Levelpath Defines variables and functions to grab a specific comic strip.
Liberty Defines variables and functions to grab a specific comic strip.
Lila Defines variables and functions to grab a specific comic strip.
Lilabner Defines variables and functions to grab a specific comic strip.
Littlegamers Defines variables and functions to grab a specific comic strip.
Lockhorns Defines variables and functions to grab a specific comic strip.
Lola Defines variables and functions to grab a specific comic strip.
Looseparts Defines variables and functions to grab a specific comic strip.
Lostsheep Defines variables and functions to grab a specific comic strip.
Luann Defines variables and functions to grab a specific comic strip.
Luckycow Defines variables and functions to grab a specific comic strip.
Lupo Defines variables and functions to grab a specific comic strip.
Mallardfillmore Defines variables and functions to grab a specific comic strip.
Mandrake Defines variables and functions to grab a specific comic strip.
Maramotti Defines variables and functions to grab a specific comic strip.
Marktrail Defines variables and functions to grab a specific comic strip.
Marmaduke Defines variables and functions to grab a specific comic strip.
Marvin Defines variables and functions to grab a specific comic strip.
Maryworth Defines variables and functions to grab a specific comic strip.
Matias Defines variables and functions to grab a specific comic strip.
mattdavies Defines variables and functions to grab a specific comic strip.
Meatloaf Defines variables and functions to grab a specific comic strip.
Mecohen Defines variables and functions to grab a specific comic strip.
Meehanstreak Defines variables and functions to grab a specific comic strip.
Meettheings Defines variables and functions to grab a specific comic strip.
Meg Defines variables and functions to grab a specific comic strip.
Megatokio Defines variables and functions to grab a specific comic strip.
metaknightmare Defines variables and functions to grab a specific comic strip.
Mgoose Defines variables and functions to grab a specific comic strip.
Middletons Defines variables and functions to grab a specific comic strip.
Mikekeefe Defines variables and functions to grab a specific comic strip.
Mikelane Defines variables and functions to grab a specific comic strip.
Mikelester Defines variables and functions to grab a specific comic strip.
Mikeluckovich Defines variables and functions to grab a specific comic strip.
Minesbigger Defines variables and functions to grab a specific comic strip.
MisterBaldo Defines variables and functions to grab a specific comic strip.
Mixedmedia Defines variables and functions to grab a specific comic strip.
Moderatelyconfused Defines variables and functions to grab a specific comic strip.
Momma Defines variables and functions to grab a specific comic strip.
Monty Defines variables and functions to grab a specific comic strip.
Motley Defines variables and functions to grab a specific comic strip.
Mullets Defines variables and functions to grab a specific comic strip.
Muttandjeff Defines variables and functions to grab a specific comic strip.
Mutts Defines variables and functions to grab a specific comic strip.
Nancy Defines variables and functions to grab a specific comic strip.
Naturalselection Defines variables and functions to grab a specific comic strip.
Neurotica Defines variables and functions to grab a specific comic strip.
Newslettercartoons Defines variables and functions to grab a specific comic strip.
Ninechickweedlane Defines variables and functions to grab a specific comic strip.
Ninetofive Defines variables and functions to grab a specific comic strip.
Nonsequitur Defines variables and functions to grab a specific comic strip.
Notinmybackyard Defines variables and functions to grab a specific comic strip.
Oddlyenough Defines variables and functions to grab a specific comic strip.
Offthemark Defines variables and functions to grab a specific comic strip.
Onebighappy Defines variables and functions to grab a specific comic strip.
Onthefastrack Defines variables and functions to grab a specific comic strip.
Opus Defines variables and functions to grab a specific comic strip.
Outofthegenepool Defines variables and functions to grab a specific comic strip.
Overboard Defines variables and functions to grab a specific comic strip.
Pardonmyplanet Defines variables and functions to grab a specific comic strip.
Patoliphant Defines variables and functions to grab a specific comic strip.
Patrickchappatte Defines variables and functions to grab a specific comic strip.
Paulconrad Defines variables and functions to grab a specific comic strip.
Paulszep Defines variables and functions to grab a specific comic strip.
Pcnpixel Defines variables and functions to grab a specific comic strip.
Pennyarcade Defines variables and functions to grab a specific comic strip.
Phantom Defines variables and functions to grab a specific comic strip.
Pibgorn Defines variables and functions to grab a specific comic strip.
Pickles Defines variables and functions to grab a specific comic strip.
Piranha Defines variables and functions to grab a specific comic strip.
PlayerVSPlayer Defines variables and functions to grab a specific comic strip.
Pluggers Defines variables and functions to grab a specific comic strip.
Pooch Defines variables and functions to grab a specific comic strip.
Popculture Defines variables and functions to grab a specific comic strip.
Popeye Defines variables and functions to grab a specific comic strip.
Preteena Defines variables and functions to grab a specific comic strip.
Pricklycity Defines variables and functions to grab a specific comic strip.
Princevaliant Defines variables and functions to grab a specific comic strip.
Quigmans Defines variables and functions to grab a specific comic strip.
Quirit Defines variables and functions to grab a specific comic strip.
Raisingduncan Defines variables and functions to grab a specific comic strip.
Reality Defines variables and functions to grab a specific comic strip.
Reallife Defines variables and functions to grab a specific comic strip.
Reallifeadventures Defines variables and functions to grab a specific comic strip.
Redandrover Defines variables and functions to grab a specific comic strip.
Redeye Defines variables and functions to grab a specific comic strip.
Rexmorgan Defines variables and functions to grab a specific comic strip.
Reynoldsunwrapped Defines variables and functions to grab a specific comic strip.
Rhymeswithorange Defines variables and functions to grab a specific comic strip.
Ripleys Defines variables and functions to grab a specific comic strip.
Robertariail Defines variables and functions to grab a specific comic strip.
Robrogers Defines variables and functions to grab a specific comic strip.
Roseisrose Defines variables and functions to grab a specific comic strip.
Rubes Defines variables and functions to grab a specific comic strip.
Rudypark Defines variables and functions to grab a specific comic strip.
Rugrats Defines variables and functions to grab a specific comic strip.
Safehavens Defines variables and functions to grab a specific comic strip.
Sallyforth Defines variables and functions to grab a specific comic strip.
Sandyhuffaker Defines variables and functions to grab a specific comic strip.
Shawisland Defines variables and functions to grab a specific comic strip.
Sheldon Defines variables and functions to grab a specific comic strip.
Shermanslagoon Defines variables and functions to grab a specific comic strip.
Shirleynson Defines variables and functions to grab a specific comic strip.
Shoe Defines variables and functions to grab a specific comic strip.
Shoecabbage Defines variables and functions to grab a specific comic strip.
siloroberts Defines variables and functions to grab a specific comic strip.
Sinfest Defines variables and functions to grab a specific comic strip.
Sixchix Defines variables and functions to grab a specific comic strip.
Slylockfox Defines variables and functions to grab a specific comic strip.
Snoopy Defines variables and functions to grab a specific comic strip.
Soup2nutz Defines variables and functions to grab a specific comic strip.
Spanishspider Defines variables and functions to grab a specific comic strip.
Speedbump Defines variables and functions to grab a specific comic strip.
Spiderman Defines variables and functions to grab a specific comic strip.
Spotthefrog Defines variables and functions to grab a specific comic strip.
Stateoftheunion Defines variables and functions to grab a specific comic strip.
Stephaneperay Defines variables and functions to grab a specific comic strip.
Stevebenson Defines variables and functions to grab a specific comic strip.
Steveroper Defines variables and functions to grab a specific comic strip.
Stevesack Defines variables and functions to grab a specific comic strip.
Stonesoup Defines variables and functions to grab a specific comic strip.
Strangebrew Defines variables and functions to grab a specific comic strip.
Stuartcarlson Defines variables and functions to grab a specific comic strip.
Sunshineclub Defines variables and functions to grab a specific comic strip.
Swine Defines variables and functions to grab a specific comic strip.
Sylvia Defines variables and functions to grab a specific comic strip.
Tab Defines variables and functions to grab a specific comic strip.
Tank Defines variables and functions to grab a specific comic strip.
Tarzan Defines variables and functions to grab a specific comic strip.
Tdie Defines variables and functions to grab a specific comic strip.
Tedrall Defines variables and functions to grab a specific comic strip.
Thatslife Defines variables and functions to grab a specific comic strip.
Thebigpicture Defines variables and functions to grab a specific comic strip.
Thecynic Defines variables and functions to grab a specific comic strip.
Theelderberries Defines variables and functions to grab a specific comic strip.
Thefifthwave Defines variables and functions to grab a specific comic strip.
Theflyingmccoys Defines variables and functions to grab a specific comic strip.
Thefuscobrothers Defines variables and functions to grab a specific comic strip.
Thehumblestumble Defines variables and functions to grab a specific comic strip.
Theothercoast Defines variables and functions to grab a specific comic strip.
Thequigmans Defines variables and functions to grab a specific comic strip.
Thewizardofid Defines variables and functions to grab a specific comic strip.
Thewotch Defines variables and functions to grab a specific comic strip.
Tiger Defines variables and functions to grab a specific comic strip.
Tinasgroove Defines variables and functions to grab a specific comic strip.
Tomthedancingbug Defines variables and functions to grab a specific comic strip.
Tomtoles Defines variables and functions to grab a specific comic strip.
Tonyauth Defines variables and functions to grab a specific comic strip.
Topofworld Defines variables and functions to grab a specific comic strip.
Tumbleweeds Defines variables and functions to grab a specific comic strip.
Unfit Defines variables and functions to grab a specific comic strip.
Userfriendly Defines variables and functions to grab a specific comic strip.
UserfriendlyBig Defines variables and functions to grab a specific comic strip.
Vauro Defines variables and functions to grab a specific comic strip.
Vinceofarrell Defines variables and functions to grab a specific comic strip.
Walthandelsman Defines variables and functions to grab a specific comic strip.
Waynestayskal Defines variables and functions to grab a specific comic strip.
Weepals Defines variables and functions to grab a specific comic strip.
Willyandethel Defines variables and functions to grab a specific comic strip.
Workingdaze Defines variables and functions to grab a specific comic strip.
Workingitout Defines variables and functions to grab a specific comic strip.
Zackhill Defines variables and functions to grab a specific comic strip.
Ziggy Defines variables and functions to grab a specific comic strip.
Zippythepinhead Defines variables and functions to grab a specific comic strip.
Zits Defines variables and functions to grab a specific comic strip.
Variable Summary
string $address
string $author
boolean $checks_enabled
string $comic_html
string $complains
boolean $enabled
string $group
string $home_page
string $img_ext
string $img_name
string $img_url
string $match_string
integer $min_filesize
string $name
boolean $permanent_url
string $referer
boolean $report
string $rss_url
string $short_name
integer $time_offset
integer $time_slice
string $unix_name
integer $urls_saved
string $url_code
array $valid_mimes
Method Summary
boolean checkGrab ()
boolean getFileName ()
boolean grab ()
boolean grabHtml ()
boolean grabUrl ()
void groupChron ()
void groupChron2 ()
void groupClarin ()
void groupComics ()
void groupComicsWash ()
void groupCreators ()
void groupGoComics ()
void groupKingonline ()
void groupRbmaCommon ()
void groupSeaPI ()
void groupSeaTimes ()
void groupUcomics ()
void logError ($error $error)
boolean makeImg ([string $img = ""])
void makeJpegCounter ($img $img)
void pGrabUrl ()
void pImg ([$img $img = ""])
void pImgRelative ($img $img, $alt $alt)
void pListComics ()
boolean processComicInfo (mixed $comic_info)
false rCheckMime ($string $string)
False read ($url $url)
string rIcon ([mixed $case = "default"])
string rIconPath ()
bool rParseRSS ()
string rToday ()
void rURLFromIMGTag (mixed $string)
void setHttpHeaders ()
boolean siteComplains ()
Variables
boolean $archive_using_date = True (line 187)

If True saves the file in the archive using the date.

If False will use the file name.

string $author = "" (line 227)

Author of the comic strip. More authors are separated by commas.


Redefined in descendants as:
boolean $checks_enabled = False (line 170)

If the web site is making some sort of check to distinguish real users and bots.

If True, many options will be disabled for the comic. For example, if checks are enabled the comic cannot technically be distributed via RSS to all the users.


Redefined in descendants as:
string $comic_html = "" (line 75)

HTML code of retrieved page

string $complains = False (line 269)

If the comic copyright holder complains about phpGrabComics, the variable is to be set to True and some info will not be published (unless the parameter is overridden in the URL).


Redefined in descendants as:
string $description_long = "" (line 241)

Long description of the comic strip

string $description_short = "" (line 234)

Short description of the comic strip


Redefined in descendants as:
string $group = "" (line 277)

identifies the group of the comics.

if a comic is part of a group, a specific function is called from the constructor, allowing to do some common operation for the group of comics.


Redefined in descendants as:
string $home_page = "" (line 262)

Use $home_page if the web site has an easy download page, used as $address, and a "real", different home page (not yet implemented)

array $http_headers (line 161)

The HTTP headers to be used when retrieving the comic. By default, using real headers. Some sites check for some strings to be present in the headers.

string $img_ext = ".gif" (line 127)

Default extension for the comic strip.


Redefined in descendants as:
string $img_name = "" (line 61)

Name of image (it's used for deciding file name)

string $img_today_suffix = "_today" (line 113)

Suffix for today image.

Image is saved in the temporary position and only if it is ok is then copied to the correct position, using this suffix.

integer $min_filesize = 3000 (line 147)

Size in bytes of the minimum dimension for comics. If a comics is less then that, will be deleted.

string $name = "" (line 97)

Name of the comic (e.g. Calvin and Hobbes).

If not set, defaults to the name of the class. For comics wich name is only one word without strange characters, you can avoid setting up both the name and the unix_name (e.g. Dilbert).


Redefined in descendants as:
boolean $permanent_url = False (line 179)

If True the comic strip is always in the same URL.

It happens for comics like forattini and vauro and implies that the comic has to be downloaded to know if it is new or not. It implies as well that only one comic can be kept at the same time.


Redefined in descendants as:
string $referer = "" (line 120)

Referrer to be used when downloading the comic.

boolean $report = True (line 154)

If to report errors or not


Redefined in descendants as:
string $rss_url = "" (line 54)

The url of the RSS feed for the comic

string $short_name = "" (line 105)

A few times might be necessary to use a shorter name, not the long name.

This applies to a few comics that have a very long name.


Redefined in descendants as:
string $short_url_code = "" (line 289)

Modules can use this variable to save another code for the comic.


Redefined in descendants as:
string $suggested_links = array() (line 248)

Suggested web sites about the comic


Redefined in descendants as:
integer $time_offset = 0 (line 195)

The time offset between the phpGrabComics server and the comics server.

Expressed in seconds and refined comic by comic if necessary.


Redefined in descendants as:
integer $time_slice = 4 (line 204)

How often a file will be downloaded.

Expressed in seconds and refined comic by comic if necessary. If a file is not newer than the given time_slice, in hours, it will not be downloaded

string $unix_name = "" (line 89)

Unix name of comic (e.g. "calvinandhobbes", used for directory names etc.). If not set, defaults to the lowercase name of the class. You can avoid setting up the unix_name.

integer $urls_saved = 7 (line 211)

How many recent urls can be saved in the database


Redefined in descendants as:
string $url_code = "" (line 283)

Modules can use this variable to save a code for the comic.


Redefined in descendants as:
array $valid_mimes = array(
// default extension, magic number, type of magic number, mime type
Array("gif","GIF8","string","image/gif"),Array("jpg","0xffd8","beshort","image/jpeg"),Array("jpg","ÿÛ","string","image/jpeg"),Array("png","\x89PNG","string","image/png"))
(line 134)

Valid mime types; very untidy way, but available in most php versions

Methods
Constructor phpGrabComics (line 295)

base constructor. defines name and unix name if not provided in the extended classes.

phpGrabComics phpGrabComics ()
checkGrab (line 1046)

this function may be overridden by the different classes. checks if the file has been already retrieved in the last hours or not

boolean checkGrab ()
getFileName (line 1527)

gets the name that the strip will have when saved in the archive can be redefined in different comics modules if the file name is already defined, returns true without checking.

boolean getFileName ()
grab (line 890)

tries to grab choosen comic

boolean grab ()
grabHtml (line 1420)

grabs html from the url of a comic can be redefined in different comics modules as this function is a helper function for finding the comic URL, if the comic URL is already defined, returns true without checking.

boolean grabHtml ()
grabUrl (line 1445)

grabs an url from the html grabbed from the url of a comic can be redefined in different comics modules if the comic URL is already defined, returns true without checking.

boolean grabUrl ()

Redefined in descendants as:
groupChron (line 370)

common actions to be done by the comics that are part of the chron group.

void groupChron ()
groupChron2 (line 380)

common actions to be done by the comics that are part of the chron2 group.

void groupChron2 ()
groupClarin (line 442)

common actions to be done by the comics that are part of the clarin group.

void groupClarin ()
groupComics (line 470)

common actions to be done by the comics that are part of the comics group.

void groupComics ()
groupComicsCreators (line 528)

common actions to be done by the comics that are part of the comics|creators group.

void groupComicsCreators ()
groupComicsEditoons (line 557)

common actions to be done by the comics that are part of the comics|editoons group.

void groupComicsEditoons ()
groupComicsWash (line 499)

common actions to be done by the comics that are part of the comics2 group.

void groupComicsWash ()
groupCreators (line 586)

common actions to be done by the comics that are part of the creators group.

void groupCreators ()
groupGoComics (line 402)

common actions to be done by the comics that are part of the gocomics group which should replace the ucomics group.

void groupGoComics ()
groupKingfeatures (line 622)

common actions to be done by the comics that are part of the kingfeatures group.

void groupKingfeatures ()
groupKingonline (line 360)

common actions to be done by the comics that are part of the King Online group.

void groupKingonline ()
groupRbmaCommon (line 325)

common actions to be done by some comics that are part of the rbma group or have a similar structure.

void groupRbmaCommon ()
groupRbmaGenericWithDate (line 339)

common actions to be done by some comics that are using the rbma group or have a similar structure.

void groupRbmaGenericWithDate ()
groupRbmaGenericWithOutDate (line 350)

common actions to be done by some comics that are using the rbma group or have a similar structure.

void groupRbmaGenericWithOutDate ()
groupSeaPI (line 432)

common actions to be done by the comics that are part of the Seattle PI group.

void groupSeaPI ()
groupSeaTimes (line 413)

common actions to be done by the comics that are part of the Seattle Times group.

void groupSeaTimes ()
groupSeaTimesRBMS (line 421)
void groupSeaTimesRBMS ()
groupUcomics (line 391)

common actions to be done by the comics that are part of the ucomics group.

void groupUcomics ()
logError (line 1009)

Reports an error in the error log file. Eventually sends a mail with the error.

void logError ($error $error)
  • $error $error: unknown
makeImg (line 1289)

outputs a image. if $img is empy, outputs today's comic, else outputs $img.

boolean makeImg ([string $img = ""])
  • string $img
makeJpegCounter (line 1342)

makes a counter based on a image

void makeJpegCounter ($img $img)
  • $img $img
pGrabUrl (line 1401)

prints html code for displaying image of active comic. can be redefined in different comics modules

void pGrabUrl ()
pImg (line 1234)

checks if image file exists. it so, it prints html code for displaying.

void pImg ([$img $img = ""])
  • $img $img: path of image to be inserted in the page
pImgRelative (line 1278)

prints html code for displaying image $img without checking if file exists. check must be done before calling this function.

void pImgRelative ($img $img, $alt $alt)
  • $img $img: path of image
  • $alt $alt: alt text
pListComics (line 1097)

prints the archive of selected comics

void pListComics ()
processComicInfo (line 738)

A $comic_info variable is created by the appropriate functions, according to the type of comics class. RSS classes and parsing classes will create a $comic_info array in a different way. This function processes the $comic_info information and if the comic is not in db, will save it.

boolean processComicInfo (mixed $comic_info)
rCheckMime (line 1573)

checks if the type of the string is valid

  • return: or the mime type
false rCheckMime ($string $string)
  • $string $string
read (line 1073)

wide-compatible download function

  • return: or resource
False read ($url $url)
  • $url $url: URL of resource to download
rIcon (line 1167)

returns comic icon for this class. it is intended to be inheritated and used by a sub-class

string rIcon ([mixed $case = "default"])
rIconPath (line 1214)

returns comic icon path for this class.

string rIconPath ()
rParseRSS (line 661)

Parses a RSS file and sets all the required variables. When processing a RSS file, the last comics need to be found, ordering the array of elements by date. The array of entries will be parsed. The elements that are newer that last_date in table hits will be processed. The other elements will be ignored. If the array cannot be ordered by date, or if the dates are not real, all the entries need to be processed. The elements in the remaining list will be matched with the table comics. Only the ones that are not there will be added.

bool rParseRSS ()
rToday (line 1511)

returns the current date, formatted to be used by getFileName in the place where the comic is published. it is used to ensure that the daily comics are saved with the correct date if they are archived with the date and not with the file name

string rToday ()
rURLFromIMGTag (line 630)
void rURLFromIMGTag (mixed $string)
setHttpHeaders (line 1551)
void setHttpHeaders ()
siteComplains (line 983)

Checks if is set and override via GET for accessing the informations of sites that complain about phpGrabComics.

boolean siteComplains ()

Documentation generated on Wed, 01 Nov 2006 18:54:10 +0000 by phpDocumentor 1.3.0RC3