Bring in the config file We need $session_name config.php $version depends on strings.php.

strings.php sets $PHP_SELF.

Set constants

returns true if current php version is at mimimum a.b.c

Called: check_php_version(4,1)

• int $a: a major version number
• int $b: b minor version number
• int $c: c release number

returns true if the current internal SM version is at minimum a.b.c These are plain integer comparisons, as our internal version is constructed by us, as an array of 3 ints.

Called: check_sm_version(1,3,3)

• int $a: a major version number
• int $b: b minor version number
• int $c: c release number

Determine if there are lines in a file longer than a given length

• return: TRUE as explained above, otherwise, (no long lines found) FALSE is returned.

• string $filename: The full file path of the file to inspect
• int $max_length: If any lines in the file are GREATER THAN this number, this function returns TRUE.

Detect whether or not we have a SSL secured (HTTPS) connection to the browser

It is thought to be so if you have 'SSLOptions +StdEnvVars' in your Apache configuration, OR if you have HTTPS set to a non-empty value (except "off") in your HTTP_SERVER_VARS, OR if you have HTTP_X_FORWARDED_PROTO=https in your HTTP_SERVER_VARS, OR if you are on port 443.

Note: HTTP_X_FORWARDED_PROTO could be sent from the client and therefore possibly spoofed/hackable - for now, the administrator can tell SM to ignore this value by setting $sq_ignore_http_x_forwarded_headers to boolean TRUE in config/config_local.php, but in the future we may want to default this to TRUE and make administrators who use proxy systems turn it off (see 1.5.2+).

Note: It is possible to run SSL on a port other than 443, and if that is the case, the administrator should set $sq_https_port to the applicable port number in config/config_local.php

• return: TRUE if the current connection is SSL-encrypted; FALSE otherwise.
• since: 1.4.17 and 1.5.2

Search for the var $name in $_SESSION, $_POST, $_GET, $_COOKIE, or $_SERVER and set it in provided var.

If $search is not provided, or == SQ_INORDER, it will search $_SESSION, then $_POST, then $_GET. Otherwise, use one of the defined constants to look for a var in one place specifically.

Note: $search is an int value equal to one of the constants defined above.

example: sqgetGlobalVar('username',$username,SQ_SESSION); -- no quotes around last param!

• return: whether variable is found.

• string $name: name the name of the var to search
• mixed &$value: value the variable to return
• int $search: search constant defining where to look

Deletes an existing session, more advanced than the standard PHP session_destroy(), it explicitly deletes the cookies and global vars.

Function to verify a session has been started. If it hasn't

start a session up. php.net doesn't tell you that $_SESSION (even though autoglobal), is not created unless a session is started, unlike $_POST, $_GET and such

Checks to see if a variable has already been registered in the session.

• return: whether the var has been registered

• string $name: the name of the var to check

Add a variable to the session.

• mixed $var: the variable to register
• string $name: the name to refer to this variable

Function to start the session and store the cookie with the session_id as

HttpOnly cookie which means that the cookie isn't accessible by javascript (IE6 only) Note that as sqsession_is_active() no longer discriminates as to when it calls this function, session_start() has to have E_NOTICE suppression (thus the @ sign). Update: with PHP7.2+, session_set_cookie_params() is similarly affected.

• since: 1.4.16

Delete a variable from the session.

• string $name: the name of the var to delete

Set a cookie

• since: 1.4.16 and 1.5.1

• string $sName: The name of the cookie.
• string $sValue: The value of the cookie.
• int $iExpire: The time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch.
• string $sPath: The path on the server in which the cookie will be available on.
• string $sDomain: The domain that the cookie is available.
• boolean $bSecure: Indicates that the cookie should only be transmitted over a secure HTTPS connection.
• boolean $bHttpOnly: Disallow JS to access the cookie (IE6/FF2)
• boolean $bReplace: Replace previous cookies with same name?

Recursively strip slashes from the values of an array.

• array &$array: array the array to strip, passed by reference

Squelch error output to screen (only) for the given function.

This provides an alternative to the @ error-suppression operator where errors will not be shown in the interface but will show up in the server log file (assuming the administrator has configured PHP logging).

• return: The return value, if any, of the function being executed will be returned.
• since: 1.4.12 and 1.5.2

• string $function: The function to be executed
• array $args: The arguments to be passed to the function (OPTIONAL; default no arguments) NOTE: The caller must take extra action if the function being called is supposed to use any of the parameters by reference. In the following example, $x is passed by reference and $y is passed by value to the "my_func" function. sq_call_function_suppress_errors('my_func', array(&$x, $y));