This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
public:tellmaps_url_and_seo [2014/05/05 06:20] honzik |
public:tellmaps_url_and_seo [2014/05/05 07:27] (current) honzik |
||
---|---|---|---|
Line 81: | Line 81: | ||
* - debug - boolean - provide console.log outputs on various operations of this registerURI block | * - debug - boolean - provide console.log outputs on various operations of this registerURI block | ||
* @return none | * @return none | ||
+ | * | ||
+ | * notes: | ||
+ | * - all callbacks have "this" set which can access the following: | ||
+ | * getHash(), getParams(), getParamString(), getPath() | ||
+ | * please do not use their "set" counterparts directly. | ||
**/ | **/ | ||
function registerUri( settings ) { | function registerUri( settings ) { | ||
Line 92: | Line 97: | ||
* function will be called on URI parse failed | * function will be called on URI parse failed | ||
* @return none | * @return none | ||
+ | * | ||
+ | * notes: | ||
+ | * - callback has "this" set which can access the following: | ||
+ | * getHash(), getParams(), getParamString(), getPath() | ||
+ | * please do not use their "set" counterparts directly. | ||
**/ | **/ | ||
function onUriFail( callback ) { | function onUriFail( callback ) { | ||
Line 97: | Line 107: | ||
/** | /** | ||
- | * Manual call to path change | + | * Get proper URI string to be used in parts of the app |
* @param path - string, path component part | * @param path - string, path component part | ||
* @param get_params - get param collection in the form of { param_name : param_value } | * @param get_params - get param collection in the form of { param_name : param_value } | ||
* @param local_hash - string, local hash part | * @param local_hash - string, local hash part | ||
- | * @return true/false on success / fail | + | * @return string final string |
**/ | **/ | ||
- | function changeUri( path, get_params, local_hash ) { | + | function getUriString( path, get_params, local_hash ) { |
... | ... | ||
- | /** | ||
- | * Manual call to path-only change, get_params and local_hash remains the same | ||
- | * @param path - string, path component part | ||
- | * @return true/false on success / fail | ||
- | **/ | ||
- | function changeUriPath( path ) { | ||
- | ... | ||
- | |||
- | /** | ||
- | * Manual call to params-only change, path and local_hash remains the same | ||
- | * @param get_params - get param collection in the form of { param_name : param_value } | ||
- | * @return true/false on success / fail | ||
- | **/ | ||
- | function changeUriParams( get_params ) { | ||
- | ... | ||
- | |||
- | /** | ||
- | * Manual call to local_hash-only change, path and params remains the same | ||
- | * @param local_hash - string, local hash part | ||
- | * @return true/false on success / fail | ||
- | **/ | ||
- | function changeUriLocalHash( local_hash ) { | ||
- | ... | ||
</code> | </code> | ||