popsu-d7/sites/all/modules/media_youtube/includes/media_youtube.variables.inc
Bachir Soussi Chiadmi 1bc61b12ad first import
2015-04-08 11:40:19 +02:00

142 lines
4.0 KiB
PHP

<?php
/**
* @file media_youtube/includes/media_youtube.variables.inc
* Variable defaults for Media: YouTube.
*/
/**
* Define our constants.
*/
/**
* This is the variable namespace, automatically prepended to module variables.
*/
define('MEDIA_YOUTUBE_NAMESPACE', 'media_youtube__');
/**
* Wrapper for variable_get() using the Media: YouTube variable registry.
*
* @param string $name
* The variable name to retrieve. Note that it will be namespaced by
* pre-pending MEDIA_YOUTUBE_NAMESPACE, as to avoid variable collisions
* with other modules.
* @param unknown $default
* An optional default variable to return if the variable hasn't been set
* yet. Note that within this module, all variables should already be set
* in the media_youtube_variable_default() function.
* @return unknown
* Returns the stored variable or its default.
*
* @see media_youtube_variable_set()
* @see media_youtube_variable_del()
* @see media_youtube_variable_default()
*/
function media_youtube_variable_get($name, $default = NULL) {
// Allow for an override of the default.
// Useful when a variable is required (like $path), but namespacing is still
// desired.
if (!isset($default)) {
$default = media_youtube_variable_default($name);
}
// Namespace all variables.
$variable_name = MEDIA_YOUTUBE_NAMESPACE . $name;
return variable_get($variable_name, $default);
}
/**
* Wrapper for variable_set() using the Media: YouTube variable registry.
*
* @param string $name
* The variable name to set. Note that it will be namespaced by
* pre-pending MEDIA_YOUTUBE_NAMESPACE, as to avoid variable collisions with
* other modules.
* @param unknown $value
* The value for which to set the variable.
* @return unknown
* Returns the stored variable after setting.
*
* @see media_youtube_variable_get()
* @see media_youtube_variable_del()
* @see media_youtube_variable_default()
*/
function media_youtube_variable_set($name, $value) {
$variable_name = MEDIA_YOUTUBE_NAMESPACE . $name;
return variable_set($variable_name, $value);
}
/**
* Wrapper for variable_del() using the Media: YouTube variable registry.
*
* @param string $name
* The variable name to delete. Note that it will be namespaced by
* pre-pending MEDIA_YOUTUBE_NAMESPACE, as to avoid variable collisions with
* other modules.
*
* @see media_youtube_variable_get()
* @see media_youtube_variable_set()
* @see media_youtube_variable_default()
*/
function media_youtube_variable_del($name) {
$variable_name = MEDIA_YOUTUBE_NAMESPACE . $name;
variable_del($variable_name);
}
/**
* The default variables within the Media: YouTube namespace.
*
* @param string $name
* Optional variable name to retrieve the default. Note that it has not yet
* been pre-pended with the MEDIA_YOUTUBE_NAMESPACE namespace at this time.
* @return unknown
* The default value of this variable, if it's been set, or NULL, unless
* $name is NULL, in which case we return an array of all default values.
*
* @see media_youtube_variable_get()
* @see media_youtube_variable_set()
* @see media_youtube_variable_del()
*/
function media_youtube_variable_default($name = NULL) {
static $defaults;
if (!isset($defaults)) {
$defaults = array(
'width' => 560,
'height' =>340,
'autoplay' => FALSE,
'related' => TRUE,
'hd' => FALSE,
'showsearch' => TRUE,
'modestbranding' => FALSE,
'showinfo'=> TRUE,
'version' => 3,
'theme' => 'dark',
'fullscreen' => TRUE,
'wmode' => 'transparent',
'chromeless' => FALSE,
'preview_uri' => 'youtube://v/-jubiv7QUco',
);
}
if (!isset($name)) {
return $defaults;
}
if (isset($defaults[$name])) {
return $defaults[$name];
}
}
/**
* Return the fully namespace variable name.
*
* @param string $name
* The variable name to retrieve the namespaced name.
* @return string
* The fully namespace variable name, prepended with
* MEDIA_YOUTUBE_NAMESPACE.
*/
function media_youtube_variable_name($name) {
return MEDIA_YOUTUBE_NAMESPACE . $name;
}