1 /*global $k*/ 2 3 /** 4 * Creates a new request 5 * 6 * @param {string} url URL 7 * @param {string} method Request method (GET, POST etc.). If undefined, GET is used 8 * @param {object} [queryData] Query data 9 * @throws {$k.exception.InvalidValue} If the URL is invalid 10 * 11 * @class A HTTP request 12 * @extends $k.NetEntity 13 **/ 14 $k.HttpRequest = function(url, method, queryData) { }; 15 16 /** 17 * Returns the cookies as an object. The name of a property is the cookie name, the value a Cookie object 18 * 19 * @function 20 * @returns {$k.Cookie[]} 21 **/ 22 $k.HttpRequest.prototype.cookies = function() { }; 23 24 /** 25 * Returns the query data of the request as an object. 26 * If the request method is GET, then this is equivalent to urlQueryData(). 27 * For other methods it returns application/x-www-form-urlencoded key/value pairs 28 * 29 * @function 30 * @returns {object} 31 * @see $k.HttpRequest#urlQueryData 32 * @see $k.NetEntity#formData 33 **/ 34 $k.HttpRequest.prototype.queryData = function() { }; 35 36 /** 37 * Sets the query data of the URI. 38 * Each property is added as a query parameter (key=value). 39 * If the value of a property is an arry, then a key=value pair is added for each array element. 40 * 41 * @function 42 * @param {object} queryData 43 **/ 44 $k.HttpRequest.prototype.setQueryData = function(queryData) { }; 45 46 /** 47 * Sets the URL 48 * 49 * @function 50 * @param {string} url 51 * @throws {$k.exception.InvalidValue} If the URL is not valid 52 **/ 53 $k.HttpRequest.prototype.setUrl = function(url) { }; 54 55 /** 56 * Returns the full URL 57 * 58 * @function 59 * @returns {string} 60 **/ 61 $k.HttpRequest.prototype.url = function() { }; 62 63 /** 64 * Returns the URL query data of the URI as an object. 65 * Each key=value pair is added as a property. 66 * If a key appears more than once, then the value is an array with all elements 67 * 68 * @function 69 * @returns {object} 70 * @see $k.HttpRequest#queryData 71 **/ 72 $k.HttpRequest.prototype.urlQueryData = function() { }; 73 74