Class: WatermarkImage

Source Location: /modules/watermark/classes/WatermarkImage.class

Class WatermarkImage

Class Overview

Representation of an image used for watermarking

Located in /modules/watermark/classes/WatermarkImage.class [line 46]

GalleryPersistent
   |
   --GalleryEntity
      |
      --WatermarkImage

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryEntity

GalleryEntity::$creationTimestamp

GalleryEntity::$entityType

GalleryEntity::$id

GalleryEntity::$isLinkable

GalleryEntity::$linkedEntity

GalleryEntity::$linkId

GalleryEntity::$modificationTimestamp

GalleryEntity::$onLoadHandlers

GalleryEntity::$serialNumber

Inherited From GalleryPersistent

GalleryPersistent::$_persistentStatus

Inherited From GalleryEntity

GalleryEntity::addOnLoadHandler()

Add onLoad handler.

GalleryEntity::create()

Create a new instance of this GalleryEntity in the persistent store

GalleryEntity::createLink()

Create a new linked version of this item into a new album

GalleryEntity::delete()

Delete this GalleryEntity

GalleryEntity::detachLink()

Detach this entity from the entity it is linked to by the simple expedient of overwriting over all non-null members with the equivalent from the link target.

GalleryEntity::getClassName()

Return the case sensitive name of this entity class. This is exactly what get_class() would return in PHP5. PHP4 is case-insensitive though so we must rely on it being set in each entity. The framework uses this as an index into entity related tables.

GalleryEntity::getCreationTimestamp()

GalleryEntity::getEntityType()

GalleryEntity::getId()

GalleryEntity::getIsLinkable()

GalleryEntity::getLinkedEntity()

GalleryEntity::getLinkId()

GalleryEntity::getModificationTimestamp()

GalleryEntity::getOnLoadHandlers()

GalleryEntity::getRenderer()

GalleryEntity::getSerialNumber()

GalleryEntity::hasOnLoadHandler()

Check for an onLoad handler.

GalleryEntity::isLinked()

Return true if this entity is linked to another

GalleryEntity::itemTypeName()

Return the name of this type of item.

GalleryEntity::onLoad()

This is called after an entity is loaded by the GalleryStorage subsystem.

GalleryEntity::onSave()

This is called after an entity is saved by the GalleryStorage subsystem.

GalleryEntity::refresh()

Refresh this item from the persistent store

GalleryEntity::removeOnLoadHandler()

Remove onLoad handler.

GalleryEntity::save()

Save the changes to this GalleryEntity.

GalleryEntity::setCreationTimestamp()

GalleryEntity::setEntityType()

GalleryEntity::setId()

GalleryEntity::setIsLinkable()

GalleryEntity::setLinkedEntity()

GalleryEntity::setLinkId()

GalleryEntity::setModificationTimestamp()

GalleryEntity::setOnLoadHandlers()

GalleryEntity::setSerialNumber()

Inherited From GalleryPersistent

GalleryPersistent::GalleryPersistent()

GalleryPersistent::clearPersistentFlag()

Clear a flag.

GalleryPersistent::getClassFile()

Return the relative path to the class for this entity

GalleryPersistent::getOriginalValue()

Return the original value of the given member.

GalleryPersistent::isModified()

Have we modified any data in this class?

GalleryPersistent::resetOriginalValues()

Reset all original values to the current values in the entity (or null if so specified).

GalleryPersistent::setPersistentFlag()

Set a flag.

GalleryPersistent::testPersistentFlag()

Test a flag.

[ Top ]

Property Summary

bool	$applyToPreferred	Should this watermark be applied to the preferred derivative?
int	$applyToResizes	Should this watermark be applied to resize derivatives?
int	$applyToThumbnail	Should this watermark be applied to the thumbnail derivative?
string	$fileName	The watermark image filename, in the g2data/watermark directory
int	$height	The height of the image.
string	$mimeType	The mime type of the image.
string	$name	The symbolic name of this watermark, eg "My Watermark"
int	$ownerId	The owner of the image
int	$size	The size of the image file.
int	$width	The width of the image.
string	$xPercentage	The desired location of this watermark on the target image on the x-axis. Stored as a string instead of an integer so that we can have float values.
string	$yPercentage	The desired location of this watermark on the target image on the y-axis. Stored as a string instead of an integer so that we can have float values.

