Code Structure - Revision history

Ibot3 at 14:24, 16 January 2018

2018-01-16T14:24:26Z

Ibot3 at 14:23, 16 January 2018

2018-01-16T14:23:41Z

Ibot3 at 14:23, 16 January 2018

2018-01-16T14:23:25Z

Ibot3 at 14:22, 16 January 2018

2018-01-16T14:22:56Z

Ibot3 at 19:23, 7 July 2017

2017-07-07T19:23:54Z

Ibot3 at 08:42, 21 May 2017

2017-05-21T08:42:41Z

Ibot3: Created page with "== Useful Functions == string Lang(string $identifier): Returns the language string for the given identifier. string AP(DIR): Returns the path of your addon folder (e.g...."

2017-04-19T12:47:14Z

Created page with "== Useful Functions == *string Lang(string $identifier): Returns the language string for the given identifier. *string AP(__DIR__): Returns the path of your addon folder (e.g...."

New page

== Useful Functions ==
*string Lang(string $identifier): Returns the language string for the given identifier.
*string AP(__DIR__): Returns the path of your addon folder (e.g. "addons/[you-addon]/"), useful if you want to access the "assets" folder.
*string ValidateHTML(string $html): Validates a given HTML code, prevents XSS.
*void RequiredArguments(string $arg1, string $arg2, ...): Checks if the given strings are available as $_REQUEST paramters. If true, they will be transformed to global variables with the same name. If not, a die() with error message will be executed.
*void Error(string $reason, bool $debug): die() with format {"error":"$reason"}. Writes error in the gex_debug mysql table if $debug is set to true.
*void Success(): die() with format {"success":true}
*void Result(array $result): die() with the array in json format
*string Hostname(): Returns the url to the domain (e.g. https://www.community.com/).
*string GetCurrentLocation(): Returns the url to the GExtension directory (e.g. https://www.community.com/gmodweb/).
*array FromJson(string $json): Same as json_decode() but with save return
*string ToJson(array $array): Same as json_encode() but wuth save return
*void Redirect(string $url, bool $delay = false): Initiates a JavaScript redirect, with 500ms delay if wanted
*bool StartsWith(string $haystack, string $needle)
*bool EndsWith(string $haystack, string $needle)
*string FormatDate(string $date): Formats a given date string (not unix).
*float FormatPrice(float $price): Formats a given price to two decimals
*void Debug(string $text): Writes a text into the gex_debug mysql table.
*void PermissionsError(bool $queue = false): Display a permissions error warning, queued for the next redirect if wanted.
*string SteamIDTo64(string $steamid32): Converts a 32 Bit SteamID into a 64 Bit SteamID.
*string SteamIDFrom64(string $steamid62): Converts a 64 Bit SteamID into a 32 Bit SteamID.

See assets/php/util.php and assets/php/classes/*.class.php for more functions. Especially the classes CURLRequester, DirectNotifications, User, Group, Notifications and Settings. You can find usage examples for those classes in the core files, just use the search function.

== Global Variables ==
=== Database ===
GExtension uses a MySQLi class which is documentated [https://github.com/joshcam/PHP-MySQLi-Database-Class here].

The object is named $db and can be used by functions with:
$db = MysqliDb::getInstance();
or
global $db;

=== User ===
The current user is available as a variable named $auth_user, null if not logged in.
global $auth_user;

== DBTableClass ==
The DBTableClass is used as a processor for mysql data. It's used by several classes, for example User.

All classes using the DBTableClass have the methods GetValue($key), SetValue($key, $value), Update($data) and Delete() and also the attributes $valid (there is data for the given id) and $data (raw data).

Example for the class "User":
<pre>
$user = new User($steamid64or32);

if($user->valid){
$nick = $user->GetValue('nick'); //Getting a value
$user->SetValue('email', 'test@test.com'); //Updating a value
$user->Update(array('email' => 'test@test.com', 'nick' => 'Test')) //Updating multiple values
$user->Delete() //You may should not delete a user from database
}
</pre>

@@ Line 34: / Line 34: @@
 === User ===
-The current user is available as a variable named $auth_user, null if not logged in.
+The current user is available as a variable named $auth_user, null when not logged in.
   global $auth_user;

@@ Line 4: / Line 4: @@
 *string ValidateHTML(string $html): Validates a given HTML code, prevents XSS.
 *void RequiredArguments(string $arg1, string $arg2, ...): Checks if the given strings are available as $_REQUEST paramters. If true, they will be transformed to global variables with the same name. If not, a die() with error message will be executed.
-*void OptionalArguments(string $arg1, string $arg2, ...): Same as RequiredArguments, but does not die() if argument not present. Sets an empts string as global variable instead.
+*void OptionalArguments(string $arg1, string $arg2, ...): Same as RequiredArguments, but does not die() if argument not present. Sets an empty string as global variable instead.
 *void Error(string $reason, bool $debug): die() with format {"error":"$reason"}. Writes error in the gex_debug mysql table if $debug is set to true.
 *void Success(): die() with format {"success":true}

@@ Line 21: / Line 21: @@
 *string SteamIDFrom64(string $steamid62): Converts a 64 Bit SteamID into a 32 Bit SteamID.
-See assets/php/util.php and assets/php/classes/*.class.php for more functions. Especially the classes CURLRequester, DirectNotifications, User, Group, Notifications and Settings. You can find usage examples for those classes in the core files, just use the search function.
+See assets/php/util.php and assets/php/classes/*.class.php for more functions. Especially the classes CURLRequester, DirectNotifications, User, Group, Notifications, Permissions and Settings. You can find usage examples for those classes in the core files, just use the search function.
 == Global Variables ==

@@ Line 39: / Line 39: @@
 The DBTableClass is used as a processor for mysql data. It's used by several classes, for example User.
-All classes using the DBTableClass have the methods GetValue($key), SetValue($key, $value), Update($data) and Delete() and also the attributes $valid (there is data for the given id) and $data (raw data).
+All classes using the DBTableClass have the methods GetValue($key), SetValue($key, $value), Update($data) and Delete() and also the attributes $valid (there is data for the given id) and $data (raw data array).
 Example for the class "User":

Code Structure - Revision history

Ibot3 at 14:24, 16 January 2018

Ibot3 at 14:23, 16 January 2018

Ibot3 at 14:23, 16 January 2018

Ibot3 at 14:22, 16 January 2018

Ibot3 at 19:23, 7 July 2017

Ibot3 at 08:42, 21 May 2017

Ibot3: Created page with "== Useful Functions == *string Lang(string $identifier): Returns the language string for the given identifier. *string AP(__DIR__): Returns the path of your addon folder (e.g...."

Ibot3: Created page with "== Useful Functions == string Lang(string $identifier): Returns the language string for the given identifier. string AP(DIR): Returns the path of your addon folder (e.g...."