SlideshowImageGallery Class Reference
Inheritance diagram for SlideshowImageGallery:
Collaboration diagram for SlideshowImageGallery:
Public Member Functions | |
| __construct ( $mode='traditional', IContextSource $context=null) | |
| Create a new image gallery object. | |
 Public Member Functions inherited from TraditionalImageGallery | |
| toHTML () | |
| Return a HTML representation of the image gallery. | |
| Public Member Functions inherited from ImageGalleryBase | |
| add ( $title, $html='', $alt='', $link='', $handlerOpts=[]) | |
| Add an image to the gallery. | |
| count () | |
| getContextTitle () | |
| Get the contextual title, if applicable. | |
| getImages () | |
| Returns the list of images this gallery contains. | |
| insert ( $title, $html='', $alt='', $link='', $handlerOpts=[]) | |
| Add an image at the beginning of the gallery. | |
| isEmpty () | |
| isEmpty() returns true if the gallery contains no images | |
| setAdditionalOptions ( $options) | |
| Allow setting additional options. | |
| setAttributes ( $attribs) | |
| Set arbitrary attributes to go on the HTML gallery output element. | |
| setCaption ( $caption) | |
| Set the caption (as plain text) | |
| setCaptionHtml ( $caption) | |
| Set the caption (as HTML) | |
| setContextTitle ( $title) | |
| Set the contextual title. | |
| setHeights ( $num) | |
| Set how high each image will be, in pixels. | |
| setHideBadImages ( $flag=true) | |
| Set bad image flag. | |
| setParser ( $parser) | |
| Register a parser object. | |
| setPerRow ( $num) | |
| Set how many images will be displayed per row. | |
| setShowBytes ( $f) | |
| Enable/Disable showing of the file size of an image in the gallery. | |
| setShowFilename ( $f) | |
| Enable/Disable showing of the filename of an image in the gallery. | |
| setWidths ( $num) | |
| Set how wide each image will be, in pixels. | |
| Public Member Functions inherited from ContextSource | |
| canUseWikiPage () | |
| Check whether a WikiPage object can be get with getWikiPage(). | |
| exportSession () | |
| Export the resolved user IP, HTTP headers, user ID, and session ID. | |
| getConfig () | |
| Get the Config object. | |
| getContext () | |
| Get the base IContextSource object. | |
| getLanguage () | |
| Get the Language object. | |
| getOutput () | |
| Get the OutputPage object. | |
| getRequest () | |
| Get the WebRequest object. | |
| getSkin () | |
| Get the Skin object. | |
| getStats () | |
| Get the Stats object. | |
| getTiming () | |
| Get the Timing object. | |
| getTitle () | |
| Get the Title object. | |
| getUser () | |
| Get the User object. | |
| getWikiPage () | |
| Get the WikiPage object. | |
| msg () | |
| Get a Message object with context set Parameters are the same as wfMessage() | |
| setContext (IContextSource $context) | |
| Set the IContextSource object. | |
Protected Member Functions | |
| getModules () | |
| Add javascript adds interface elements. | |
| Protected Member Functions inherited from TraditionalImageGallery | |
| adjustImageParameters ( $thumb, &$imageParameters) | |
| Adjust the image parameters for a thumbnail. | |
| getAllPadding () | |
| Get total padding. | |
| getGBBorders () | |
| Get how much extra space the borders around the image takes up. | |
| getGBPadding () | |
| getGBWidth ( $thumb) | |
| Width of gallerybox . | |
| getThumbDivWidth ( $thumbWidth) | |
| Get the width of the inner div that contains the thumbnail in question. | |
| getThumbPadding () | |
| How much padding the thumb has between the image and the inner div that contains the border. | |
| getThumbParams ( $img) | |
| Get the transform parameters for a thumbnail. | |
| getVPad ( $boxHeight, $thumbHeight) | |
| Get vertical padding for a thumbnail. | |
| wrapGalleryText ( $galleryText, $thumb) | |
| Add the wrapper html around the thumb's caption. | |
| Protected Member Functions inherited from ImageGalleryBase | |
| getRenderLang () | |
| Determines the correct language to be used for this image gallery. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ImageGalleryBase | |
| static | factory ( $mode=false, IContextSource $context=null) |
| Get a new image gallery. | |
| Public Attributes inherited from ImageGalleryBase | |
| Parser | $mParser |
| Registered parser object for output callbacks. | |
| Protected Attributes inherited from ImageGalleryBase | |
| Title | $contextTitle = false |
| Contextual title, used when images are being screened against the bad image list. | |
| array | $mAttribs = [] |
| bool string | $mCaption = false |
| Gallery caption. | |
| bool | $mHideBadImages |
| Hide blacklisted images? | |
| array | $mImages |
| Gallery images. | |
| string | $mMode |
| Gallery mode. | |
| bool | $mShowBytes |
| Whether to show the filesize in bytes in categories. | |
| bool | $mShowFilename |
| Whether to show the filename. | |
Detailed Description
Definition at line 23 of file SlideshowImageGallery.php.
Constructor & Destructor Documentation
◆ __construct()
| SlideshowImageGallery::__construct | ( | $mode = 'traditional', |
|
| IContextSource | $context = null |
||
| ) |
Create a new image gallery object.
You should not call this directly, but instead use ImageGalleryBase::factory().
- Parameters
-
string $mode IContextSource | null $context
Reimplemented from ImageGalleryBase.
Definition at line 24 of file SlideshowImageGallery.php.
References ContextSource\$context.
Member Function Documentation
◆ getModules()
|
protected |
Add javascript adds interface elements.
- Returns
- array
Reimplemented from TraditionalImageGallery.
Definition at line 34 of file SlideshowImageGallery.php.
The documentation for this class was generated from the following file:
- includes/gallery/SlideshowImageGallery.php
