Including lib-common.php - Revision history

Dirk: leave braces off of the require_once

2009-05-21T17:40:54Z

leave braces off of the require_once

Dirk: Added category

2008-03-07T13:12:18Z

Added category

Dirk: Looks nicer with

...

2006-03-11T20:03:33Z

Looks nicer with <pre> ...

Dirk at 10:22, 10 March 2006

2006-03-10T10:22:34Z

Dirk: Short article on how to properly include lib-common.php and why

2006-03-10T10:20:42Z

Short article on how to properly include lib-common.php and why

New page

lib-common.php is Geeklog's repository of commonly used functions (those that start with COM_). It also pulls in other libraries, e.g. for the session handling, and ensures that all currently active plugins are loaded.

It is also an important part of Geeklog's security.

Among the files that lib-common.php loads is Geeklog's central configuration file, '''config.php'''. By loading this file, it's ensured that all the global $_CONF variables are set and can not be overridden by URL parameters (assuming [[register_globals]] is "on").

It is therefore important to ''properly'' include lib-common.php, which means

* always '''use either the complete, absolute path''' to your lib-common.php, i.e.
:/path/to/your/lib-common.php
* '''or use a relative path''', i.e.
:../../lib-common.php
* '''never(!)''' use a variable in the path, i.e.
:$somepath . 'lib-common.php'

An older version of the Geeklog/Gallery integration had [http://www.geeklog.net/article.php/2003120922482655 exactly that problem].

lib-common.php should also always be the ''first'' file you include in your script. Actually, it should be the first line of code in your script.

@@ Line 8: / Line 8: @@
 * always '''use either the complete, absolute path''' to your lib-common.php, i.e.
-<pre>require_once('/path/to/your/lib-common.php');</pre>
+<pre>require_once '/path/to/your/lib-common.php';</pre>
 * '''or use a relative path''', i.e.
-<pre>require_once('../../lib-common.php');</pre>
+<pre>require_once '../../lib-common.php';</pre>
 * '''never(!)''' use a variable in the path, i.e. something like
-<pre>require_once($somepath . 'lib-common.php');</pre>
+<pre>require_once $somepath . 'lib-common.php';</pre>
 An older version of the Geeklog/Gallery integration had [http://www.geeklog.net/article.php/2003120922482655 exactly that problem].

← Older revision		Revision as of 13:12, 7 March 2008
Line 17:		Line 17:

	lib-common.php should also always be the ''first file'' you include in your script. Actually, it should be the ''first line of code'' in your script.		lib-common.php should also always be the ''first file'' you include in your script. Actually, it should be the ''first line of code'' in your script.
		+
		+
		+	[[Category:Development]]

@@ Line 11: / Line 11: @@
 * '''or use a relative path''', i.e.
 :../../lib-common.php
-* '''never(!)''' use a variable in the path, i.e.
+* '''never(!)''' use a variable in the path, i.e. something like
 :$somepath . 'lib-common.php'
 An older version of the Geeklog/Gallery integration had [http://www.geeklog.net/article.php/2003120922482655 exactly that problem].
-lib-common.php should also always be the ''first'' file you include in your script. Actually, it should be the first line of code in your script.
+lib-common.php should also always be the ''first file'' you include in your script. Actually, it should be the ''first line of code'' in your script.