8 * Base class for the output of MediaHandler::doTransform() and File::transform().
12 abstract class MediaTransformOutput
{
13 var $file, $width, $height, $url, $page, $path;
16 * Get the width of the output box
23 * Get the height of the output box
25 function getHeight() {
30 * @return string The thumbnail URL
37 * @return String: destination file path (local filesystem)
44 * Fetch HTML for this transform output
46 * @param $options Associative array of options. Boolean options
47 * should be indicated with a value of true for true, and false or
50 * alt Alternate text or caption
51 * desc-link Boolean, show a description link
52 * file-link Boolean, show a file download link
53 * custom-url-link Custom URL to link to
54 * custom-title-link Custom Title object to link to
55 * valign vertical-align property, if the output is an inline element
56 * img-class Class applied to the <img> tag, if there is such a tag
58 * For images, desc-link and file-link are implemented as a click-through. For
59 * sounds and videos, they may be displayed in other ways.
63 abstract function toHtml( $options = array() );
66 * This will be overridden to return true in error classes
73 * Wrap some XHTML text in an anchor tag with the given attributes
75 protected function linkWrap( $linkAttribs, $contents ) {
77 return Xml
::tags( 'a', $linkAttribs, $contents );
83 function getDescLinkAttribs( $title = null, $params = '' ) {
84 $query = $this->page ?
( 'page=' . urlencode( $this->page
) ) : '';
86 $query .= $query ?
'&'.$params : $params;
89 'href' => $this->file
->getTitle()->getLocalURL( $query ),
93 $attribs['title'] = $title;
101 * Media transform output for images
105 class ThumbnailImage
extends MediaTransformOutput
{
108 * @param $file File object
109 * @param $url String: URL path to the thumb
110 * @param $width Integer: file's width
111 * @param $height Integer: file's height
112 * @param $path String: filesystem path to the thumb
113 * @param $page Integer: page number, for multipage files
116 function ThumbnailImage( $file, $url, $width, $height, $path = false, $page = false ) {
119 # These should be integers when they get here.
120 # If not, there's a bug somewhere. But let's at
121 # least produce valid HTML code regardless.
122 $this->width
= round( $width );
123 $this->height
= round( $height );
129 * Return HTML <img ... /> tag for the thumbnail, will include
130 * width and height attributes and a blank alt text (as required).
132 * @param $options Associative array of options. Boolean options
133 * should be indicated with a value of true for true, and false or
136 * alt HTML alt attribute
137 * title HTML title attribute
138 * desc-link Boolean, show a description link
139 * file-link Boolean, show a file download link
140 * valign vertical-align property, if the output is an inline element
141 * img-class Class applied to the \<img\> tag, if there is such a tag
142 * desc-query String, description link query params
143 * custom-url-link Custom URL to link to
144 * custom-title-link Custom Title object to link to
146 * For images, desc-link and file-link are implemented as a click-through. For
147 * sounds and videos, they may be displayed in other ways.
151 function toHtml( $options = array() ) {
152 if ( count( func_get_args() ) == 2 ) {
153 throw new MWException( __METHOD__
.' called in the old style' );
156 $alt = empty( $options['alt'] ) ?
'' : $options['alt'];
158 $query = empty( $options['desc-query'] ) ?
'' : $options['desc-query'];
160 if ( !empty( $options['custom-url-link'] ) ) {
161 $linkAttribs = array( 'href' => $options['custom-url-link'] );
162 if ( !empty( $options['title'] ) ) {
163 $linkAttribs['title'] = $options['title'];
165 } elseif ( !empty( $options['custom-title-link'] ) ) {
166 $title = $options['custom-title-link'];
167 $linkAttribs = array(
168 'href' => $title->getLinkUrl(),
169 'title' => empty( $options['title'] ) ?
$title->getFullText() : $options['title']
171 } elseif ( !empty( $options['desc-link'] ) ) {
172 $linkAttribs = $this->getDescLinkAttribs( empty( $options['title'] ) ?
null : $options['title'], $query );
173 } elseif ( !empty( $options['file-link'] ) ) {
174 $linkAttribs = array( 'href' => $this->file
->getURL() );
176 $linkAttribs = false;
182 'width' => $this->width
,
183 'height' => $this->height
,
185 if ( !empty( $options['valign'] ) ) {
186 $attribs['style'] = "vertical-align: {$options['valign']}";
188 if ( !empty( $options['img-class'] ) ) {
189 $attribs['class'] = $options['img-class'];
191 return $this->linkWrap( $linkAttribs, Xml
::element( 'img', $attribs ) );
197 * Basic media transform error class
201 class MediaTransformError
extends MediaTransformOutput
{
202 var $htmlMsg, $textMsg, $width, $height, $url, $path;
204 function __construct( $msg, $width, $height /*, ... */ ) {
205 $args = array_slice( func_get_args(), 3 );
206 $htmlArgs = array_map( 'htmlspecialchars', $args );
207 $htmlArgs = array_map( 'nl2br', $htmlArgs );
209 $this->htmlMsg
= wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $msg, true ) ), $htmlArgs );
210 $this->textMsg
= wfMsgReal( $msg, $args );
211 $this->width
= intval( $width );
212 $this->height
= intval( $height );
217 function toHtml( $options = array() ) {
218 return "<div class=\"MediaTransformError\" style=\"" .
219 "width: {$this->width}px; height: {$this->height}px; display:inline-block;\">" .
225 return $this->textMsg
;
228 function getHtmlMsg() {
229 return $this->htmlMsg
;
238 * Shortcut class for parameter validation errors
242 class TransformParameterError
extends MediaTransformError
{
243 function __construct( $params ) {
244 parent
::__construct( 'thumbnail_error',
245 max( isset( $params['width'] ) ?
$params['width'] : 0, 120 ),
246 max( isset( $params['height'] ) ?
$params['height'] : 0, 120 ),
247 wfMsg( 'thumbnail_invalid_params' ) );