File : core/htmlSanitizer/HtmlStringValidationResult.js

/*
Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/

This  program is free software;
you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation;
either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

/*
Changes:
Doc reviewed ...
Tests ...
*/

/* ------------------------------------------------------------------------------------------------------------------------- */
/**
An object returned by the sanitizeToHtmlString function
*/
/* ------------------------------------------------------------------------------------------------------------------------- */

class HtmlStringValidationResult {

    /**
    The validated string
    @type {String}
    */

    #htmlString;

    /**
    An empty string or an error description if the url is invalid
    @type {String}
    */

    #errorsString;

    /**
    The constructor
    @param {String} htmlString The validated string
    @param {String} errorsString An empty string or an error description if the url is invalid
    */

    constructor ( htmlString, errorsString ) {
        Object.freeze ( this );
        this.#htmlString = htmlString;
        this.#errorsString = errorsString;
    }

    /**
    The validated string
    @type {String}
    */

    get htmlString ( ) { return this.#htmlString; }

    /**
    An empty string or an error description if the url is invalid
    @type {String}
    */

    get errorsString ( ) { return this.#errorsString; }
}

export default HtmlStringValidationResult;

/* --- End of file --------------------------------------------------------------------------------------------------------- */


1	/*
2	Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/
3
4	This program is free software;
5	you can redistribute it and/or modify it under the terms of the
6	GNU General Public License as published by the Free Software Foundation;
7	either version 3 of the License, or any later version.
8
9	This program is distributed in the hope that it will be useful,
10	but WITHOUT ANY WARRANTY; without even the implied warranty of
11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12	GNU General Public License for more details.
13
14	You should have received a copy of the GNU General Public License
15	along with this program; if not, write to the Free Software
16	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17	*/
18
19	/*
20	Changes:
21	Doc reviewed ...
22	Tests ...
23	*/
24
25	/* ------------------------------------------------------------------------------------------------------------------------- */
26	/**
27	An object returned by the sanitizeToHtmlString function
28	*/
29	/* ------------------------------------------------------------------------------------------------------------------------- */
30
31	class HtmlStringValidationResult {
32
33	/**
34	The validated string
35	@type {String}
36	*/
37
38	#htmlString;
39
40	/**
41	An empty string or an error description if the url is invalid
42	@type {String}
43	*/
44
45	#errorsString;
46
47	/**
48	The constructor
49	@param {String} htmlString The validated string
50	@param {String} errorsString An empty string or an error description if the url is invalid
51	*/
52
53	constructor ( htmlString, errorsString ) {
54	Object.freeze ( this );
55	this.#htmlString = htmlString;
56	this.#errorsString = errorsString;
57	}
58
59	/**
60	The validated string
61	@type {String}
62	*/
63
64	get htmlString ( ) { return this.#htmlString; }
65
66	/**
67	An empty string or an error description if the url is invalid
68	@type {String}
69	*/
70
71	get errorsString ( ) { return this.#errorsString; }
72	}
73
74	export default HtmlStringValidationResult;
75
76	/* --- End of file --------------------------------------------------------------------------------------------------------- */
77