ImageSize Class Reference
[Helper Classes]

List of all members.

---

Detailed Description

ImageSize is a class for dealing with various image sizes.

It supports resizing, path storing, and resizing/cropping to squares.

Definition at line 1114 of file base-image.inc.php.

Public Member Functions
	__construct ($name, $extension, $maxWidth, $maxHeight, $required=false, $scaleType= 'ratio')
	our constructor to create the object.
	getScaled ($x, $y)
	gets the scaled size to resize to.
Public Attributes
	$name
	see constructor params.
	$extension
	see constructor params.
	$maxWidth
	see constructor params.
	$maxHeight
	see constructor params.
	$required
	see constructor params.
	$scaleType
	see constructor params.

---

Member Function Documentation

ImageSize::__construct (  $  name, $  extension, $  maxWidth, $  maxHeight, $  required = false, $  scaleType = 'ratio' )

our constructor to create the object. Parameters: $name  string of english name of size. $extension  simple, index key type string added to filename and used for searching for types. $maxWidth  integer maximum width $maxHeight  integer maximum height $required  boolean if its required to be resized. $scaleType  what type of scaling... ratio or square. ratio preserves aspect, square crops to a center square. Definition at line 1151 of file base-image.inc.php.

ImageSize::getScaled (  $  x, $  y )

gets the scaled size to resize to. Parameters: $x  the width of image $y  the height of image an  array of sizes to resize to... index of x and y respectively. Definition at line 1169 of file base-image.inc.php.

---

Member Data Documentation

ImageSize::$extension

see constructor params. Definition at line 1123 of file base-image.inc.php.

ImageSize::$maxHeight

see constructor params. Definition at line 1131 of file base-image.inc.php.

ImageSize::$maxWidth

see constructor params. Definition at line 1127 of file base-image.inc.php.

ImageSize::$name

see constructor params. Definition at line 1119 of file base-image.inc.php.

ImageSize::$required

see constructor params. Definition at line 1135 of file base-image.inc.php.

ImageSize::$scaleType

see constructor params. Definition at line 1139 of file base-image.inc.php.

---

The documentation for this class was generated from the following file:

• lib/modules/base-image.inc.php

---