Geeklog's way of doing things - Revision history

Rasade: /* Commonly used Geeklog functions */ added COM_setArgNames and COM_getArgument

2010-04-16T18:37:58Z

‎Commonly used Geeklog functions: added COM_setArgNames and COM_getArgument

Rasade: /* Commonly used Geeklog functions */ Added COM_output() commonly used functions table

2010-04-16T18:28:47Z

‎Commonly used Geeklog functions: Added COM_output() commonly used functions table

Rasade: /* Common Global Variables */ - added some extra information

2010-04-16T18:25:00Z

‎Common Global Variables: - added some extra information

Rasade: /* lib-common.php */ added COM_output()

2010-04-16T18:20:58Z

‎lib-common.php: added COM_output()

Sean c at 03:28, 9 February 2010

2010-02-09T03:28:38Z

Dirk: fixed link

2009-06-08T14:38:34Z

fixed link

Dirk: minor updates / corrections

2009-05-23T14:05:30Z

minor updates / corrections

Dirk: minor additions and corrections

2009-05-22T14:16:15Z

minor additions and corrections

Dirk: stray character

2009-05-22T14:05:59Z

stray character

Dirk: added links to lib-common.php/lib-security.php documentation

2009-05-22T14:04:19Z

added links to lib-common.php/lib-security.php documentation

@@ Line 145: / Line 145: @@
      <td width="13%" height="15"><font size="2">&nbsp;COM_checkWords</font></td>
      <td width="73%" height="15"><font size="2">Use to check passed text for any HTML tags that are not allowed as per the site config.php setting</font></td>
    </tr>
    <tr>

@@ Line 109: / Line 109: @@
      <font size="2">&nbsp;COM_endBlock</font></td>
      <td width="73%" height="16"><font size="2">Formats the block footer using the selected theme or the optional block theme if you do not want to use default</font></td>
    </tr>
    <tr>

@@ Line 71: / Line 71: @@
    <tr>
      <td width="27%" height="18"><font size="2">$_USER['uid']</font></td>
-     <td width="73%" height="18"><font size="2">Current user ID. A uid of 1 is an anonymous user.<br/>Note: This variable may not be set, which also should be handled as an anonymous user. Use the function <code>COM_isAnonUser()</code>.</font></td>
+     <td width="73%" height="18"><font size="2">Current user ID. A uid of 1 is an anonymous user.<br/>Note: This variable may not be set, which also should be handled as an anonymous user. Use the function <code>COM_isAnonUser()</code> to find out whether the user is anonymous.</font></td>
    </tr>
    <tr>
      <td width="27%" height="18"><font size="2">$_TABLES['tablename']</font></td>
-     <td width="73%" height="18"><font size="2">An array of Geeklog tables with the site prefix defined.</font></td>
+     <td width="73%" height="18"><font size="2">An array of Geeklog tables with the site prefix defined. This can be used to access specific tables for queries.</font></td>
    </tr>
 </table>
 == Commonly used Geeklog functions ==

@@ Line 15: / Line 15: @@
 $display .= COM_endBlock;
 $display .= COM_siteFooter(true);
-echo $display;
+COM_output($display);
 </pre>
 A summary of commonly used Geeklog functions are described below but reference the [http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html <tt>lib-common.php</tt> documentation] for further examples.
 == lib-security.php ==

← Older revision		Revision as of 03:28, 9 February 2010
Line 1:		Line 1:
−	All of Geeklog's PHP files are pure PHP. PHP allows you to use PHP as a scripting language ~~imbedded~~ 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 <tt>.php</tt> files. Two of the conventions used in Geeklog to accomplish this are the use of [[Using Templates and Language Files#Templates\|templates]] and [[Using Templates and Language Files#Language Files\|language files]].	+	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 <tt>.php</tt> files. Two of the conventions used in Geeklog to accomplish this are the use of [[Using Templates and Language Files#Templates\|templates]] and [[Using Templates and Language Files#Language Files\|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.		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.

