diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2011-06-22 11:28:20 +0200 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2011-06-22 11:28:20 +0200 |
commit | 9db190c7e736ec8d063187d4241b59feaf7dc2d1 (patch) | |
tree | 46d1a0dee7febef5c2d57a9f7b972be16a163b3d /includes/MediaTransformOutput.php | |
parent | 78677c7bbdcc9739f6c10c75935898a20e1acd9e (diff) |
update to MediaWiki 1.17.0
Diffstat (limited to 'includes/MediaTransformOutput.php')
-rw-r--r-- | includes/MediaTransformOutput.php | 245 |
1 files changed, 0 insertions, 245 deletions
diff --git a/includes/MediaTransformOutput.php b/includes/MediaTransformOutput.php deleted file mode 100644 index a3fcc96e..00000000 --- a/includes/MediaTransformOutput.php +++ /dev/null @@ -1,245 +0,0 @@ -<?php -/** - * @file - * @ingroup Media - */ - -/** - * Base class for the output of MediaHandler::doTransform() and File::transform(). - * - * @ingroup Media - */ -abstract class MediaTransformOutput { - var $file, $width, $height, $url, $page, $path; - - /** - * Get the width of the output box - */ - function getWidth() { - return $this->width; - } - - /** - * Get the height of the output box - */ - function getHeight() { - return $this->height; - } - - /** - * @return string The thumbnail URL - */ - function getUrl() { - return $this->url; - } - - /** - * @return string Destination file path (local filesystem) - */ - function getPath() { - return $this->path; - } - - /** - * Fetch HTML for this transform output - * - * @param array $options Associative array of options. Boolean options - * should be indicated with a value of true for true, and false or - * absent for false. - * - * alt Alternate text or caption - * desc-link Boolean, show a description link - * file-link Boolean, show a file download link - * custom-url-link Custom URL to link to - * custom-title-link Custom Title object to link to - * valign vertical-align property, if the output is an inline element - * img-class Class applied to the <img> tag, if there is such a tag - * - * For images, desc-link and file-link are implemented as a click-through. For - * sounds and videos, they may be displayed in other ways. - * - * @return string - */ - abstract function toHtml( $options = array() ); - - /** - * This will be overridden to return true in error classes - */ - function isError() { - return false; - } - - /** - * Wrap some XHTML text in an anchor tag with the given attributes - */ - protected function linkWrap( $linkAttribs, $contents ) { - if ( $linkAttribs ) { - return Xml::tags( 'a', $linkAttribs, $contents ); - } else { - return $contents; - } - } - - function getDescLinkAttribs( $title = null, $params = '' ) { - $query = $this->page ? ( 'page=' . urlencode( $this->page ) ) : ''; - if( $params ) { - $query .= $query ? '&'.$params : $params; - } - $attribs = array( - 'href' => $this->file->getTitle()->getLocalURL( $query ), - 'class' => 'image', - ); - if ( $title ) { - $attribs['title'] = $title; - } - return $attribs; - } -} - - -/** - * Media transform output for images - * - * @ingroup Media - */ -class ThumbnailImage extends MediaTransformOutput { - /** - * @param string $path Filesystem path to the thumb - * @param string $url URL path to the thumb - * @private - */ - function ThumbnailImage( $file, $url, $width, $height, $path = false, $page = false ) { - $this->file = $file; - $this->url = $url; - # These should be integers when they get here. - # If not, there's a bug somewhere. But let's at - # least produce valid HTML code regardless. - $this->width = round( $width ); - $this->height = round( $height ); - $this->path = $path; - $this->page = $page; - } - - /** - * Return HTML <img ... /> tag for the thumbnail, will include - * width and height attributes and a blank alt text (as required). - * - * @param array $options Associative array of options. Boolean options - * should be indicated with a value of true for true, and false or - * absent for false. - * - * alt HTML alt attribute - * title HTML title attribute - * desc-link Boolean, show a description link - * file-link Boolean, show a file download link - * valign vertical-align property, if the output is an inline element - * img-class Class applied to the <img> tag, if there is such a tag - * desc-query String, description link query params - * custom-url-link Custom URL to link to - * custom-title-link Custom Title object to link to - * - * For images, desc-link and file-link are implemented as a click-through. For - * sounds and videos, they may be displayed in other ways. - * - * @return string - * @public - */ - function toHtml( $options = array() ) { - if ( count( func_get_args() ) == 2 ) { - throw new MWException( __METHOD__ .' called in the old style' ); - } - - $alt = empty( $options['alt'] ) ? '' : $options['alt']; - - $query = empty( $options['desc-query'] ) ? '' : $options['desc-query']; - - if ( !empty( $options['custom-url-link'] ) ) { - $linkAttribs = array( 'href' => $options['custom-url-link'] ); - if ( !empty( $options['title'] ) ) { - $linkAttribs['title'] = $options['title']; - } - } elseif ( !empty( $options['custom-title-link'] ) ) { - $title = $options['custom-title-link']; - $linkAttribs = array( - 'href' => $title->getLinkUrl(), - 'title' => empty( $options['title'] ) ? $title->getFullText() : $options['title'] - ); - } elseif ( !empty( $options['desc-link'] ) ) { - $linkAttribs = $this->getDescLinkAttribs( empty( $options['title'] ) ? null : $options['title'], $query ); - } elseif ( !empty( $options['file-link'] ) ) { - $linkAttribs = array( 'href' => $this->file->getURL() ); - } else { - $linkAttribs = false; - } - - $attribs = array( - 'alt' => $alt, - 'src' => $this->url, - 'width' => $this->width, - 'height' => $this->height, - ); - if ( !empty( $options['valign'] ) ) { - $attribs['style'] = "vertical-align: {$options['valign']}"; - } - if ( !empty( $options['img-class'] ) ) { - $attribs['class'] = $options['img-class']; - } - return $this->linkWrap( $linkAttribs, Xml::element( 'img', $attribs ) ); - } - -} - -/** - * Basic media transform error class - * - * @ingroup Media - */ -class MediaTransformError extends MediaTransformOutput { - var $htmlMsg, $textMsg, $width, $height, $url, $path; - - function __construct( $msg, $width, $height /*, ... */ ) { - $args = array_slice( func_get_args(), 3 ); - $htmlArgs = array_map( 'htmlspecialchars', $args ); - $htmlArgs = array_map( 'nl2br', $htmlArgs ); - - $this->htmlMsg = wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $msg, true ) ), $htmlArgs ); - $this->textMsg = wfMsgReal( $msg, $args ); - $this->width = intval( $width ); - $this->height = intval( $height ); - $this->url = false; - $this->path = false; - } - - function toHtml( $options = array() ) { - return "<table class=\"MediaTransformError\" style=\"" . - "width: {$this->width}px; height: {$this->height}px;\"><tr><td>" . - $this->htmlMsg . - "</td></tr></table>"; - } - - function toText() { - return $this->textMsg; - } - - function getHtmlMsg() { - return $this->htmlMsg; - } - - function isError() { - return true; - } -} - -/** - * Shortcut class for parameter validation errors - * - * @ingroup Media - */ -class TransformParameterError extends MediaTransformError { - function __construct( $params ) { - parent::__construct( 'thumbnail_error', - max( isset( $params['width'] ) ? $params['width'] : 0, 180 ), - max( isset( $params['height'] ) ? $params['height'] : 0, 180 ), - wfMsg( 'thumbnail_invalid_params' ) ); - } -} |