class DefaultTemplate in MediaFront 7

Copyright (c) 2010 Alethia Inc, http://www.alethia-inc.com Developed by Travis Tidwell | travist at alethia-inc.com

License: GPL version 3.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Hierarchy

• class \OSMTemplate
  • class \DefaultTemplate

File

players/osmplayer/player/templates/default/template.php, line 28

class DefaultTemplate extends OSMTemplate {

  /**
   * Return's this templates settings.  This function is used to tell the Open Standard Media Player class
   * about your template.
   */
  public function getSettings() {
    return array(
      /**
       * Boolean variable to tell this template if you are using theme roller.  This will basically
       * generate new CSS files so that multiple themes on the same page will not collide with each
       * other.
       */
      'generateCSS' => TRUE,
      /**
       * The template specific JavaScript files required for this template.
       */
      'jsFiles' => array(
        /**
         * The release template JavaScript file(s).  Usually a compressed version of the debug version.
         */
        'release' => array(
          'templates/default/jquery.media.template.default.compressed.js',
        ),
        /**
         * The debug template JavaScript file(s) ( uncompressed ).
         */
        'debug' => array(
          'templates/default/jquery.media.template.default.js',
        ),
      ),
      /**
       * The CSS files used for this template.
       */
      'cssFiles' => array(
        'theme' => $this
          ->getThemeRollerCSS(),
        'template' => 'templates/default/osmplayer_default.css',
        'template_ie' => 'templates/default/osmplayer_default_ie.css',
      ),
      /**
       * The ID's for this template.  This is used to map certain HTML elements
       * of your template to the functionality behind the Open Standard Media Player.
       */
      'ids' => array(
        'loading' => '#mediaplayerloading',
        'player' => '#mediaplayer',
        'menu' => '#mediamenu',
        'titleBar' => '#mediatitlebar',
        'node' => '#medianode',
        'playlist' => '#mediaplaylist',
        'currentTime' => '#mediacurrenttime',
        'totalTime' => '#mediatotaltime',
        'playPause' => '#mediaplaypause',
        'seekUpdate' => '#mediaseekupdate',
        'seekProgress' => '#mediaseekprogress',
        'seekBar' => '#mediaseekbar',
        'seekHandle' => '#mediaseekhandle',
        'volumeUpdate' => '#mediavolumeupdate',
        'volumeBar' => '#mediavolumebar',
        'volumeHandle' => '#mediavolumehandle',
        'mute' => '#mediamute',
        'linkText' => '#medialinktext',
        'linkScroll' => '#medialinkscroll',
        'close' => '#mediamenuclose',
        'embed' => '#mediaembed',
        'elink' => '#mediaelink',
        'email' => '#mediaemail',
        'busy' => '#mediabusy',
        'preview' => '#mediapreview',
        'play' => '#mediaplay',
        'media' => '#mediadisplay',
        'control' => '#mediacontrol',
        'voter' => '#mediavoter',
        'uservoter' => '#mediauservoter',
        'mediaRegion' => '#mediaregion',
        'field' => '.mediafield',
        'prev' => '#mediaprev',
        'next' => '#medianext',
        'loadPrev' => '#medialoadprev',
        'loadNext' => '#medialoadnext',
        'prevPage' => '#mediaprevpage',
        'nextPage' => '#medianextpage',
        'pager' => '#mediapager',
        'scroll' => '#mediascroll',
        'busy' => '#mediabusy',
        'links' => '#medialinks',
        'listMask' => '#medialistmask',
        'list' => '#medialist',
        'scrollWrapper' => '#mediascrollbarwrapper',
        'scrollBar' => '#mediascrollbar',
        'scrollTrack' => '#mediascrolltrack',
        'scrollHandle' => '#mediascrollhandle',
        'scrollUp' => '#mediascrollup',
        'scrollDown' => '#mediascrolldown',
        'titleLinks' => '#mediatitlelinks',
      ),
    );
  }

  /**
   * A theme preprocess function for the main player.
   */
  public function theme_preprocess(&$variables) {
    $variables['templates']['teaservoter'] = $this
      ->theme($variables, '_teaservoter');
    $variables['templates']['voter'] = $this
      ->theme($variables, '_nodevoter');
    $variables['templates']['controlBar'] = $this
      ->theme($variables, '_controlbar');
    $variables['templates']['titlebar'] = $this
      ->theme($variables, '_titlebar');
    $variables['templates']['menu'] = $this
      ->theme($variables, '_menu');
    $variables['templates']['node'] = $this
      ->theme($variables, '_node');
    $variables['templates']['teaser'] = $this
      ->theme($variables, '_teaser');
    $variables['templates']['scrollBar'] = $this
      ->theme($variables, '_scrollbar');
    $variables['templates']['links'] = $variables['params']['links'] ? theme($variables, '_links') : '';
    $variables['templates']['pager'] = $this
      ->theme($variables, '_pager');
    $variables['templates']['playlist'] = $this
      ->theme($variables, '_playlist');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultTemplate::getSettings	public	function	Return's this templates settings. This function is used to tell the Open Standard Media Player class about your template. Overrides OSMTemplate::getSettings
DefaultTemplate::theme_preprocess	public	function	A theme preprocess function for the main player.
OSMTemplate::$css_dir	private	property
OSMTemplate::$defaultIds	public	property
OSMTemplate::$playerSettings	protected	property
OSMTemplate::$prefix	private	property
OSMTemplate::$settings	public	property
OSMTemplate::$version	private	property
OSMTemplate::createCSS	public	function	Create the CSS files for this media player. This will dynamically rename all the id's and class names within the master CSS files ( theme and template ), and then create a cached version of them within the css folder.
OSMTemplate::deleteCSS	public	function	Delete the current cached CSS files.
OSMTemplate::getCSSFiles	public	function	Get an array of the CSS files for this player.
OSMTemplate::getCSSHeader	public	function	Get the CSS header for this player.
OSMTemplate::getIds	public	function	Returns the id's for this template.
OSMTemplate::getThemeRollerCSS	public	function	Returns the CSS file that is located within the current theme.
OSMTemplate::getVersion	public	function	Get's the player version number.
OSMTemplate::resetCSS	public	function	Resets all generated CSS files.
OSMTemplate::setCSSDir	public	function	Set the CSS directory for this media player.
OSMTemplate::setPrefix	public	function	Set's the prefix of the template.
OSMTemplate::theme	public	function	Theme function for the base template class.
OSMTemplate::writeCSS	private	function	Writes the contents of one CSS file to another, but also replaces all the id's and class names to take into account the prefix ( id ) of the media player.
OSMTemplate::__construct	public	function	Constructor for the OSMTempalate class.