jquery.metadata.js 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. /*
  2. * Metadata - jQuery plugin for parsing metadata from elements
  3. *
  4. * Copyright (c) 2006 John Resig, Yehuda Katz, J?rn Zaefferer
  5. *
  6. * Dual licensed under the MIT and GPL licenses:
  7. * http://www.opensource.org/licenses/mit-license.php
  8. * http://www.gnu.org/licenses/gpl.html
  9. *
  10. * Revision: $Id: metadata.js 3465 2007-09-23 21:15:52Z joern.zaefferer $
  11. *
  12. */
  13. /**
  14. * Sets the type of metadata to use. Metadata is encoded in JSON, and each property
  15. * in the JSON will become a property of the element itself.
  16. *
  17. * There are three supported types of metadata storage:
  18. *
  19. * attr: Inside an attribute. The name parameter indicates *which* attribute.
  20. *
  21. * class: Inside the class attribute, wrapped in curly braces: { }
  22. *
  23. * elem: Inside a child element (e.g. a script tag). The
  24. * name parameter indicates *which* element.
  25. *
  26. * The metadata for an element is loaded the first time the element is accessed via jQuery.
  27. *
  28. * As a result, you can define the metadata type, use $(expr) to load the metadata into the elements
  29. * matched by expr, then redefine the metadata type and run another $(expr) for other elements.
  30. *
  31. * @name $.meta.setType
  32. *
  33. * @example <p id="one" class="some_class {item_id: 1, item_label: 'Label'}">This is a p</p>
  34. * @before $.meta.setType("class")
  35. * @after $("#one").data().item_id == 1; $("#one")[0].item_label == "Label"
  36. * @desc Reads metadata from the class attribute
  37. *
  38. * @example <p id="one" class="some_class" data="{item_id: 1, item_label: 'Label'}">This is a p</p>
  39. * @before $.meta.setType("attr", "data")
  40. * @after $("#one").data().item_id == 1; $("#one")[0].item_label == "Label"
  41. * @desc Reads metadata from a "data" attribute
  42. *
  43. * @example <p id="one" class="some_class"><script>{item_id: 1, item_label: 'Label'}</script>This is a p</p>
  44. * @before $.meta.setType("elem", "script")
  45. * @after $("#one").data().item_id == 1; $("#one")[0].item_label == "Label"
  46. * @desc Reads metadata from a nested script element
  47. *
  48. * @param String type The encoding type
  49. * @param String name The name of the attribute to be used to get metadata (optional)
  50. * @cat Plugins/Metadata
  51. * @descr Sets the type of encoding to be used when loading metadata for the first time
  52. * @type undefined
  53. * @see data()
  54. */
  55. (function($) {
  56. // settings
  57. $.meta = {
  58. type: "class",
  59. name: "metadata",
  60. setType: function(type,name){
  61. this.type = type;
  62. this.name = name;
  63. },
  64. cre: /({.*})/,
  65. single: 'metadata'
  66. };
  67. // reference to original setArray()
  68. var setArray = $.fn.setArray;
  69. // define new setArray()
  70. $.fn.setArray = function(arr){
  71. return setArray.apply( this, arguments ).each(function(){
  72. if ( this.metaDone || this.nodeType == 9 || $.isXMLDoc(this) ) return;
  73. var data = "{}";
  74. if ( $.meta.type == "class" ) {
  75. var m = $.meta.cre.exec( this.className );
  76. if ( m )
  77. data = m[1];
  78. } else if ( $.meta.type == "elem" ) {
  79. if( !this.getElementsByTagName ) return;
  80. var e = this.getElementsByTagName($.meta.name);
  81. if ( e.length )
  82. data = $.trim(e[0].innerHTML);
  83. } else if ( this.getAttribute != undefined ) {
  84. var attr = this.getAttribute( $.meta.name );
  85. if ( attr )
  86. data = attr;
  87. }
  88. if ( !/^{/.test( data ) )
  89. data = "{" + data + "}";
  90. eval("data = " + data);
  91. if ( $.meta.single )
  92. this[ $.meta.single ] = data;
  93. else
  94. $.extend( this, data );
  95. this.metaDone = true;
  96. });
  97. };
  98. /**
  99. * Returns the metadata object for the first member of the jQuery object.
  100. *
  101. * @name data
  102. * @descr Returns element's metadata object
  103. * @type jQuery
  104. * @cat Plugins/Metadata
  105. */
  106. $.fn.data = function() {
  107. return this[0][$.meta.single];
  108. };
  109. })(jQuery);