Difference between revisions of "Custom Variables"
From AWBS Wiki
(New page: ==Custom Variables in AWBS== AWBS is a very customizable system, as you can make your own themes, you can also add your custom data by placing variables and/or php scripts in your templat...) |
m (Protected "Custom Variables" [edit=sysop:move=sysop]) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | == | + | ===About=== |
| + | AWBS themes are customizable on many fronts. | ||
| + | One extremely powerful customization method you can utilize is adding your custom data by placing variables and/or php scriptlets in your template files. | ||
| + | Sometimes you may need to place the same script or value over and over again in many pages. You can do this using custom variables. | ||
| − | + | Custom variables are stored in a file called '''''gparser_user.php''''', this file can be found in the includes folder in your AWBS root directory. ''If you installed AWBS to '''home/user/public_html/''' on your server, gparser_user.php will be found in '''home/user/public_html/includes/gparser_user.php.<font color="red">sample</font>''' - remove the <font color="red">sample</font> from the file name to so it starts taking effect.'' | |
| − | + | ||
| − | + | Once you renamed the file, you can start placing your variables and php scriptlets there. | |
| − | + | ===Format=== | |
| + | <pre><?php | ||
| + | //Use the following format for additions: | ||
| + | |||
| + | //$template->set_var("template_variable", "your text"); | ||
| + | |||
| + | ?></pre> | ||
| + | |||
| + | '''Variable Examples''' | ||
| + | #<pre>$template->set_var("my_company_name", "Advanced Webhost Billing System");</pre>This example will set a variable $my_company_name. To display it, <pre><?php echo $my_company_name; ?></pre> or <pre><?=$my_company_name?></pre> | ||
| + | |||
| + | '''Notes''' | ||
| + | #PHP Scripts, functions, classes, and globals are allowed. | ||
| + | #When using a custom function that returns results, make sure to parse the result in a variable<pre>$template ->set_var("custom_variable", $your_result);</pre> | ||
| + | #To run MySQL Queries, you need to include dbconfig.php: <pre>include(WORKDIR."/includes/dbconfig.php");</pre> | ||
Latest revision as of 20:51, June 9, 2008
About
AWBS themes are customizable on many fronts. One extremely powerful customization method you can utilize is adding your custom data by placing variables and/or php scriptlets in your template files. Sometimes you may need to place the same script or value over and over again in many pages. You can do this using custom variables.
Custom variables are stored in a file called gparser_user.php, this file can be found in the includes folder in your AWBS root directory. If you installed AWBS to home/user/public_html/ on your server, gparser_user.php will be found in home/user/public_html/includes/gparser_user.php.sample - remove the sample from the file name to so it starts taking effect.
Once you renamed the file, you can start placing your variables and php scriptlets there.
Format
<?php
//Use the following format for additions:
//$template->set_var("template_variable", "your text");
?>
Variable Examples
$template->set_var("my_company_name", "Advanced Webhost Billing System");This example will set a variable $my_company_name. To display it,<?php echo $my_company_name; ?>
or<?=$my_company_name?>
Notes
- PHP Scripts, functions, classes, and globals are allowed.
- When using a custom function that returns results, make sure to parse the result in a variable
$template ->set_var("custom_variable", $your_result); - To run MySQL Queries, you need to include dbconfig.php:
include(WORKDIR."/includes/dbconfig.php");
