Public Member Functions | |
| __construct ($mode= 'traditional') | |
| Create a new image gallery object. | |
| setPerRow ($num) | |
| Do not support per-row on packed. | |
Public Attributes | |
| const | SCALE_FACTOR = 1.5 |
| We artificially have 1.5 the resolution neccessary so that we can scale it up by that much on the client side, without worrying about requesting a new image. | |
Protected Member Functions | |
| adjustImageParameters ($thumb, &$imageParameters) | |
| Adjust the image parameters for a thumbnail. | |
| getGBPadding () | |
| getGBWidth ($thumb) | |
| getModules () | |
| Add javascript which auto-justifies the rows by manipulating the image sizes. | |
| getThumbDivWidth ($thumbWidth) | |
| Get the width of the inner div that contains the thumbnail in question. | |
| getThumbPadding () | |
| How much padding such the thumb have between image and inner div that that contains the border. | |
| getThumbParams ($img) | |
| getVPad ($boxHeight, $thumbHeight) | |
| Get vertical padding for a thumbnail. | |
Detailed Description
Definition at line 23 of file PackedImageGallery.php.
Constructor & Destructor Documentation
| PackedImageGallery::__construct | ( | $ | mode = 'traditional' | ) |
Create a new image gallery object.
You should not call this directly, but instead use ImageGalleryBase::factory().
Reimplemented from ImageGalleryBase.
Definition at line 25 of file PackedImageGallery.php.
Member Function Documentation
| PackedImageGallery::adjustImageParameters | ( | $ | thumb, |
| &$ | imageParameters | ||
| ) | [protected] |
Adjust the image parameters for a thumbnail.
Used by a subclass to insert extra high resolution images.
- Parameters:
-
MediaTransformOutput $thumb The thumbnail Array $imageParameters Array of options
Reimplemented from TraditionalImageGallery.
Definition at line 84 of file PackedImageGallery.php.
References SCALE_FACTOR.
| PackedImageGallery::getGBPadding | ( | ) | [protected] |
- Note:
- GB stands for gallerybox (as in the element)
- Returns:
- int
Reimplemented from TraditionalImageGallery.
Definition at line 46 of file PackedImageGallery.php.
Referenced by getGBWidth(), and PackedOverlayImageGallery\wrapGalleryText().
| PackedImageGallery::getGBWidth | ( | $ | thumb | ) | [protected] |
- Parameters:
-
MediaTransformOutput | bool $thumb the thumbnail, or false if no thumb (which can happen)
Reimplemented from TraditionalImageGallery.
Definition at line 79 of file PackedImageGallery.php.
References getGBPadding(), getThumbDivWidth(), and SCALE_FACTOR.
Referenced by PackedOverlayImageGallery\wrapGalleryText().
| PackedImageGallery::getModules | ( | ) | [protected] |
Add javascript which auto-justifies the rows by manipulating the image sizes.
Also ensures that the hover version of this degrades gracefully.
Reimplemented from TraditionalImageGallery.
Definition at line 94 of file PackedImageGallery.php.
References array().
| PackedImageGallery::getThumbDivWidth | ( | $ | thumbWidth | ) | [protected] |
Get the width of the inner div that contains the thumbnail in question.
This is the div with the class of "thumb".
- Parameters:
-
int $thumbWidth The width of the thumbnail.
- Returns:
- int Width of inner thumb div.
Reimplemented from TraditionalImageGallery.
Definition at line 68 of file PackedImageGallery.php.
References getThumbPadding(), and SCALE_FACTOR.
Referenced by getGBWidth().
| PackedImageGallery::getThumbPadding | ( | ) | [protected] |
How much padding such the thumb have between image and inner div that that contains the border.
This is both for verical and horizontal padding. (However, it is cut in half in the vertical direction).
- Returns:
- int
Reimplemented from TraditionalImageGallery.
Definition at line 42 of file PackedImageGallery.php.
Referenced by getThumbDivWidth(), getVPad(), and PackedOverlayImageGallery\wrapGalleryText().
| PackedImageGallery::getThumbParams | ( | $ | img | ) | [protected] |
- Parameters:
-
File $img The file being transformed. May be false
Reimplemented from TraditionalImageGallery.
Definition at line 53 of file PackedImageGallery.php.
References array().
| PackedImageGallery::getVPad | ( | $ | boxHeight, |
| $ | thumbHeight | ||
| ) | [protected] |
Get vertical padding for a thumbnail.
Generally this is the total height minus how high the thumb is.
- Parameters:
-
int $boxHeight How high we want the box to be. int $thumbHeight How high the thumbnail is.
- Returns:
- int How many vertical padding to add on each side.
Reimplemented from TraditionalImageGallery.
Definition at line 38 of file PackedImageGallery.php.
References getThumbPadding().
| PackedImageGallery::setPerRow | ( | $ | num | ) |
Do not support per-row on packed.
It really doesn't work since the images have varying widths.
Reimplemented from ImageGalleryBase.
Definition at line 102 of file PackedImageGallery.php.
Member Data Documentation
| const PackedImageGallery::SCALE_FACTOR = 1.5 |
We artificially have 1.5 the resolution neccessary so that we can scale it up by that much on the client side, without worrying about requesting a new image.
Definition at line 36 of file PackedImageGallery.php.
Referenced by adjustImageParameters(), getGBWidth(), and getThumbDivWidth().
The documentation for this class was generated from the following file:
- includes/gallery/PackedImageGallery.php
