TSrefConditions

From TYPO3Wiki

todo TypoScript-test

TypoScript

General notes:

Values are normally trimmed for whitespaces before comparison.

Comparison elements are case sensitive. Use `PIDinRootline` and not `PIDinRootLine` (see the 'L').

You may combine several conditions with two operators: && (and), || (or)

Alternatively you may use "AND" and "OR" instead of "&&" and "||". The AND operator has always higher precedence over OR. If no operator has been specified, it will default to OR. Examples:

This condition will match if the visitor opens the website with Internet Explorer on Windows (but not on Mac)

[browser = msie] && [system = win]

This will match with either Opera or Netscape browsers

[browser = opera] || [browser = netscape]

This will match with either Internet Explorer or Netscape. In case of Netscape, the version must be above 4.

[browser = msie] || [browser = netscape] && [version => 4]

browser

Syntax:

[browser = browser1,browser2,...]

Values and comparison:

Each value is compared with the ($browsername.$browserversion, eg. "netscape4.72") in a strstr().

So if the value is "netscape" or just "scape" or "net" all netscape browsers will match.

If the value is "netscape4" all netscape 4.xx browsers will match.

If any value in the list matches the current browser, the condition returns true.

Examples:
This will match with netscape and opera-browsers
[browser = netscape, opera]
  page.40 = HTML
  page.40.value = Opera or Netscape!
[global]

version

Syntax:
[version = value1, >value2, =value3, <value4, ...]

Comparison:

values are floating-point numbers with "." as the decimal separator.

The values may be preceeded by three operators:

Example from syntax: "value1"

Examples:
[version=  =4.03]
#This matches with exactly "4.03" browsers 
[global]

[version=  >4][browser= netscape3]
This matches with all 4+ browsers and netscape 3 browsers
[global]

system

Syntax:
[system= system1,system2]

Values and comparison:

Values are strings an a match happens if one of these strings is the first part of the system-identification.

Fx. if the value is "win9" this will match with "win95" and "win98" systems.

Examples:
This will match with windows and mac -systems only
[system= win,mac]

device

Syntax:
[device= device1, device2]

Values and comparison:

Values are strings an a match happens if one of these strings equals the type of device

Examples:
This will match WAP-phones and PDA's
[device= wap, pda]

useragent

Syntax:
[useragent= agent]

Values and comparison:

This is a direct match on the useragent string from getenv(“HTTP_USER_AGENT”)

You have the options of putting a "*" at the beginning and/or end of the value agent thereby matching with this wildcard!

Examples:
If the HTTP_USER_AGENT is "Mozilla/4.0 (compatible; Lotus-Notes/5.0; Windows-NT)" this will match with it:

[useragent = Mozilla/4.0 (compatible; Lotus-Notes/5.0; Windows-NT)]

This will also match with it:

[useragent = *Lotus-Notes*]

... but this will also match with a useragent like this: "Lotus-Notes/4.5 ( Windows-NT )"

A short list of user-agent strings and a proper match:

WAP-agents:

This is some of the known WAP agents:

• ALAV UP/4.0.7
• Alcatel-BE3/1.0 UP/4.0.6c
• AUR PALM WAPPER
• Device V1.12
• EricssonR320/R1A
• fetchpage.cgi/0.53
• Java1.1.8
• Java1.2.2
• m-crawler/1.0 WAP
• Materna-WAPPreview/1.1.3
• MC218 2.0 WAP1.1
• Mitsu/1.1.A
• MOT-CB/0.0.19 UP/4.0.5j
• MOT-CB/0.0.21 UP/4.0.5m
• Nokia-WAP-Toolkit/1.2
• Nokia-WAP-Toolkit/1.3beta
• Nokia7110/1.0 ()
• Nokia7110/1.0 (04.67)
• Nokia7110/1.0 (04.67)
• Nokia7110/1.0 (04.69)
• Nokia7110/1.0 (04.70)
• Nokia7110/1.0 (04.71)
• Nokia7110/1.0 (04.73)
• Nokia7110/1.0 (04.74)
• Nokia7110/1.0 (04.76)
• Nokia7110/1.0 (04.77)
• Nokia7110/1.0 (04.80)
• Nokia7110/1.0 (30.05)
• Nokia7110/1.0
• PLM's WapBrowser
• QWAPPER/1.0
• R380 2.0 WAP1.1
• SIE-IC35/1.0
• SIE-P35/1.0 UP/4.1.2a
• SIE-P35/1.0 UP/4.1.2a
• UP.Browser/3.01-IG01
• UP.Browser/3.01-QC31
• UP.Browser/3.02-MC01
• UP.Browser/3.02-SY01
• UP.Browser/3.1-UPG1
• UP.Browser/4.1.2a-XXXX
• UPG1 UP/4.0.7
• Wapalizer/1.0
• Wapalizer/1.1
• WapIDE-SDK/2.0; (R320s (Arial))
• WAPJAG Virtual WAP
• WAPman Version 1.1 beta:Build W2000020401
• WAPman Version 1.1
• Waptor 1.0
• WapView 0.00
• WapView 0.20371
• WapView 0.28
• WapView 0.37
• WapView 0.46
• WapView 0.47
• WinWAP 2.2 WML 1.1
• wmlb
• YourWap/0.91
• YourWap/1.16
• Zetor

