Location: PHPKode > scripts > phpPhotoGallery > phpphotogallery/documentation.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>phpPhotoGallery Documentation</title>
</head>
<body bgcolor="#eeeeee" style="font-family:Verdana, Arial, Helvetica, sans-serif; font-size:12px">
<table cellpadding="2" cellspacing="2" border="0" width="100%">
	<tr>
		<td colspan="2" align="center"><font size="+2"><b>phpPhotoGallery Documentation</b></font></td>
	</tr>
	<tr>
		<td colspan="2"><font size="+1"><b>General Information</b></font></td>
	</tr>
	<tr>
		<td width="20%"><b>Author:</b></td>
		<td>Mammino Claudio</td>
	</tr>
	<tr>
		<td><b>Name:</b></td>
		<td>phpPhotoGallery</td>
	</tr>
	<tr>
		<td><b>Description:</b></td>
		<td>Thumbnails generator class</td>
	</tr>
	<tr>
		<td><b>License:</b></td>
		<td>GNU General Public License (GPL)</td>
	</tr>
	<tr>
		<td><b>Release Date:</b></td>
		<td>11/02/2007</td>
	</tr>
	<tr>
		<td><b>Version:</b></td>
		<td>1.5</td>
	</tr>
	<tr>
		<td><b>Last Release Date:</b></td>
		<td>25/05/2008</td>
	</tr>
	<tr>
		<td><b>Contact:</b></td>
		<td><a href="mailto:hide@address.com">hide@address.com</a></td>
	</tr>
</table>
<br />
<table cellpadding="2" cellspacing="2" border="0" width="100%">
	<tr>
		<td colspan="2"><font size="+1"><b>Class Description</b></font></td>
	</tr>
	<tr>
		<td colspan="2">The images can be loaded from a specified directory or one by one. The thumbnails can be showed in a single way or in a structured gallery, whit a fade effect.<br /><br /></td>
	</tr>
	<tr>
		<td width="20%"><b>Constructor:</b></td>
		<td>$obj = new myPhotoGallery(error [,typeThumbnails = 0] [,scaleThumbnails = 150] [,typePhoto = 1] [,scalePhoto = 100]);</td>
	</tr>
	<tr>
		<td valign="top" width="20%"><b>Files required:</b></td>
		<td>
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td>phpPhotoGallery.php</td>
				</tr>
				<tr>
					<td>viewImage.php</td>
				</tr>
			</table>
		</td>
	</tr>
	<tr>
		<td valign="top" width="20%"><b>File to include in your page:</b></td>
		<td>
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td>phpPhotoGallery.php</td>
				</tr>
			</table>
		</td>
	</tr>
	<tr>
		<td valign="top" width="20%"><b>Parameters:</b></td>
		<td>
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>error</b></td>
				</tr>
				<tr>
					<td>true - Show errors</td>
				</tr>
				<tr>
					<td>false - No show errors</td>
				</tr>
			</table>
			<br />
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>typeThumbnails</b></td>
				</tr>
				<tr>
					<td>0: To show thumbnails with width specified in $scaleThumbnails</td>
				</tr>
				<tr>
					<td>1: To show thumbnails with a zoom specified in $scaleThumbnails</td>
				</tr>
			</table>
			<br />
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>scaleThumbnails</b></td>
				</tr>
				<tr>
					<td>numeric value</td>
				</tr>
			</table>
			<br />
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>typePhoto</b></td>
				</tr>
				<tr>
					<td>0: To show photo with width specified in $scalePhoto</td>
				</tr>
				<tr>
					<td>1: To show photo with a zoom specified in $scalePhoto</td>
				</tr>
			</table>
			<br />
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>scalePhoto</b></td>
				</tr>
				<tr>
					<td>numeric value</td>
				</tr>
			</table>
		</td>
	</tr>
</table>
<br />
<table cellpadding="2" cellspacing="2" border="0" width="100%">
	<tr>
		<td colspan="2"><font size="+1"><b>Methods Description</b></font></td>
	</tr>
	<tr>
		<td valign="top" width="15%"><b>Necessary function:</b></td>
		<td>
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>$obj->showGallery();</b></td>
				</tr>
				<tr>
					<td>To return an image link array</td>
				</tr>
			</table>
			<br />
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>$obj->showInTable(photoForRow [,border = 0] [,width = 800])</b></td>
				</tr>
				<tr>
					<td><b>photoForRow:</b> Number of thumbnails to show for row</td>
				</tr>
				<tr>
					<td><b>border:</b> To show (border = 1) or hidden (border = 0) the table border</td>
				</tr>
				<tr>
					<td><b>width:</b> To specify the table width</td>
				</tr>
			</table>
			<br />
		</td>
	</tr>
	<tr>
		<td valign="top" width="15%"><b>Main function:</b></td>
		<td>
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>$obj->addDirPhotoNames("myDir" [,caption = "No caption specified"]);</b></td>
				</tr>
				<tr>
					<td>To add an images folder to gallery width a caption. The caption is the same for all directory images. If you want setting a different caption for every image, use <b>addImageName(imageName [,caption = "No caption specified"] [,id])</b> function.</td>
				</tr>
			</table>
			<br />
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>$obj->addImageName(imageName [,caption = "No caption specified"] [,id]);</b></td>
				</tr>
				<tr>
					<td>To add an image resource to gallery, with id specified in the third optional parameter. From the 1.5 released you can specify a image caption.</td>
				</tr>
			</table>
			<br />
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>$obj->showThumbnail(id)</b></td>
				</tr>
				<tr>
					<td>To show a single thumbnail with specified $id</td>
				</tr>
			</table>
			<br />
		</td>
	</tr>
	<tr>
		<td valign="top" width="15%"><b>Settings function:</b></td>
		<td>
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>$obj->setShadowEffect(boolean);</b></td>
				</tr>
				<tr>
					<td>To enabled/disabled shadow effect.</td>
				</tr>
			</table>
			<br />
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>$obj->setShowCaption(boolean);</b></td>
				</tr>
				<tr>
					<td>To enabled/disabled show image caption.</td>
				</tr>
			</table>
		</td>
	</tr>
	<tr>
		<td valign="top" width="20%"><b>Debug function:</b></td>
		<td>
			<table cellpadding="2" cellspacing="2" border="0" width="100%">
				<tr>
					<td><b>$obj->printSource();</b></td>
				</tr>
				<tr>
					<td>To print main data array</td>
				</tr>
			</table>
		</td>
	</tr>
</table>
<br />
<table cellpadding="2" cellspacing="2" border="0" width="100%">
	<tr>
		<td colspan="2"><font size="+1"><b><b>Versions History</b></b></font></td>
	</tr>
	<tr>
		<td width="20%"><b>Ver 1.0</b></td>
		<td>First gallery engine</td>
	</tr>
	<tr>
		<td><b>Ver 1.1</b></td>
		<td>Add thumbnail fade effect</td>
	</tr>
	<tr>
		<td><b>Ver 1.2</b></td>
		<td>Add the possibility to specify a photo zoom</td>
	</tr>
	<tr>
		<td><b>Ver 1.3</b></td>
		<td>Add the possibility to add multiple photo folders</td>
	</tr>
	<tr>
		<td><b>Ver 1.4</b></td>
		<td>Fixed some little bugs about supported files</td>
	</tr>
	<tr>
		<td><b>Ver 1.5</b></td>
		<td>Added some features like images caption, possibility to specify border and width table, enabled/disabled shadow effect, enabled/disabled show image caption</td>
	</tr>
</table>
</body>
</html>
Return current item: phpPhotoGallery