From 38b9dfa6f3f2ac254c6f9131e1131eb9fe796bb2 Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Thu, 10 Jan 2013 13:50:19 -0500
Subject: [PATCH] Added missing module comments.
---
module/VuFind/Module.php | 56 ++++++++++++++++++++++++++-
module/VuFindConsole/Module.php | 56 ++++++++++++++++++++++++++-
module/VuFindLocalTemplate/Module.php | 56 ++++++++++++++++++++++++++-
3 files changed, 165 insertions(+), 3 deletions(-)
diff --git a/module/VuFind/Module.php b/module/VuFind/Module.php
index ac1d0761bf9..92901f9af4f 100644
--- a/module/VuFind/Module.php
+++ b/module/VuFind/Module.php
@@ -1,17 +1,61 @@
<?php
-
+/**
+ * ZF2 module definition for the VuFind application
+ *
+ * PHP version 5
+ *
+ * Copyright (C) Villanova University 2010.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * @category VuFind2
+ * @package Module
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://github.com/dmj/vf2-proxy
+ */
namespace VuFind;
use VuFind\Bootstrap,
Zend\ModuleManager\ModuleManager,
Zend\Mvc\MvcEvent;
+/**
+ * ZF2 module definition for the VuFind application
+ *
+ * @category VuFind2
+ * @package Module
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://github.com/dmj/vf2-proxy
+ */
class Module
{
+ /**
+ * Get module configuration
+ *
+ * @return array
+ */
public function getConfig()
{
return include __DIR__ . '/config/module.config.php';
}
+ /**
+ * Get autoloader configuration
+ *
+ * @return array
+ */
public function getAutoloaderConfig()
{
return array(
@@ -28,10 +72,20 @@ class Module
);
}
+ /**
+ * Initialize the module
+ *
+ * @return void
+ */
public function init(ModuleManager $m)
{
}
+ /**
+ * Bootstrap the module
+ *
+ * @return void
+ */
public function onBootstrap(MvcEvent $e)
{
$bootstrapper = new Bootstrap($e);
diff --git a/module/VuFindConsole/Module.php b/module/VuFindConsole/Module.php
index 4e51ee00d47..d700c026f13 100644
--- a/module/VuFindConsole/Module.php
+++ b/module/VuFindConsole/Module.php
@@ -1,16 +1,60 @@
<?php
-
+/**
+ * ZF2 module definition for the VuFind console module
+ *
+ * PHP version 5
+ *
+ * Copyright (C) Villanova University 2010.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * @category VuFind2
+ * @package Module
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://github.com/dmj/vf2-proxy
+ */
namespace VuFindConsole;
use VuFindConsole\Mvc\Router\ConsoleRouter,
Zend\ModuleManager\ModuleManager, Zend\Mvc\MvcEvent;
+/**
+ * ZF2 module definition for the VuFind console module
+ *
+ * @category VuFind2
+ * @package Module
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://github.com/dmj/vf2-proxy
+ */
class Module
{
+ /**
+ * Get module configuration
+ *
+ * @return array
+ */
public function getConfig()
{
return include __DIR__ . '/config/module.config.php';
}
+ /**
+ * Get autoloader configuration
+ *
+ * @return array
+ */
public function getAutoloaderConfig()
{
return array(
@@ -22,10 +66,20 @@ class Module
);
}
+ /**
+ * Initialize the module
+ *
+ * @return void
+ */
public function init(ModuleManager $m)
{
}
+ /**
+ * Bootstrap the module
+ *
+ * @return void
+ */
public function onBootstrap(MvcEvent $e)
{
$callback = function ($e) {
diff --git a/module/VuFindLocalTemplate/Module.php b/module/VuFindLocalTemplate/Module.php
index 2b6334f9216..896565c56ef 100644
--- a/module/VuFindLocalTemplate/Module.php
+++ b/module/VuFindLocalTemplate/Module.php
@@ -1,16 +1,60 @@
<?php
-
+/**
+ * Template for ZF2 module for storing local overrides.
+ *
+ * PHP version 5
+ *
+ * Copyright (C) Villanova University 2010.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * @category VuFind2
+ * @package Module
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://github.com/dmj/vf2-proxy
+ */
namespace VuFindLocalTemplate;
use Zend\ModuleManager\ModuleManager,
Zend\Mvc\MvcEvent;
+/**
+ * Template for ZF2 module for storing local overrides.
+ *
+ * @category VuFind2
+ * @package Module
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://github.com/dmj/vf2-proxy
+ */
class Module
{
+ /**
+ * Get module configuration
+ *
+ * @return array
+ */
public function getConfig()
{
return include __DIR__ . '/config/module.config.php';
}
+ /**
+ * Get autoloader configuration
+ *
+ * @return array
+ */
public function getAutoloaderConfig()
{
return array(
@@ -22,10 +66,20 @@ class Module
);
}
+ /**
+ * Initialize the module
+ *
+ * @return void
+ */
public function init(ModuleManager $m)
{
}
+ /**
+ * Bootstrap the module
+ *
+ * @return void
+ */
public function onBootstrap(MvcEvent $e)
{
}
--
GitLab