language

Syntax:

[language = lang1, lang2, ...]

Comparison:

The values must be a straight match with the value of getenv(“HTTP_ACCEPT_LANGUAGE”) from PHP. Alternatively, if the value is wrapped in “*” (eg. “*en-us*”) then it will split all languages found in the HTTP_ACCEPT_LANGUAGE string and try to match the value with any of those parts of the string. Such a string normally looks like “de,en-us;q=0.7,en;q=0.3” and “*en-us*” would match with this string.

IP

Syntax:
[IP = ipaddress1, ipaddress2, ...]

Comparison:

The values are compared with the getenv(“REMOTE_ADDR”) from PHP.

You may include "*" instead of one of the parts in values. You may also list the first one, two or three parts and only they will be tested. Examples:

These examples will match any IP-address starting with "123":

[IP = 123.*.*.*]
or
[IP = 123]
This examples will match any IP-address ending with "123" or being "192.168.1.34":
[IP = *.*.*.123][IP = 192.168.1.34]

hostname

Syntax:
[hostname = hostname1, hostname2, ...]

Comparison:

The values are compared with the fully qualiteid hostname of getenv(“REMOTE_ADDR”) retrieved by PHP.

Value is comma-list of domain names to match with. *-wildcard allowed but cannot be part of a string, so it must match the full host name (eg. myhost.*.com => correct, myhost.*domain.com => wrong)

hour

Syntax:
[hour = hour1, >hour2, <hour3, ...]

Comparison:

The values in floating point are compared with the current hour (24-hours-format) of the server.

minute

See "Hour" above. Same syntax!

Syntax:
[minute = ...]

Comparison:

Minute of hour, 0-59

dayofweek

See "Hour" above. Same syntax!

Syntax:
[dayofweek = ...]

Comparison:

Day of week, starting with sunday being 0 and saturday being 6

dayofmonth

See "Hour" above. Same syntax!

Syntax:
[dayofmonth = ...]

Comparison:

Day of month, 1-31

month

See "Hour" above. Same syntax!

Syntax:
[month = ...]

Comparison:

Month, january being 1 and december being 12

usergroup

Syntax:
[usergroup = group1-uid, group2-uid, ...]

Comparison:

The comparison can only return true if the grouplist is not empty (global var "gr_list").

The values must either exists in the grouplist OR the value must be a "*". Example:

#This matches all logins
[usergroup = *]

#This matches logins from users members of groups with uid's 1 and/or 2:
[usergroup = 1,2]

loginUser

Syntax:
[loginUser = fe_users-uid, fe_users-uid, ...]

Comparison:

Matches on the uid of a logged in fe_user. Works like 'usergroup' above including the * wildcard to select ANY user.

#Example:
This matches any login (use this instead of “[usergroup = *]” to match when a user is logged in!):
[loginUser = *]

treeLevel

Syntax:
[treeLevel = levelnumber, levelnumber, ...]

Comparison:

This checks if the last element of the rootLine is at a level corresponding to one of the figures in "treeLevel". Level = 0 is the "root" of a website. Level=1 is the first menuen

