System Class
Username:  
Password:
  > Home
> User Guide
v Reference
    > Introduction
    > CROFT
    v BEE Variables
       v BEE Variable Name
          o General/Object Class
          o Special Class
          o System Class
       o BEE Variable Value
       > BEE Conversions
    > BEE Syntax
    > BEE Commands
    > Database Operation
    > Content Management
    > Objects and Classes
    > Interface with others
    o Glossary
> Portal Object
> Development Guide


Shortcuts
sys Class
debug Class
Intrinsic Conversions
>> Reference >> BEE Variables >> BEE Variable Name >> System Class <=  =>      <  1  2  3  4  5  6  7  8  9  10  11  12  >  
sys System Class

n        sys (mostly read-only) is system data such as authentication attributes and site information.

Variable

Value/meaning

Access

sys%accesslevelnames:0
sys%accesslevelnames:1
sys%accesslevelnames:2
sys%accesslevelnames:3
sys%accesslevelnames:8
sys%accesslevelnames:10

Public: not logged in
Affiliate: authenticated at "friendly" site
Member: logged in
VIP: logged in with privilege
Owner: logged in as the site owner
Admin: administrator login

get

sys%accesslevelnames:Public
sys%accesslevelnames:Affiliate
sys%accesslevelnames:Member
sys%accesslevelnames:VIP
sys%accesslevelnames:Owner
sys%accesslevelnames:Admin

0
1
2
3
8
10

get

sys%auth:username
sys%auth:realm
sys%auth:accesslevel
sys%auth:user

Username logged in
Realm logged in
Access level number
Same as "sys%auth:username"

get
set
(only if AllowSetAuth CROFT Scheme is set

sys%auth:loginname
sys%auth:accesslevelname

username@realm
Access level name

get

sys%auth:attr

User attribute (e.g. Name, Tel)

get
set (but not saved until "auth save")
clear

sys%client:agent
sys%client:ip
sys%client:hostname
sys%client:referrer

Browser type
Client machine IP
Client machine name
Referring page URL

get(no array)

sys%context

The identifier of the current variable context.  This value is useful in passing a local context to other scopes via the "link" command.

get(no array)

sys%croft:owner
sys%croft:service
sys%croft:webserver
sys%croft:webpath
sys%croft:dbid
sys%croft:dbtype
sys%croft:dbhost
sys%croft:dbname
sys%croft:sitedir
sys%croft:wwwdir
sys%croft:filedir
sys%croft:schemedir
sys%croft:textdir
sys%croft:vbdir

Owner Code of the web site
Service Code of the web site
Server Name
Path where the Scope is defined
Database ID
Database Type
Database Host
Database Name
Site Directory
WWW (Web) Directory
File Directory
Scheme Directory
Text Subdirectory (under schemedir)
VB (VirtualBase) Directory

get

sys%default:textfile

The default text-file value for "text name" in the "text" command

get
set

sys%form:name

Value submitted from a form (same as form%name except that form%name can have multiple values)

get
set
clear

sys%header

HTTP Header

set(no array)

sys%ineditor

Return 1 if the page is running in the text editor, or 0 otherwise.

get(no array)

sys%mimetype:file

MIME Content Type of the specified file, or the current page if no file is specified.  (file is in FileDir {sys%croft:filedir}, or a CROFT directories provided the full path is specified.)

set(no array)

sys%output:content
sys%output:length

The content of the output buffer
The current length of the output buffer

get(no array)

sys%random:n

A randomnumber between 1 and n

get(no array)

sys%randomnumber:n

Same as "sys%random:n"

get(no array)

sys%post:data
sys%post:type
sys%post:charset
sys%post:host
sys%post:mimetype
sys%post:contenttype

Data posted
Content Type of the data posted
Character Set of the data posted
Host posted to
Same as "sys%post:type"
Same as "sys%post:type"

get(no array)

sys%password:old
sys%password:new

The old password and new password in a password changing operation.  This is set-only and can only assigned an array with two elements: "old" and "new".

set array only

sys%self

Same as "sys%urlpart:pathpage"

get(no array)

sys%session:id
sys%session:idlesince

The 128-bit Session ID in hexadecimal
The time (in timestamp format) last authentication feature is accessed

get(no array)

sys%session:idletimeout





sys%session:expiry


sys%session:expire

If set to non-zero, in indicates the number of seconds in which the session will be automatically logged out unless an authentication feature (e.g. going into a member only page) is accessed.
The time (in timestamp format) by when the session will be automatically logged out.
Same as "sys%session:expiry"

get(no array)
set(no array)

sys%site:name
sys%site:url

The site name (scheme%SiteName)
The idURL (can be overwritten by scheme%SiteURL)

get(no array)

sys%stdin

The input stream from begin to end

get(no array)

sys%textpagelist

The list of all pages with TEA (Text Edit Area).  This always returns an array of which each item is in path/page format (with no leading '/').  If :element is specified, the result will always be blank.

get-
always array

sys%time:



sys%time:sec
sys%time:second
sys%time:seconds

sys%time:usec
sys%time:microsecond
sys%time:microseconds

sys%time:secusec


sys%time:zoneoffset

The current time in number of second since 1 Jan, 1970 (GMT).  (This is the default for any unrecognised element.)

Same as sys%time:



The "microsecond" (millionth second) part of the system clock.


The "microseconds" since 1 Jan, 1970 (GST).

Time Zone offset in second (e.g. Sydney standard time is GMT+10, the offset is 36000 seconds)

get(no array)


sys%url:server
sys%url:path
sys%url:page
sys%url:full
 
sys%urlssl:server
sys%urlssl:path
sys%urlssl:page
sys%urlssl:full
 
sys%urlpart:server
sys%urlpart:path
sys%urlpart:page
sys%urlpart:pathpage
sys%urlpart:pathpageargs

sys%urlpart:args
sys%urlpart:full

The current URL and its parts:
http://mysite.com

http://mysite.com/sub/dir
http://mysite.com/sub/dir/mypage.htm
http://mysite.com/sub/dir/mypage.htm?
abc=123&xyz=How+are+you
https://mysite.com

https://mysite.com/sub/dir
https://mysite.com/sub/dir/mypage.htm
https://mysite.com/sub/dir/mypage.htm?
abc=123&xyz=How+are+you

mysite.com
/sub/dir
mypage.htm
/sub/dir/mypage.htm
/sub/dir/mypage.htm?
abc=123&xyz=How+are+you
abc=123&xyz=How+are+you
http://mysite.com/sub/dir/mypage.htm?
abc=123&xyz=How+are+you

get(no array)

sys%urlredirect:pathpage
sys%urlredirect:pathpageargs
sys%urlredirect:args

The corresponding values of sys%urlpart for a redirected page (403 or 404 http server redirect)

get(no array)

sys%urlshown:pathpage

sys%urlredirect:pathpage if the page is redirected, or sys%urlpart:pathpage if otherwise.

get(no array)

 

 

Previous Page       Next Page

Accsoft Computer Technology Pty Ltd     ABN: 98 065 617 549
PO Box 892, Epping NSW 1710         Level 1, Epping Office Park, 242 Beecroft Rd, Epping NSW 2121, Australia
Tel: Sydney - (02)98691668     National - 1300-881668         Fax: (02)98691866
© Copyright 2003 Accsoft Computer Technology Pty Ltd