← Older revision		Revision as of 14:38, 8 June 2009
Line 36:		Line 36:
	== lib-plugins.php ==		== 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 [[Functions.inc - Listing of the Plugin Functions\|documentation for <tt>functions.inc</tt>]] and the [~~http://www.geeklog.net/docs/english/plugin.html original~~ plugin documentation] for further help.	+	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 [[Functions.inc - Listing of the Plugin Functions\|documentation for <tt>functions.inc</tt>]] and the original [[Plugin Development\|plugin documentation]] for further help.

@@ Line 1: / Line 1: @@
-All of Geeklog's php files are pure php. PHP allows you to use php as a scripting language imbedded 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.
+All of Geeklog's PHP files are pure PHP. PHP allows you to use PHP as a scripting language imbedded 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 <tt>.php</tt> files. Two of the conventions used in Geeklog to accomplish this are the use of [[Using Templates and Language Files#Templates|templates]] and [[Using Templates and Language Files#Language Files|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.
@@ Line 18: / Line 18: @@
 </pre>
-A summary of commonly used Geeklog functions are described below but reference [http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html <tt>lib-common.php</tt> documentation] for further examples.
+A summary of commonly used Geeklog functions are described below but reference the [http://project.geeklog.net/src/Geeklog/_public_html---lib-common.php.html <tt>lib-common.php</tt> documentation] for further examples.
 == lib-security.php ==
-The <tt>lib-security.php</tt> file contains the interface routines to the security system used in Geeklog. See the [http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html <tt>lib-security.php</tt> 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.
+The <tt>lib-security.php</tt> file contains the interface routines to the security system used in Geeklog. See the [http://project.geeklog.net/src/Geeklog/_system---lib-security.php.html <tt>lib-security.php</tt> documentation]. There are several SEC type functions that you may want to use in your projects. The table [[Geeklog's way of doing things#Commonly used Geeklog functions|Commonly Used Geeklog Functions]] at the end of this section defines a couple of the more commonly used functions.
@@ Line 31: / Line 31: @@
 * Block developers and site admins installing the block need to make sure that any tables needed by a block are added to the <code>$_TABLES</code> array. Ensure you follow the same standard by using the $_DB_table_prefix. However, you should '''not''' edit <tt>lib-database.php</tt>. If no suitable place can be found in the block's code, the addition should be done in <tt>lib-custom.php</tt> instead.
-* Plugin developers need to define their tables in the plugin <tt>config.php</tt> file (or some other suitable file belonging to the plugin, e.g. <tt>functions.inc</tt>). You have the ability to use the <code>$_TABLES</code> array or use your own plugin specific array to maintain the table definitions. It's recommend that your arrays use a name such as <code>_XX_TABLES</code>, 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.
+* Plugin developers need to define their tables in the plugin <tt>config.php</tt> file (or some other suitable file belonging to the plugin, e.g. <tt>functions.inc</tt>). You have the ability to use the <code>$_TABLES</code> 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 <code>_XX_TABLES</code>, 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 <tt>functions.inc</tt> and the original plugin documentation for further help.
+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 [[Functions.inc - Listing of the Plugin Functions|documentation for <tt>functions.inc</tt>]] and the [http://www.geeklog.net/docs/english/plugin.html original plugin documentation] for further help.
-== How your Plug-in or Block Interacts with Geeklog ==
+== How your Plugin or Block Interacts with Geeklog ==
 The program <tt>lib-common.php</tt> is the key to all interaction with Geeklog. It includes all of the Geeklog code libraries.
@@ Line 145: / Line 145: @@
    <tr>
      <td width="13%" height="15"><font size="2">&nbsp;SEC_inGroup</font></td>
-     <td width="73%" height="15"><font size="2">Used to check if user has passed group rights. Example: SEC_inGroup('Root') - returns true if user is a member of the "Root" group</font></td>
+     <td width="73%" height="15"><font size="2">Used to check if user has passed group rights.<br/>Example: SEC_inGroup('Root') - returns true if user is a member of the "Root" group</font></td>
    </tr>
    <tr>
      <td width="13%" height="15"><font size="2">&nbsp;SEC_hasRights</font></td>
-     <td width="73%" height="15"><font size="2">Used to check if user has access right (feature). Example: SEC_hasRights('myplugin.edit')</font></td>
+     <td width="73%" height="15"><font size="2">Used to check if user has access right (feature).<br/>Example: SEC_hasRights('myplugin.edit')</font></td>
    </tr>
 </table>

@@ Line 60: / Line 60: @@
    <tr>
      <td width="27%" height="17"><font size="2">$_CONF['path_html']</font></td>
-     <td width="73%" height="17"><font size="2">Fully qualified path to your
+     <td width="73%" height="17"><font size="2">Fully qualified path to your site's public_html path</font></td>
    </tr>
    <tr>
      <td width="27%" height="18"><font size="2">$_CONF['site_url']</font></td>
-     <td width="73%" height="18"><font size="2">Full URL to your sites
+     <td width="73%" height="18"><font size="2">Full URL to your site's public_html directory</font></td>
    </tr>
    <tr>
      <td width="27%" height="18"><font size="2">$_CONF['site_admin_url']</font></td>
-     <td width="73%" height="18"><font size="2">Full URL to your sites admin
+     <td width="73%" height="18"><font size="2">Full URL to your site's admin directory</font></td>
    </tr>
    <tr>
      <td width="27%" height="18"><font size="2">$_USER['uid']</font></td>
-     <td width="73%" height="18"><font size="2">Current user ID. A uid of 1 is an
+     <td width="73%" height="18"><font size="2">Current user ID. A uid of 1 is an anonymous user.<br/>Note: This variable may not be set, which also should be handled as an anonymous user. Use the function <code>COM_isAnonUser()</code>.</font></td>
    </tr>
    <tr>
      <td width="27%" height="18"><font size="2">$_TABLES['tablename']</font></td>
-     <td width="73%" height="18"><font size="2">A array of geeklog tables with
+     <td width="73%" height="18"><font size="2">An array of Geeklog tables with the site prefix defined.</font></td>
    </tr>
 </table>
@@ Line 118: / Line 113: @@
    </tr>
    <tr>
-     <td width="13%" height="12"><font size="2">&nbsp;COM_errorLOG</font></td>
+     <td width="13%" height="12"><font size="2">&nbsp;COM_errorLog</font></td>
-     <td width="73%" height="12"><font size="2">Use to format an error message or
+     <td width="73%" height="12"><font size="2">Use to format an error message or use for debugging - view output in &lt;geeklog_dir&gt;/logs/error.log</font></td>
    </tr>
    <tr>
      <td width="13%" height="14">
      <font size="2">&nbsp;DB_query</font></td>
-     <td width="73%" height="14"><font size="2">Execute a formatted SQL query and
+     <td width="73%" height="14"><font size="2">Execute a formatted SQL query and return the record set to an array of records (which is also an array)</font></td>
    </tr>
    <tr>
      <td width="13%" height="16">
      <font size="2">&nbsp;DB_fetchArray</font></td>
-     <td width="73%" height="16"><font size="2">Retrieve a record as an array
+     <td width="73%" height="16"><font size="2">Retrieve a record as an array from the returned record set - which DB_query returned.</font></td>
    </tr>
    <tr>
      <td width="13%" height="16">
-     <font size="2">&nbsp;DB_numROWS</font></td>
+     <font size="2">&nbsp;DB_numRows</font></td>
-     <td width="73%" height="16"><font size="2">Returns the number of records
+     <td width="73%" height="16"><font size="2">Returns the number of records retrieved by the DB_query result</font></td>
    </tr>
    <tr>
      <td width="13%" height="16"><font size="2">&nbsp;DB_getItem</font></td>
-     <td width="73%" height="16"><font size="2">Retrieve one record as an array.
+     <td width="73%" height="16"><font size="2">Retrieve one record as an array.</font></td>
    </tr>
    <tr>
      <td width="13%" height="15"><font size="2">&nbsp;COM_checkHTML</font></td>
-     <td width="73%" height="15"><font size="2">Use to strip out $, &lt;, &gt; , [code]
+     <td width="73%" height="15"><font size="2">Use to strip out $, &lt;, &gt; , [code] and replace with the HTML codes</font></td>
    </tr>
    <tr>
      <td width="13%" height="15"><font size="2">&nbsp;COM_checkWords</font></td>
-     <td width="73%" height="15"><font size="2">Use to check passed text for any
+     <td width="73%" height="15"><font size="2">Use to check passed text for any HTML tags that are not allowed as per the site config.php setting</font></td>
    </tr>
    <tr>
      <td width="13%" height="15"><font size="2">&nbsp;SEC_inGroup</font></td>
-     <td width="73%" height="15"><font size="2">Used to check if user has passed
+     <td width="73%" height="15"><font size="2">Used to check if user has passed group rights. Example: SEC_inGroup('Root') - returns true if user is a member of the "Root" group</font></td>
    </tr>
    <tr>
      <td width="13%" height="15"><font size="2">&nbsp;SEC_hasRights</font></td>
-     <td width="73%" height="15"><font size="2">Used to check if user has access
+     <td width="73%" height="15"><font size="2">Used to check if user has access right (feature). Example: SEC_hasRights('myplugin.edit')</font></td>
    </tr>
 </table>

@@ Line 43: / Line 43: @@
 The program <tt>lib-common.php</tt> is the key to all interaction with Geeklog. It includes all of the Geeklog code libraries.
-* At the top of <tt>lib-common.php</tt> is an include of <tt>lib-custom.php</tt>. This is where you place all your block functions. They are then included when the site <tt>index.php</tt>2 is called.
+* At the top of <tt>lib-common.php</tt> is an include of <tt>lib-custom.php</tt>. This is where you place all your block functions. They are then included when the site <tt>index.php</tt> is called.
 * At the very end of <tt>lib-common.php</tt> 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 <tt>pi_enabled</tt> is <tt>1</tt>. For all registered and enabled plugins, the code in <tt>lib-common.php</tt> will include the <tt>functions.inc</tt> 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 <tt>functions.inc</tt>. Since the plugin's <tt>config.php</tt> (if it exists) is now also included this way - via the include in <tt>functions.inc</tt> - the variables in your plugin <tt>config.php</tt> become global and can be referenced in your plugin functions.