Example:
This changes something with the template, if the page viewed is on level either level 0 (basic) or on level 2
[treeLevel = 0,2]

PIDinRootline

Syntax:
[PIDinRootline = pages-uid, pages-uid, ...]

Comparison:

This checks if one of the figures in "treeLevel" is a PID (pages-uid) in the rootline

Example:
This changes something with the template, if the page viewed is or is a subpage to page 34 or page 36
[PIDinRootline = 34,36]

PIDupinRootline

Syntax:
[PIDupinRootline = pages-uid, pages-uid, ...]

Comparison:

Do the same as PIDinRootline, except the current page-uid is excluded from check.

compatVersion

Syntax:
[compatVersion = x.y.z]

Comparison:

Require a minimum compatibility version. This version is not necessary equal with the TYPO3 version, it is a configurable value that can be changed in the Upgrade Wizard of the Install Tool.

“compatVersion” is especially useful if you want to provide new default settings but keep the backwards compatibility for old versions of TYPO3.

globalVar

Syntax:
[globalVar=   var1=value,  var2<value2, var3>value3, ...]

Comparison:

The values in floating point are compared with the global var "var1" from above.

globalString

Syntax:
[globalString =   var1=value,  var2= *value2, var3= *value3*, ...]

Comparison:

This is a direct match on global strings.

You have the options of putting a "*" as a wildcard or using a PCRE style regular expression (must be wrapped in "/") to the value.

Examples:
If the HTTP_HOST is "www.typo3.com" this will match with:
[globalString = HTTP_HOST=www.typo3.com]

This will also match with it:
[globalString = HTTP_HOST= *typo3.com]
... but this will also match with a HTTP_HOST like this: "demo.typo3.com"

IMPORTANT NOTE ON globalVar and globalString:

You can use values from global arrays and objects by deviding the var-name with a "|" (vertical line).

Examples:
The global var $HTTP_POST_VARS["key"]["levels"] would be retrieved by "HTTP_POST_VARS|key|levels"

Also note that it's recommended to program your scripts in compliance with the php.ini-optimized settings. Please see that file (from your distribution) for details.

Caring about this means that you would get values like HTTP_HOST by getenv(), you would retrieve GET/POST values with t3lib_div::GPvar(). Finally a lot of values from the TSFE object are useful. In order to get those values for comparison with “globalVar” and “globalString” conditions, you prefix that varname with either "IENV"/“ENV:” , “GP:”, “TSFE:” or “LIT:” respectively. Still the “|” divider may be used to separate keys in arrays and/or objects. “LIT” means “literal” and the string after “:” is trimmed and returned as the value (without being divided by “|” or anything)

Notice: Using the "IENV:" prefix is highly recommended to get server/environment variables which are system independant. Basically this will call and return the value from t3lib_div::getIndpEnv() function. With "ENV:" you get the raw output from getenv() which is NOT always the same on all systems!

Examples:

This will match with a url like “...&print=1”

[globalVar = GP:print > 0] 

This will match with a remote-addr begining with “192.168.”

[globalString = IENV:REMOTE_ADDR = 192.168.*]

This will match with the page-id being higher than 10:

[globalVar = TSFE:id > 10]

This will match with the pages having the layout field set to “Layout 1”:

[globalVar = TSFE:page|layout = 1]

This will match with the user whose username is “test”:

[globalString = TSFE:fe_user|user|username = test]

If the constant {$constant_to_turnSomethingOn} is “1” then this matches:

[globalVar = LIT:1 = {$constant_to_turnSomethingOn}]

userFunc

Syntax:
[userFunc = user_match(checkLocalIP)]

Comparison:

This call the function “user_match” with the first parameter “checkLocalIP”. You write that function. You decide what it checks. Function result is evaluated as true/false.

Example:
Put this function in your localconf.php file:

function user_match($cmd){
  switch($cmd){
    case "checkLocalIP":
      if (strstr(getenv("REMOTE_ADDR"),"192.168")){
          return true;
      }
    break;
    case "checkSomethingElse":
    // ....
    break;
  }
}

This condition will return true if the remote address contains “192.168” - which is what your function finds out.

[userFunc = user_match(checkLocalIP)]