createCommandLink [line 136]
String createCommandLink(
String $cmd, String $id, [array $params = array()], [String $name = '']
)
|
|
Creates a BIGACE Command Link.
Parameters:
|
String |
$cmd: |
the BIGACE command |
|
String |
$id: |
the BIGACE ID |
|
array |
$params: |
the URL Parameter as key-value mapping |
|
String |
$name: |
the file name |
API Tags:
| Return: | the formatted Link |
| Deprecated: | |
createInstance [line 216]
Object createInstance(
String $classname
)
|
|
Creates and returns an instance of the Class, given by its full qualified Classname.
If the class does not exist, this method returns null!
Parameters:
|
String |
$classname: |
classname the name of the class to be instanciated |
API Tags:
createLink [line 121]
String createLink(
array $params, [String $adress = '']
)
|
|
Creates any BIGACE Link - including the Session ID.
You should use this function to avoid a loose of the User Session in case of not accepted Cookies.
Parameters:
|
array |
$params: |
the Parameter as key-value mapping |
|
String |
$adress: |
the link address, if non is given the _BIGACE['HOME'] address will be linked |
API Tags:
createMenuLink [line 107]
String createMenuLink(
[mixed $mid = ''], [array $params = array()], [ $name = '']
)
|
|
Creates a Link to the given Menu Id.
Uses the function
.
Parameters:
|
mixed |
$mid: |
the Menu ID |
|
array |
$params: |
key - value pairs to append to the link (leave for none) |
|
|
$name: |
|
API Tags:
extractVar [line 75]
String extractVar(
String $varname, [String $notfound = '']
)
|
|
Searches for the given varname in _POST, _GET, _COOKIE and then in _GLOBALS Variable Scope.
If one is found it will be returned, else the notfound value is returned.
Parameters:
|
String |
$varname: |
the varname to lookup |
|
String |
$notfound: |
the varname to return is none was found |
API Tags:
| Return: | the varname or notfound if none was given |
getRandomString [line 151]
String getRandomString(
)
|
|
Returns a random String.
API Tags:
| Return: | the Random String |
getTranslation [line 61]
String getTranslation(
String $name, [String $common = '']
)
|
|
Loads an value from the Language File, pass a second parameter for the case the translation cannot be found.
Parameters:
|
String |
$name: |
the translation key |
|
String |
$common: |
a String being returned if no translation could be found |
API Tags:
get_permalink [line 92]
void get_permalink(
[ $params = array()]
)
|
|
Returns a permanent link to the current page.
Parameters:
has_group_permission [line 233]
boolean has_group_permission(
int $group_id, String $permission
)
|
|
Checks if a usergroup has the given permission.
Parameters:
|
int |
$group_id: |
group_id the Usergroup ID to check |
|
String |
$permission: |
permission the permission string to check |
API Tags:
| Return: | whether the group has the permission or not |
has_permission [line 287]
boolean has_permission(
String $permission
)
|
|
Checks if the current user has the given functional permission.
Parameters:
|
String |
$permission: |
permission the permission string to check |
API Tags:
| Return: | whether the User has the permission or not |
has_user_permission [line 258]
boolean has_user_permission(
int $userid, String $permission
)
|
|
Checks if a permission exists for the given User.
Parameters:
|
int |
$userid: |
userid the User ID to check |
|
String |
$permission: |
permission the permission string to check |
API Tags:
| Return: | whether the User has the permission or not |
import [line 203]
void import(
string $name
)
|
|
Import a class or interface using the java naming syntax.
This method replaces the older
, because you can load even files in the Interface (API) folder.For each file you have to pass the package as well (classes/api), cause its used include path begins one filesystem level higher.
Old:
New:
* You can load classes in deeper packages than the old ones, simply by passing more levels (api.authentication.ldap.LDAPAuthenticator).
Parameters:
|
string |
$name: |
name the name of the package to be imported |
isSystemParameter [line 164]
boolean isSystemParameter(
String $key
)
|
|
Returns if the given String is a Parameter that is already used by the System.
If returning true DO NOT use this Key as URL Parameter!
Parameters:
|
String |
$key: |
a key that should be used as URL Param |
API Tags:
| Return: | if key can be used or not |
loadClass [line 178]
void loadClass(
string $subpackage, string $classname
)
|
|
Loads a BIGACE Core Class dynamically.
This simulates a dynamic class loader and saves you from the requirement to know about the directory structure or File naming.
Parameters:
|
string |
$subpackage: |
the subpackage where the class is located |
|
string |
$classname: |
the class to load |
API Tags:
| Deprecated: | use import() instead |
loadLanguageFile [line 48]
void loadLanguageFile(
String $filename, [ $locale = _ULC_], [ $directory = '']
)
|
|
Loads a Language File. The Translations (or simply keys) will be accessible through
.
This trys to load the Language File in the current Session Language Locale. If you want to specify which Locale will be loaded, pass the short locale as second parameter ('en', 'de', ...): (Example: load "system.lang.php" by calling loadLanguageFile('system')
Parameters:
|
String |
$filename: |
the Language Filename (before extension '.lang.php'). |
|
|
$locale: |
|
|
|
$directory: |
|
