[geeklog-cvs] geeklog: phpDocumentor tags for the Static Pages plugin
geeklog-cvs at lists.geeklog.net
geeklog-cvs at lists.geeklog.net
Sun Mar 15 16:55:25 EDT 2009
details: http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/8d868290493d
changeset: 6841:8d868290493d
user: Dirk Haun <dirk at haun-online.de>
date: Sun Mar 15 20:06:29 2009 +0100
description:
phpDocumentor tags for the Static Pages plugin
diffstat:
6 files changed, 70 insertions(+), 16 deletions(-)
plugins/staticpages/autoinstall.php | 35 +++++++++++++++++++----
plugins/staticpages/functions.inc | 6 +++
plugins/staticpages/install_defaults.php | 14 +++++----
plugins/staticpages/services.inc.php | 8 ++++-
public_html/admin/plugins/staticpages/index.php | 10 ++++++
public_html/staticpages/index.php | 13 +++++---
diffs (202 lines):
diff -r 05f2aee29a2d -r 8d868290493d plugins/staticpages/autoinstall.php
--- a/plugins/staticpages/autoinstall.php Sun Mar 15 18:57:47 2009 +0100
+++ b/plugins/staticpages/autoinstall.php Sun Mar 15 20:06:29 2009 +0100
@@ -8,7 +8,7 @@
// | |
// | This file provides helper functions for the automatic plugin install. |
// +---------------------------------------------------------------------------+
-// | Copyright (C) 2008 by the following authors: |
+// | Copyright (C) 2008-2009 by the following authors: |
// | |
// | Authors: Dirk Haun - dirk AT haun-online DOT de |
// +---------------------------------------------------------------------------+
@@ -29,6 +29,19 @@
// | |
// +---------------------------------------------------------------------------+
+/**
+* Autoinstall API functions for the Static Pages plugin
+*
+* @package StaticPages
+*/
+
+/**
+* Plugin autoinstall function
+*
+* @param string $pi_name Plugin name
+* @return array Plugin information
+*
+*/
function plugin_autoinstall_staticpages($pi_name)
{
$pi_name = 'staticpages';
@@ -75,6 +88,14 @@
return $inst_parms;
}
+/**
+* Load plugin configuration from database
+*
+* @param string $pi_name Plugin name
+* @return boolean true on success, otherwise false
+* @see plugin_initconfig_staticpages
+*
+*/
function plugin_load_configuration_staticpages($pi_name)
{
global $_CONF;
@@ -87,11 +108,13 @@
return plugin_initconfig_staticpages();
}
-function plugin_postinstall_staticpages($pi_name)
-{
- return true;
-}
-
+/**
+* Check if the plugin is compatible with this Geeklog version
+*
+* @param string $pi_name Plugin name
+* @return boolean true: plugin compatible; false: not compatible
+*
+*/
function plugin_compatible_with_this_version_staticpages($pi_name)
{
if (! function_exists('SEC_getGroupDropdown')) {
diff -r 05f2aee29a2d -r 8d868290493d plugins/staticpages/functions.inc
--- a/plugins/staticpages/functions.inc Sun Mar 15 18:57:47 2009 +0100
+++ b/plugins/staticpages/functions.inc Sun Mar 15 20:06:29 2009 +0100
@@ -33,6 +33,12 @@
// | Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
// | |
// +---------------------------------------------------------------------------+
+
+/**
+* Implementation of the Plugin API for the Static Pages plugin
+*
+* @package StaticPages
+*/
if (strpos(strtolower($_SERVER['PHP_SELF']), 'functions.inc') !== false) {
die('This file can not be used on its own.');
diff -r 05f2aee29a2d -r 8d868290493d plugins/staticpages/install_defaults.php
--- a/plugins/staticpages/install_defaults.php Sun Mar 15 18:57:47 2009 +0100
+++ b/plugins/staticpages/install_defaults.php Sun Mar 15 20:06:29 2009 +0100
@@ -2,7 +2,7 @@
/* Reminder: always indent with 4 spaces (no tabs). */
// +---------------------------------------------------------------------------+
-// | Static Pages Plugin 1.5 |
+// | Static Pages Plugin 1.6 |
// +---------------------------------------------------------------------------+
// | install_defaults.php |
// | |
@@ -10,7 +10,7 @@
// | records. These settings are only used during the initial installation |
// | and not referenced any more once the plugin is installed. |
// +---------------------------------------------------------------------------+
-// | Copyright (C) 2008 by the following authors: |
+// | Copyright (C) 2008-2009 by the following authors: |
// | |
// | Authors: Blaine Lang - blaine AT portalparts DOT com |
// | Dirk Haun - dirk AT haun-online DOT de |
@@ -31,14 +31,18 @@
// | Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
// | |
// +---------------------------------------------------------------------------+
-//
-// $Id: install_defaults.php,v 1.9 2008/09/21 08:37:08 dhaun Exp $
+
+/**
+* Install data and defaults for the Static Pages plugin configuration
+*
+* @package StaticPages
+*/
if (strpos(strtolower($_SERVER['PHP_SELF']), 'install_defaults.php') !== false) {
die('This file can not be used on its own!');
}
-/*
+/**
* Static Pages default settings
*
* Initial Installation Defaults used when loading the online configuration
diff -r 05f2aee29a2d -r 8d868290493d plugins/staticpages/services.inc.php
--- a/plugins/staticpages/services.inc.php Sun Mar 15 18:57:47 2009 +0100
+++ b/plugins/staticpages/services.inc.php Sun Mar 15 20:06:29 2009 +0100
@@ -33,11 +33,17 @@
// | |
// +---------------------------------------------------------------------------+
+/**
+* Functions related to the webservices and the internal plugin API
+*
+* @package StaticPages
+*/
+
if (strpos(strtolower($_SERVER['PHP_SELF']), 'services.inc.php') !== false) {
die('This file can not be used on its own.');
}
-// this must be kept in synch with the actual size of 'sp_id' in the db ...
+// this must be kept in sync with the actual size of 'sp_id' in the db ...
define('STATICPAGE_MAX_ID_LENGTH', 40);
/**
diff -r 05f2aee29a2d -r 8d868290493d public_html/admin/plugins/staticpages/index.php
--- a/public_html/admin/plugins/staticpages/index.php Sun Mar 15 18:57:47 2009 +0100
+++ b/public_html/admin/plugins/staticpages/index.php Sun Mar 15 20:06:29 2009 +0100
@@ -32,6 +32,16 @@
// | |
// +---------------------------------------------------------------------------+
+/**
+* Static Pages plugin administration page
+*
+* @package StaticPages
+* @subpackage admin
+*/
+
+/**
+* Geeklog common function library and Admin authentication
+*/
require_once '../../../lib-common.php';
require_once '../../auth.inc.php';
diff -r 05f2aee29a2d -r 8d868290493d public_html/staticpages/index.php
--- a/public_html/staticpages/index.php Sun Mar 15 18:57:47 2009 +0100
+++ b/public_html/staticpages/index.php Sun Mar 15 20:06:29 2009 +0100
@@ -2,13 +2,13 @@
/* Reminder: always indent with 4 spaces (no tabs). */
// +---------------------------------------------------------------------------+
-// | Geeklog Static Pages Plugin 1.5 |
+// | Static Pages Plugin 1.6 |
// +---------------------------------------------------------------------------+
// | index.php |
// | |
// | This is the main page for the Geeklog Static Pages Plugin |
// +---------------------------------------------------------------------------+
-// | Copyright (C) 2000-2008 by the following authors: |
+// | Copyright (C) 2000-2009 by the following authors: |
// | |
// | Authors: Tony Bibbs - tony AT tonybibbs DOT com |
// | Tom Willett - twillett AT users DOT sourceforge DOT net |
@@ -30,8 +30,13 @@
// | Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
// | |
// +---------------------------------------------------------------------------+
-//
-// $Id: index.php,v 1.48 2008/06/20 15:12:36 dhaun Exp $
+
+/**
+* Display a Static Page
+*
+* @package StaticPages
+* @subpackage public_html
+*/
require_once '../lib-common.php';
More information about the geeklog-cvs
mailing list