Geeklog's way of doing things

From GeeklogWiki
Jump to: navigation, search

All of Geeklog's PHP files are pure PHP. PHP allows you to use PHP as a scripting language embedded in HTML files but this is not how Geeklog does it. All of Geeklog's PHP files must have <?php as the first five characters and end with ?>. Failure to structure your Geeklog files this way will cause session and header errors. Geeklog attempts as much as possible to have only PHP code in the .php files. Two of the conventions used in Geeklog to accomplish this are the use of templates and language files.

Time will be well spent by the Geeklog plugin or block developer to become familiar with several Geeklog libraries. The following section outlines the more important or frequently used libraries, functions and standards.


Contents

lib-common.php

The Geeklog plugin or block developer should have a good understanding of lib-common.php which contains most of the display routines as well as some other general purpose routines. All of the Geeklog display routines return HTML. They do not contain echos or prints themselves. The way the Geeklog system is designed; you usually put your code between Geeklog display routines. For example: code to display a page would look like this:

$display  = COM_siteHeader();
$display .= COM_startBlock("Title of Your Block");
$display .= "Some words";
$display .= somefunction();
$display .= COM_endBlock;
$display .= COM_siteFooter(true);
COM_output($display);

A summary of commonly used Geeklog functions are described below but reference the lib-common.php documentation for further examples.

lib-security.php

The lib-security.php file contains the interface routines to the security system used in Geeklog. See the lib-security.php documentation. There are several SEC type functions that you may want to use in your projects. The table Commonly Used Geeklog Functions at the end of this section defines a couple of the more commonly used functions.


lib-database.php

All database access should take place through the database abstraction in lib-database.php and table names should be accessed through the $_TABLES array. The table definitions in this array will then include whatever table prefix this site is using. You should ensure that your plugin or block uses the $_TABLES['mytable'] for all database access related functions.

  • Block developers and site admins installing the block need to make sure that any tables needed by a block are added to the $_TABLES array. Ensure you follow the same standard by using the $_DB_table_prefix. However, you should not edit lib-database.php. If no suitable place can be found in the block's code, the addition should be done in lib-custom.php instead.
  • Plugin developers need to define their tables in the plugin config.php file (or some other suitable file belonging to the plugin, e.g. functions.inc). You have the ability to use the $_TABLES array or use your own plugin specific array to maintain the table definitions. In the latter case it's recommend that your arrays use a name such as _XX_TABLES, where XX are two letters to describe your plugin. Once the plugin is installed and enabled, the tables defined for the plugin are automatically known as globals.


lib-plugins.php

This library contains all the code used to interface your plugin or block to Geeklog. You will not call any code from here directly. The functions in this file are called by the Geeklog main programs as they are used to call all plugins and are used to resolve the plugin name and check if your plugin has a particular function. You will usually only have to look at this file to understand some nuance of the implementation. See the documentation for functions.inc and the original plugin documentation for further help.


How your Plugin or Block Interacts with Geeklog

The program lib-common.php is the key to all interaction with Geeklog. It includes all of the Geeklog code libraries.

  • At the top of lib-common.php is an include of lib-custom.php. This is where you place all your block functions. They are then included when the site index.php is called.
  • At the very end of lib-common.php is a check for all enabled plugins. A plugin is registered with Geeklog when it has a record in the plugins table and the field pi_enabled is 1. For all registered and enabled plugins, the code in lib-common.php will include the functions.inc file for each plugin. This is why the naming convention and location for each plugin file is strictly defined. All code libraries or configuration files your plugin needs should be included in your functions.inc. Since the plugin's config.php (if it exists) is now also included this way - via the include in functions.inc - the variables in your plugin config.php become global and can be referenced in your plugin functions.


Common Global Variables

There are a few commonly used globals within Geeklog that you will want to use and reference. The following table outlines the more frequently used ones and its recommended that these be used instead of hard coding paths and table names in your links or project code.

 Variable   Description
$_CONF['path_html'] Fully qualified path to your site's public_html path
$_CONF['site_url'] Full URL to your site's public_html directory
$_CONF['site_admin_url'] Full URL to your site's admin directory
$_USER['uid'] Current user ID. A uid of 1 is an anonymous user.
Note: This variable may not be set, which also should be handled as an anonymous user. Use the function COM_isAnonUser() to find out whether the user is anonymous.
$_TABLES['tablename'] An array of Geeklog tables with the site prefix defined. This can be used to access specific tables for queries.

Commonly used Geeklog functions

The following is a list of commonly used Geeklog functions that as developers we use and recommend you become more familiar with and use in your development projects. You will find example usage of these functions throughout the Geeklog code.

 Function Name    Description
 COM_siteHeader Display the main site header and optionally if 'none' is passed do not display the left blocks
 COM_siteFooter Display the main site footer and optionally if 'true' is passed display the right blocks
 COM_startBlock Formats the block title using the selected theme - pass the title, helpfile if any and optional block theme to apply if you do not want to use default
 COM_endBlock Formats the block footer using the selected theme or the optional block theme if you do not want to use default
 COM_output Takes the $display HTML string and echoes it out to the page. This function has been defined to allow compatibility with compressed content.
 COM_errorLog Use to format an error message or use for debugging - view output in <geeklog_dir>/logs/error.log
 DB_query Execute a formatted SQL query and return the record set to an array of records (which is also an array)
 DB_fetchArray Retrieve a record as an array from the returned record set - which DB_query returned.
 DB_numRows Returns the number of records retrieved by the DB_query result
 DB_getItem Retrieve one record as an array.
 COM_checkHTML Use to strip out $, <, > , [code] and replace with the HTML codes
 COM_checkWords Use to check passed text for any HTML tags that are not allowed as per the site config.php setting
 COM_getArgument Use to get a specified variable from the query string
 COM_setArgNames Set the names of the global variables that your code expects to see in the query string.
 SEC_inGroup Used to check if user has passed group rights.
Example: SEC_inGroup('Root') - returns true if user is a member of the "Root" group
 SEC_hasRights Used to check if user has access right (feature).
Example: SEC_hasRights('myplugin.edit')
Personal tools
Namespaces

Variants
Actions
documentation
Tools