Cyclone3 Skin

Standard variables

From Cyclone3 Wiki

Globally accessible Cyclone3 variables, that can be used across the whole framework, including (super)modules, type definitions, xsgn files and so on.

Global core

  • $TOM::engine
  • $TOM::P - path to main TOM directory
  • $TOM::H_media - global server media url

Runtime Environment

  • $main::ENV{'REMOTE_ADDR'} - IP of the current user
  • $main::ENV{'REQUEST_URI'} - currently opened URL, including url parameters, i.e. /en/services/hosting?hostingtype=1&active=y
  • $main::ENV{'QUERY_STRING'} - currently opened URL, i.e. /en/services/hosting
  • $main::ENV{'QUERY_STRING_FULL'} - currently opened URL incl. variables, i.e. /en/services/hosting?var=value
  • $main::FORM{} - hash of processed form variables, i.e. $main::FORM{'var'}
  • $main::IAdm
  • $main::ITst
  • $main::USRM{} - hash of user-related data
  • $main::debug
  • $main::time_current - current time in milliseconds

Databases

  • $TOM::DB{'main'}{'name'} - main database name of domain service
  • $App::401::db_name - database name of application 401 (a401 addon)

Language selection

  • $TOM::LNG_autodetect - autodetect language?
  • $TOM::LNG_permanent - send language over everyone URL?
  • $TOM::LNG_permanent_accepted - send permanent language only if is accepted?
  • $tom::lng - accepted language of request
  • $tom::lng_ - request to language
  • $main::FORM{'_lng'} - request to language over GET/POST
  • $main::FORM{'__lng'} - language sended permanently over URL
  • $main::COOKIES{'_lng'} - request to language stored in cookies

Contacts

  • $TOM::contact{'from'} -

User management

  • $main::USRM{'ID_user'} - ID of user (ref TOM.a301_user.ID_user)
  • $main::USRM{'logged'} - current user's status (not boolean!)
  • $main::USRM{'login'} - current user's login name

Sitemap

  • $main::a210{'ID'} - ID of the currently displayed node
  • $main::a210{'name'} - name of the currently displayed node
  • $main::a210{'path_url'} - whole path to the currently displayed node
  • $main::a210{'IDs'}[] - array of path node ID's to the currently displayed node

Actions

  • $main::location - relocate this request to another url
  • $main::stop - stop executing next modules

Domain configuration

  • $tom::Pm - master directory for the current webservice, usually $TOM::P/\!example.tld
  • $tom::Hm - current webservice master url, i.e. example.tld
  • $tom::Hm_www - current webservice master url with prefix, i.e. http://example.tld
  • $tom::Hm_media - master directory media, usually $tom::Hm_www/media
  • $tom::P - main directory of the current webservice, i.e. $TOM::P/\!example.tld/\!subdomain
  • $tom::H - current webservice url, i.e. subdomain.example.tld
  • $tom::H_www - current webservice with prefix, i.e. http://subdomain.example.tld
  • $tom::H_media - main directory for current webservice's media, usually $tom::H_www/media
  • $tom::rewrite_RewriteBase

Module runtime

  • $Tomahawk::mdl_env{} - hash with all system variables specified for the module in servicetype (starting with '-'), i.e. $Tomahawk::mdl_env{'-category'}
  • $env{} - hash with all other specified variables, i.e. $env{'article_cat.ID_entity'}

See Also