[ Top ]

Method Summary

GalleryStatus	create()	Create a new instance of this type in the persistent store.
void	delete()
array	fetchPath()	Full path to image file
void	getApplyToPreferred()
void	getApplyToResizes()
void	getApplyToThumbnail()
void	getClassName()
void	getFileName()
void	getHeight()
void	getMimeType()
void	getName()
void	getOwnerId()
void	getRenderer()	So WatermarkImage is displayable with {g->image}
void	getSize()
string	getWatermarkDir()	Watermark directory
void	getWidth()
void	getXPercentage()
void	getYPercentage()
string	render()	Render image
GalleryStatus	rescan()	Determine file size and dimensions
void	save()
void	setApplyToPreferred()
void	setApplyToResizes()
void	setApplyToThumbnail()
void	setFileName()
void	setHeight()
void	setMimeType()
void	setName()
void	setOwnerId()
void	setSize()
void	setWidth()
void	setXPercentage()
void	setYPercentage()

[ Top ]

Properties

bool $applyToPreferred [line 60]

Should this watermark be applied to the preferred derivative?

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>applyToPreferred</member-name>
G2:	<member-type>BOOLEAN</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	</member>

[ Top ]

int $applyToResizes [line 74]

Should this watermark be applied to resize derivatives?

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>applyToResizes</member-name>
G2:	<member-type>BOOLEAN</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	</member>

[ Top ]

int $applyToThumbnail [line 87]

Should this watermark be applied to the thumbnail derivative?

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>applyToThumbnail</member-name>
G2:	<member-type>BOOLEAN</member-type>
G2:	</member>

[ Top ]

string $fileName [line 120]

The watermark image filename, in the g2data/watermark directory

API Tags:

Access:

public

Information Tags:

G2:	<member-name>fileName</member-name>
G2:	<member>
G2:	<member-type>STRING</member-type>
G2:	<member-size>MEDIUM</member-size>
G2:	<member-external-access>READ</member-external-access>
G2:	<required/>
G2:	<unique/>
G2:	</member>

[ Top ]

int $height [line 176]

The height of the image.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>height</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	</member>

[ Top ]

string $mimeType [line 135]

The mime type of the image.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>mimeType</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $name [line 103]

The symbolic name of this watermark, eg "My Watermark"

API Tags:

Access:

public

Information Tags:

G2:	<member-name>name</member-name>
G2:	<member>
G2:	<member-type>STRING</member-type>
G2:	<member-size>MEDIUM</member-size>
G2:	<member-external-access>READ</member-external-access>
G2:	<required/>
G2:	</member>

[ Top ]

int $ownerId [line 189]

The owner of the image

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>ownerId</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	</member>

[ Top ]

int $size [line 148]

The size of the image file.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>size</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	</member>

[ Top ]

int $width [line 162]

The width of the image.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>width</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	</member>

[ Top ]

string $xPercentage [line 206]

The desired location of this watermark on the target image on the x-axis. Stored as a string instead of an integer so that we can have float values.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>xPercentage</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	<member-size>SMALL</member-size>
G2:	</member>

[ Top ]

string $yPercentage [line 223]

The desired location of this watermark on the target image on the y-axis. Stored as a string instead of an integer so that we can have float values.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>yPercentage</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	<member-size>SMALL</member-size>
G2:	</member>

[ Top ]

Methods

create [line 234]

GalleryStatus create(
string
$inputFileName, string
$mimeType, [string
$targetName = null] 
)

Create a new instance of this type in the persistent store.

Parameters:

string	$inputFileName:	the path to a data file to be contained
string	$mimeType:	the mime type of the new item
string	$targetName:	the desired name of the new item

API Tags:

Return:	a status code
Access:	public

Redefinition of:

GalleryEntity::create(): Create a new instance of this GalleryEntity in the persistent store

[ Top ]

delete [line 347]

void delete(
)

API Tags:

See:

GalleryEntity::delete

Redefinition of:

GalleryEntity::delete(): Delete this GalleryEntity

[ Top ]

fetchPath [line 373]

array fetchPath(
)

Full path to image file

API Tags:

Return:

GalleryStatus a status code, string path

[ Top ]

getApplyToPreferred [line 449]

void getApplyToPreferred(
)

[ Top ]

getApplyToResizes [line 457]

void getApplyToResizes(
)

[ Top ]

getApplyToThumbnail [line 465]

void getApplyToThumbnail(
)

[ Top ]

getClassName [line 445]

void getClassName(
)

API Tags:

See:

GalleryEntity::getClassName

Redefinition of:

GalleryEntity::getClassName(): Return the case sensitive name of this entity class. This is exactly what get_class() would return in PHP5. PHP4 is case-insensitive though so we must rely on it being set in each entity. The framework uses this as an index into entity related tables.

[ Top ]

getFileName [line 481]

void getFileName(
)

[ Top ]

getHeight [line 513]

void getHeight(
)

[ Top ]

getMimeType [line 489]

void getMimeType(
)

[ Top ]

getName [line 473]

void getName(
)

[ Top ]

getOwnerId [line 521]

void getOwnerId(
)

[ Top ]

getRenderer [line 438]

void getRenderer(
)

So WatermarkImage is displayable with {g->image}

Redefinition of:

GalleryEntity::getRenderer()

[ Top ]

getSize [line 497]

void getSize(
)

[ Top ]

getWatermarkDir [line 382]

string getWatermarkDir(
)

Watermark directory

API Tags:

Return:

Directory where watermark images are stored

[ Top ]

getWidth [line 505]

void getWidth(
)

[ Top ]

getXPercentage [line 529]

void getXPercentage(
)

[ Top ]

getYPercentage [line 537]

void getYPercentage(
)

[ Top ]

render [line 394]

string render(

$format, 
$params 
)

Render image

Parameters:

	$format:
	$params:

API Tags:

Return:

content

[ Top ]

rescan [line 310]

GalleryStatus rescan(
)

Determine file size and dimensions

API Tags:

Return:

a status code

[ Top ]

save [line 340]

void save(
[
$postEvent = true] 
)

Parameters:

$postEvent:

API Tags:

See:

GalleryEntity::save

Redefinition of:

GalleryEntity::save(): Save the changes to this GalleryEntity.

[ Top ]

setApplyToPreferred [line 453]

void setApplyToPreferred(

$applyToPreferred 
)

Parameters:

$applyToPreferred:

[ Top ]

setApplyToResizes [line 461]

void setApplyToResizes(

$applyToResizes 
)

Parameters:

$applyToResizes:

[ Top ]

setApplyToThumbnail [line 469]

void setApplyToThumbnail(

$applyToThumbnail 
)

Parameters:

$applyToThumbnail:

[ Top ]

setFileName [line 485]

void setFileName(

$fileName 
)

Parameters:

$fileName:

[ Top ]

setHeight [line 517]

void setHeight(

$height 
)

Parameters:

$height:

[ Top ]

setMimeType [line 493]

void setMimeType(

$mimeType 
)

Parameters:

$mimeType:

[ Top ]

setName [line 477]

void setName(

$name 
)

Parameters:

$name:

[ Top ]

setOwnerId [line 525]

void setOwnerId(

$ownerId 
)

Parameters:

$ownerId:

[ Top ]

setSize [line 501]

void setSize(

$size 
)

Parameters:

$size:

[ Top ]

setWidth [line 509]

void setWidth(

$width 
)

Parameters:

$width:

[ Top ]

setXPercentage [line 533]

void setXPercentage(

$xPercentage 
)

Parameters:

$xPercentage:

[ Top ]

setYPercentage [line 541]

void setYPercentage(

$yPercentage 
)

Parameters:

$yPercentage:

[ Top ]

Documentation generated on Fri, 08 Oct 2010 06:08:33 -0700 by phpDocumentor 1.3.0RC6

	Watermark Classes

[ class tree: Watermark ] [ index: Watermark ] [ all elements ]