root / tei / js / jquery.metadata.js @ 2
Historique | Voir | Annoter | Télécharger (3,9 ko)
1 | 2 | mingarao | /*******************************************************************************
|
---|---|---|---|
2 | 2 | mingarao | jquery.mb.components
|
3 | 2 | mingarao | Copyright (c) 2001-2010. Matteo Bicocchi (Pupunzi); Open lab srl, Firenze - Italy
|
4 | 2 | mingarao | email: mbicocchi@open-lab.com
|
5 | 2 | mingarao | site: http://pupunzi.com
|
6 | 2 | mingarao | |
7 | 2 | mingarao | Licences: MIT, GPL
|
8 | 2 | mingarao | http://www.opensource.org/licenses/mit-license.php
|
9 | 2 | mingarao | http://www.gnu.org/licenses/gpl.html
|
10 | 2 | mingarao | ******************************************************************************/
|
11 | 2 | mingarao | |
12 | 2 | mingarao | /**
|
13 | 2 | mingarao | * Sets the type of metadata to use. Metadata is encoded in JSON, and each property
|
14 | 2 | mingarao | * in the JSON will become a property of the element itself.
|
15 | 2 | mingarao | *
|
16 | 2 | mingarao | * There are three supported types of metadata storage:
|
17 | 2 | mingarao | *
|
18 | 2 | mingarao | * attr: Inside an attribute. The name parameter indicates *which* attribute.
|
19 | 2 | mingarao | *
|
20 | 2 | mingarao | * class: Inside the class attribute, wrapped in curly braces: { }
|
21 | 2 | mingarao | *
|
22 | 2 | mingarao | * elem: Inside a child element (e.g. a script tag). The
|
23 | 2 | mingarao | * name parameter indicates *which* element.
|
24 | 2 | mingarao | *
|
25 | 2 | mingarao | * The metadata for an element is loaded the first time the element is accessed via jQuery.
|
26 | 2 | mingarao | *
|
27 | 2 | mingarao | * As a result, you can define the metadata type, use $(expr) to load the metadata into the elements
|
28 | 2 | mingarao | * matched by expr, then redefine the metadata type and run another $(expr) for other elements.
|
29 | 2 | mingarao | *
|
30 | 2 | mingarao | * @name $.metadata.setType
|
31 | 2 | mingarao | *
|
32 | 2 | mingarao | * @example <p id="one" class="some_class {item_id: 1, item_label: 'Label'}">This is a p</p>
|
33 | 2 | mingarao | * @before $.metadata.setType("class")
|
34 | 2 | mingarao | * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
|
35 | 2 | mingarao | * @desc Reads metadata from the class attribute
|
36 | 2 | mingarao | *
|
37 | 2 | mingarao | * @example <p id="one" class="some_class" data="{item_id: 1, item_label: 'Label'}">This is a p</p>
|
38 | 2 | mingarao | * @before $.metadata.setType("attr", "data")
|
39 | 2 | mingarao | * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
|
40 | 2 | mingarao | * @desc Reads metadata from a "data" attribute
|
41 | 2 | mingarao | *
|
42 | 2 | mingarao | * @example <p id="one" class="some_class"><script>{item_id: 1, item_label: 'Label'}</script>This is a p</p>
|
43 | 2 | mingarao | * @before $.metadata.setType("elem", "script")
|
44 | 2 | mingarao | * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
|
45 | 2 | mingarao | * @desc Reads metadata from a nested script element
|
46 | 2 | mingarao | *
|
47 | 2 | mingarao | * @param String type The encoding type
|
48 | 2 | mingarao | * @param String name The name of the attribute to be used to get metadata (optional)
|
49 | 2 | mingarao | * @cat Plugins/Metadata
|
50 | 2 | mingarao | * @descr Sets the type of encoding to be used when loading metadata for the first time
|
51 | 2 | mingarao | * @type undefined
|
52 | 2 | mingarao | * @see metadata()
|
53 | 2 | mingarao | */
|
54 | 2 | mingarao | |
55 | 2 | mingarao | (function($) { |
56 | 2 | mingarao | |
57 | 2 | mingarao | $.extend({
|
58 | 2 | mingarao | metadata : {
|
59 | 2 | mingarao | defaults : {
|
60 | 2 | mingarao | type: 'class', |
61 | 2 | mingarao | name: 'metadata', |
62 | 2 | mingarao | cre: /({.*})/, |
63 | 2 | mingarao | single: 'metadata' |
64 | 2 | mingarao | }, |
65 | 2 | mingarao | setType: function( type, name ){ |
66 | 2 | mingarao | this.defaults.type = type;
|
67 | 2 | mingarao | this.defaults.name = name;
|
68 | 2 | mingarao | }, |
69 | 2 | mingarao | get: function( elem, opts ){ |
70 | 2 | mingarao | var settings = $.extend({},this.defaults,opts); |
71 | 2 | mingarao | // check for empty string in single property
|
72 | 2 | mingarao | if ( !settings.single.length ) settings.single = 'metadata'; |
73 | 2 | mingarao | |
74 | 2 | mingarao | var data = $.data(elem, settings.single); |
75 | 2 | mingarao | // returned cached data if it already exists
|
76 | 2 | mingarao | if ( data ) return data; |
77 | 2 | mingarao | |
78 | 2 | mingarao | data = "{}";
|
79 | 2 | mingarao | |
80 | 2 | mingarao | if ( settings.type == "class" ) { |
81 | 2 | mingarao | var m = settings.cre.exec( elem.className );
|
82 | 2 | mingarao | if ( m )
|
83 | 2 | mingarao | data = m[1];
|
84 | 2 | mingarao | } else if ( settings.type == "elem" ) { |
85 | 2 | mingarao | if( !elem.getElementsByTagName )
|
86 | 2 | mingarao | return undefined; |
87 | 2 | mingarao | var e = elem.getElementsByTagName(settings.name);
|
88 | 2 | mingarao | if ( e.length )
|
89 | 2 | mingarao | data = $.trim(e[0].innerHTML); |
90 | 2 | mingarao | } else if ( elem.getAttribute != undefined ) { |
91 | 2 | mingarao | var attr = elem.getAttribute( settings.name );
|
92 | 2 | mingarao | if ( attr )
|
93 | 2 | mingarao | data = attr; |
94 | 2 | mingarao | } |
95 | 2 | mingarao | |
96 | 2 | mingarao | if ( data.indexOf( '{' ) <0 ) |
97 | 2 | mingarao | data = "{" + data + "}"; |
98 | 2 | mingarao | |
99 | 2 | mingarao | data = eval("(" + data + ")"); |
100 | 2 | mingarao | |
101 | 2 | mingarao | $.data( elem, settings.single, data );
|
102 | 2 | mingarao | return data;
|
103 | 2 | mingarao | } |
104 | 2 | mingarao | } |
105 | 2 | mingarao | }); |
106 | 2 | mingarao | |
107 | 2 | mingarao | /**
|
108 | 2 | mingarao | * Returns the metadata object for the first member of the jQuery object.
|
109 | 2 | mingarao | *
|
110 | 2 | mingarao | * @name metadata
|
111 | 2 | mingarao | * @descr Returns element's metadata object
|
112 | 2 | mingarao | * @param Object opts An object contianing settings to override the defaults
|
113 | 2 | mingarao | * @type jQuery
|
114 | 2 | mingarao | * @cat Plugins/Metadata
|
115 | 2 | mingarao | */
|
116 | 2 | mingarao | $.fn.metadata = function( opts ){ |
117 | 2 | mingarao | return $.metadata.get( this[0], opts ); |
118 | 2 | mingarao | }; |
119 | 2 | mingarao | |
120 | 2 | mingarao | })(jQuery); |