This shows you the differences between two versions of the page.
en:public:developer:template_system:tags:url:turlinfos [2014/02/19 13:00] admin [Parameters] |
en:public:developer:template_system:tags:url:turlinfos [2014/02/21 15:33] (current) svanderclock [Constructors] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== <#UrlInfos> ====== | + | ====== <#TUrlInfos> ====== |
- | + | ||
- | Return the infos extracted from the current url | + | |
+ | Return the object containing information related to the current url. These informations are extracted according | ||
+ | to the [[en:public:developer:template_system:urlresources]] rules | ||
===== Parameters ===== | ===== Parameters ===== | ||
- | FIXME Need to update. | + | ^ Name ^ type ^ Description ^ |
+ | | <html><span style="color:#008000">values</span></html> | Any | Return the value of url related variables (see [[en:public:developer:template_system:urlresources]]). | | ||
+ | | <html><span style="color:#008000">contact_id</span></html> | String | Return the contact id extracted from the current url | | ||
+ | | <html><span style="color:#008000">property_id</span></html> | String | Return the property id extracted from the current url | | ||
+ | | <html><span style="color:#008000">propertyrequest_id</span></html> | String | Return the propertyrequest id extracted from the current url | | ||
+ | | <html><span style="color:#008000">pagenumber</span></html> | String | Return the page number extracted from the current url | | ||
+ | | <html><span style="color:#008000">regex_groups</span></html> | [[en:public:developer:template_system:tags:string:TStringList]] | Return the list of regex groups extracted from the current url | | ||
+ | | <html><span style="color:#008000">geoplace</span></html> | [[en:public:developer:template_system:tags:geoplace:tgeoplace]] | Return the [[en:public:developer:template_system:tags:geoplace:tgeoplace|Geoplace]] object related to the current url | | ||
+ | | <html><span style="color:#008000">Property_category</span></html> | String | return the property category extracted from the current url | | ||
+ | | <html><span style="color:#008000">Property_type</span></html> | String | Return the Property type extracted from the current url | | ||
+ | | <html><span style="color:#008000">Property_subtype</span></html> | String | Return the Property subtype extracted from the current url | | ||
+ | | <html><span style="color:#008000">Transaction_type</span></html> | String | Return the Transaction type extracted from the current url | | ||
- | ^ Name ^ type ^ Description ^ | ||
- | | <html><span style="color:#008000">contact_id</span></html> | String | Return the contact id or empty string | | ||
- | | <html><span style="color:#008000">property_id</span></html> | String | Return the property id or empty string | | ||
- | | <html><span style="color:#008000">propertyrequest_id</span></html> | String | Return the propertyrequest id or empty string | | ||
- | | <html><span style="color:#008000">pagenumber</span></html> | String | Return the pagenumber or empty string | | ||
- | | <html><span style="color:#008000">geoplace</span></html> | [[en:public:developer:template_system:tags:geoplace:tgeoplace]] | Return the [[en:public:developer:template_system:tags:geoplace:tgeoplace|Geoplace]] object | | ||
- | | <html><span style="color:#008000">values</span></html> | Any | Return the value of url related variable. (ex. values[var name] will return ) | | ||
===== Constructors ===== | ===== Constructors ===== | ||
^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
- | | create | String | construct a Turlinfos object | | + | | <html><span style="color:#008000">create</span></html> | String | construct a Turlinfos object (named urlinfos) connected to the current url | |
- | You can also create a Turlinfos object (That will be named **urlinfos**) via a call to | + | You can also create a Turlinfos object (That will be named **urlinfos**) via a call to <#urlinfos> |
- | <#urlinfos> | + |