File: template.js

package info (click to toggle)
ckeditor 4.16.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 258,804 kB
  • sloc: javascript: 239,590; sh: 184; makefile: 64; python: 37; php: 15; xml: 5
file content (69 lines) | stat: -rw-r--r-- 2,719 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/**
 * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
 */

/**
 * @fileOverview Defines the {@link CKEDITOR.template} class, which represents
 * an UI template for an editor instance.
 */

( function() {
	var rePlaceholder = /{([^}]+)}/g;

	/**
	 * Lightweight template used to build the output string from variables.
	 *
	 *		// HTML template for presenting a label UI.
	 *		var tpl = new CKEDITOR.template( '<div class="{cls}">{label}</div>' );
	 *		alert( tpl.output( { cls: 'cke-label', label: 'foo'} ) ); // '<div class="cke-label">foo</div>'
	 *
	 *		// Since 4.12.0 it is possible to pass a callback function that returns a template.
	 *		var tpl2 = new CKEDITOR.template( function( data ) {
	 *			return data.image ? '<img src="{image}" alt="{label}"/>' : '{label}';
	 *		} );
	 *		alert( tpl2.output( { image: null, label: 'foo'} ) ); // 'foo'
	 *		alert( tpl2.output( { image: '/some-image.jpg', label: 'foo'} ) ); // <img src="/some-image.jpg" alt="foo"/>
	 *
	 * @class
	 * @constructor Creates a template class instance.
	 * @param {String/Function} source A string with the template source or a callback that will return such string.
	 * The handling of the `Function` type was added in version 4.12.0 .
	 */
	CKEDITOR.template = function( source ) {
		/**
		 * The current template source.
		 *
		 * Note that support for the `Function` type was added in version 4.12.0 .
		 *
		 * @readonly
		 * @member CKEDITOR.template
		 * @property {String/Function} source
		 */
		this.source = typeof source === 'function' ? source : String( source );
	};

	/**
	 * Processes the template, filling its variables with the provided data.
	 *
	 * @method
	 * @member CKEDITOR.template
	 * @param {Object} data An object containing properties whose values will be
	 * used to fill the template variables. The property names must match the
	 * template variables names. Variables without matching properties will be
	 * kept untouched.
	 * @param {Array} [buffer] An array that the output data will be pushed into.
	 * The number of entries appended to the array is unknown.
	 * @returns {String/Number} If `buffer` has not been provided, the processed
	 * template output data; otherwise the new length of `buffer`.
	 */
	CKEDITOR.template.prototype.output = function( data, buffer ) {

		var template = typeof this.source === 'function' ? this.source( data ) : this.source,
			output = template.replace( rePlaceholder, function( fullMatch, dataKey ) {
				return data[ dataKey ] !== undefined ? data[ dataKey ] : fullMatch;
			} );

		return buffer ? buffer.push( output ) : output;
	};
} )();