client/player/development-bundle/external/jquery.metadata.js
author samuel huron <admin@cybunk.com>
Mon, 14 Jun 2010 15:18:58 +0200
changeset 39 b620041cc891
parent 1 436d4791d7ac
permissions -rw-r--r--
update to augmented player (manage streamer)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     1
/*
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     2
 * Metadata - jQuery plugin for parsing metadata from elements
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     3
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     4
 * Copyright (c) 2006 John Resig, Yehuda Katz, J�örn Zaefferer, Paul McLanahan
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     5
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     6
 * Dual licensed under the MIT and GPL licenses:
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     7
 *   http://www.opensource.org/licenses/mit-license.php
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     8
 *   http://www.gnu.org/licenses/gpl.html
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
     9
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    10
 * Revision: $Id: jquery.metadata.js 4187 2007-12-16 17:15:27Z joern.zaefferer $
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    11
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    12
 */
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    13
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    14
/**
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    15
 * Sets the type of metadata to use. Metadata is encoded in JSON, and each property
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    16
 * in the JSON will become a property of the element itself.
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    17
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    18
 * There are three supported types of metadata storage:
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    19
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    20
 *   attr:  Inside an attribute. The name parameter indicates *which* attribute.
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    21
 *          
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    22
 *   class: Inside the class attribute, wrapped in curly braces: { }
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    23
 *   
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    24
 *   elem:  Inside a child element (e.g. a script tag). The
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    25
 *          name parameter indicates *which* element.
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    26
 *          
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    27
 * The metadata for an element is loaded the first time the element is accessed via jQuery.
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    28
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    29
 * As a result, you can define the metadata type, use $(expr) to load the metadata into the elements
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    30
 * matched by expr, then redefine the metadata type and run another $(expr) for other elements.
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    31
 * 
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    32
 * @name $.metadata.setType
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    33
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    34
 * @example <p id="one" class="some_class {item_id: 1, item_label: 'Label'}">This is a p</p>
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    35
 * @before $.metadata.setType("class")
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    36
 * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    37
 * @desc Reads metadata from the class attribute
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    38
 * 
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    39
 * @example <p id="one" class="some_class" data="{item_id: 1, item_label: 'Label'}">This is a p</p>
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    40
 * @before $.metadata.setType("attr", "data")
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    41
 * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    42
 * @desc Reads metadata from a "data" attribute
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    43
 * 
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    44
 * @example <p id="one" class="some_class"><script>{item_id: 1, item_label: 'Label'}</script>This is a p</p>
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    45
 * @before $.metadata.setType("elem", "script")
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    46
 * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    47
 * @desc Reads metadata from a nested script element
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    48
 * 
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    49
 * @param String type The encoding type
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    50
 * @param String name The name of the attribute to be used to get metadata (optional)
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    51
 * @cat Plugins/Metadata
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    52
 * @descr Sets the type of encoding to be used when loading metadata for the first time
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    53
 * @type undefined
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    54
 * @see metadata()
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    55
 */
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    56
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    57
(function($) {
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    58
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    59
$.extend({
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    60
	metadata : {
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    61
		defaults : {
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    62
			type: 'class',
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    63
			name: 'metadata',
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    64
			cre: /({.*})/,
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    65
			single: 'metadata'
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    66
		},
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    67
		setType: function( type, name ){
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    68
			this.defaults.type = type;
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    69
			this.defaults.name = name;
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    70
		},
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    71
		get: function( elem, opts ){
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    72
			var settings = $.extend({},this.defaults,opts);
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    73
			// check for empty string in single property
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    74
			if ( !settings.single.length ) settings.single = 'metadata';
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    75
			
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    76
			var data = $.data(elem, settings.single);
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    77
			// returned cached data if it already exists
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    78
			if ( data ) return data;
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    79
			
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    80
			data = "{}";
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    81
			
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    82
			if ( settings.type == "class" ) {
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    83
				var m = settings.cre.exec( elem.className );
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    84
				if ( m )
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    85
					data = m[1];
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    86
			} else if ( settings.type == "elem" ) {
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    87
				if( !elem.getElementsByTagName )
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    88
					return undefined;
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    89
				var e = elem.getElementsByTagName(settings.name);
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    90
				if ( e.length )
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    91
					data = $.trim(e[0].innerHTML);
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    92
			} else if ( elem.getAttribute != undefined ) {
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    93
				var attr = elem.getAttribute( settings.name );
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    94
				if ( attr )
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    95
					data = attr;
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    96
			}
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    97
			
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    98
			if ( data.indexOf( '{' ) <0 )
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
    99
			data = "{" + data + "}";
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   100
			
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   101
			data = eval("(" + data + ")");
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   102
			
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   103
			$.data( elem, settings.single, data );
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   104
			return data;
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   105
		}
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   106
	}
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   107
});
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   108
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   109
/**
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   110
 * Returns the metadata object for the first member of the jQuery object.
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   111
 *
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   112
 * @name metadata
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   113
 * @descr Returns element's metadata object
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   114
 * @param Object opts An object contianing settings to override the defaults
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   115
 * @type jQuery
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   116
 * @cat Plugins/Metadata
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   117
 */
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   118
$.fn.metadata = function( opts ){
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   119
	return $.metadata.get( this[0], opts );
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   120
};
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   121
436d4791d7ac premier version du player test de commit
hurons
parents:
diff changeset
   122
})(jQuery);