X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FImageGallery.php;h=46ecd16959cf37c3c0ac35bf48237db2ed3dd21d;hb=772b5eb07e95144ae38fdceb3c1e2afbd588a4b7;hp=7ddacaed5f2012f6dc3192d1f770c5817945a919;hpb=a8369d40dd0da4aba1552c7c2ee4af94d124ac91;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php index 7ddacaed5f..46ecd16959 100644 --- a/includes/ImageGallery.php +++ b/includes/ImageGallery.php @@ -1,47 +1,177 @@ - mImages = array(); $this->mShowBytes = true; $this->mShowFilename = true; + $this->mParser = false; + $this->mHideBadImages = false; + } + + /** + * Register a parser object + */ + function setParser( $parser ) { + $this->mParser = $parser; + } + + /** + * Set bad image flag + */ + function setHideBadImages( $flag = true ) { + $this->mHideBadImages = $flag; + } + + /** + * Set the caption (as plain text) + * + * @param $caption Caption + */ + function setCaption( $caption ) { + $this->mCaption = htmlspecialchars( $caption ); + } + + /** + * Set the caption (as HTML) + * + * @param $caption Caption + */ + public function setCaptionHtml( $caption ) { + $this->mCaption = $caption; + } + + /** + * Set how many images will be displayed per row. + * + * @param int $num > 0; invalid numbers will be rejected + */ + public function setPerRow( $num ) { + if ($num > 0) { + $this->mPerRow = (int)$num; + } + } + + /** + * Set how wide each image will be, in pixels. + * + * @param int $num > 0; invalid numbers will be ignored + */ + public function setWidths( $num ) { + if ($num > 0) { + $this->mWidths = (int)$num; + } + } + + /** + * Set how high each image will be, in pixels. + * + * @param int $num > 0; invalid numbers will be ignored + */ + public function setHeights( $num ) { + if ($num > 0) { + $this->mHeights = (int)$num; + } + } + + /** + * Instruct the class to use a specific skin for rendering + * + * @param $skin Skin object + */ + function useSkin( $skin ) { + $this->mSkin = $skin; + } + + /** + * Return the skin that should be used + * + * @return Skin object + */ + function getSkin() { + if( !$this->mSkin ) { + global $wgUser; + $skin = $wgUser->getSkin(); + } else { + $skin = $this->mSkin; + } + return $skin; } /** * Add an image to the gallery. * - * @param Image $image Image object that is added to the gallery - * @param string $text Additional text to be shown. The name and size of the image are always shown. + * @param $title Title object of the image that is added to the gallery + * @param $html String: additional HTML text to be shown. The name and size of the image are always shown. */ - function add( $image, $text='' ) { - $this->mImages[] = array( &$image, $text ); + function add( $title, $html='' ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + $this->mImages[] = array( $title, $html ); + wfDebug( "ImageGallery::add " . $title->getText() . "\n" ); } /** - * isEmpty() returns false iff the gallery doesn't contain any images + * Add an image at the beginning of the gallery. + * + * @param $title Title object of the image that is added to the gallery + * @param $html String: Additional HTML text to be shown. The name and size of the image are always shown. + */ + function insert( $title, $html='' ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + array_unshift( $this->mImages, array( &$title, $html ) ); + } + + + /** + * isEmpty() returns true if the gallery contains no images */ function isEmpty() { return empty( $this->mImages ); @@ -50,8 +180,8 @@ class ImageGallery /** * Enable/Disable showing of the file size of an image in the gallery. * Enabled by default. - * - * @param boolean $f set to false to disable + * + * @param $f Boolean: set to false to disable. */ function setShowBytes( $f ) { $this->mShowBytes = ( $f == true); @@ -60,16 +190,29 @@ class ImageGallery /** * Enable/Disable showing of the filename of an image in the gallery. * Enabled by default. - * - * @param boolean $f set to false to disable + * + * @param $f Boolean: set to false to disable. */ function setShowFilename( $f ) { $this->mShowFilename = ( $f == true); } + + /** + * Set arbitrary attributes to go on the HTML gallery output element. + * Should be suitable for a <table> element. + * + * Note -- if taking from user input, you should probably run through + * Sanitizer::validateAttributes() first. + * + * @param array of HTML attribute pairs + */ + function setAttributes( $attribs ) { + $this->mAttribs = $attribs; + } /** * Return a HTML representation of the image gallery - * + * * For each image in the gallery, display * - a thumbnail * - the image name @@ -78,49 +221,134 @@ class ImageGallery * */ function toHTML() { - global $wgLang, $wgContLang, $wgUser; + global $wgLang; - $sk = $wgUser->getSkin(); + $sk = $this->getSkin(); - $s = ''; + $attribs = Sanitizer::mergeAttributes( + array( + 'class' => 'gallery', + 'cellspacing' => '0', + 'cellpadding' => '0' ), + $this->mAttribs ); + $s = Xml::openElement( 'table', $attribs ); + if( $this->mCaption ) + $s .= "\n\t"; + + $params = array( 'width' => $this->mWidths, 'height' => $this->mHeights ); $i = 0; foreach ( $this->mImages as $pair ) { - $img =& $pair[0]; + $nt = $pair[0]; $text = $pair[1]; + + # Give extensions a chance to select the file revision for us + $time = false; + wfRunHooks( 'BeforeGalleryFindFile', array( &$this, &$nt, &$time ) ); + + $img = wfFindFile( $nt, $time ); + + if( $nt->getNamespace() != NS_IMAGE || !$img ) { + # We're dealing with a non-image, spit out the name and be done with it. + $thumbhtml = "\n\t\t\t".'
' + . htmlspecialchars( $nt->getText() ) . '
'; + } elseif( $this->mHideBadImages && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() ) ) { + # The image is blacklisted, just show it as a text link. + $thumbhtml = "\n\t\t\t".'
' + . $sk->makeKnownLinkObj( $nt, htmlspecialchars( $nt->getText() ) ) . '
'; + } elseif( !( $thumb = $img->transform( $params ) ) ) { + # Error generating thumbnail. + $thumbhtml = "\n\t\t\t".'
' + . htmlspecialchars( $img->getLastError() ) . '
'; + } else { + $vpad = floor( ( 1.25*$this->mHeights - $thumb->height ) /2 ) - 2; + + $thumbhtml = "\n\t\t\t". + '
' + # Auto-margin centering for block-level elements. Needed now that we have video + # handlers since they may emit block-level elements as opposed to simple tags. + # ref http://css-discuss.incutio.com/?page=CenteringBlockElement + . '
' + . $thumb->toHtml( array( 'desc-link' => true ) ) . '
'; - $name = $img->getName(); - $nt = $img->getTitle(); + // Call parser transform hook + if ( $this->mParser && $img->getHandler() ) { + $img->getHandler()->parserTransformHook( $this->mParser, $img ); + } + } //TODO //$ul = $sk->makeLink( $wgContLang->getNsText( Namespace::getUser() ) . ":{$ut}", $ut ); - $nb = $this->mShowBytes ? - wfMsg( "nbytes", $wgLang->formatNum( $img->getSize() ) ) . '
' : - '' ; + if( $this->mShowBytes ) { + if( $img ) { + $nb = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'), + $wgLang->formatNum( $img->getSize() ) ); + } else { + $nb = wfMsgHtml( 'filemissing' ); + } + $nb = "$nb
\n"; + } else { + $nb = ''; + } + $textlink = $this->mShowFilename ? - $sk->makeKnownLinkObj( $nt, Language::truncate( $nt->getText(), 20, '...' ) ) . '
' : + $sk->makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . "
\n" : '' ; - $s .= ($i%4==0) ? '' : ''; - $s .= '' . (($i%4==3) ? '' : ''); + # ATTENTION: The newline after
is needed to accommodate htmltidy which + # in version 4.8.6 generated crackpot html in its absence, see: + # http://bugzilla.wikimedia.org/show_bug.cgi?id=1765 -Ævar - $i++; + if ( $i % $this->mPerRow == 0 ) { + $s .= "\n\t
"; + } + $s .= + "\n\t\t" . '"; + if ( $i % $this->mPerRow == $this->mPerRow - 1 ) { + $s .= "\n\t"; + } + ++$i; } - $s .= '
{$this->mCaption}
' . - ''. - '
' . - $sk->makeKnownLinkObj( $nt, '' ) . '
' . - $textlink . $text . $nb; - - $s .= '
' + . $thumbhtml + . "\n\t\t\t" . '
' . "\n" + . $textlink . $text . $nb + . "\n\t\t\t
" + . "\n\t\t
'; + if( $i % $this->mPerRow != 0 ) { + $s .= "\n\t"; + } + $s .= "\n"; return $s; } -} //class - + /** + * @return int Number of images in the gallery + */ + public function count() { + return count( $this->mImages ); + } + + /** + * Set the contextual title + * + * @param Title $title Contextual title + */ + public function setContextTitle( $title ) { + $this->contextTitle = $title; + } + + /** + * Get the contextual title, if applicable + * + * @return mixed Title or false + */ + public function getContextTitle() { + return is_object( $this->contextTitle ) && $this->contextTitle instanceof Title + ? $this->contextTitle + : false; + } +} //class -} // defined( 'MEDIAWIKI' ) -?>