Add docblocks for global and db files.

omeka · Oct 11, 2012 · 85acd38 · 85acd38
1 parent c0f652e
commit 85acd38
Show file tree

Hide file tree

Showing 51 changed files with 373 additions and 258 deletions.
diff --git a/application/libraries/Omeka/Db.php b/application/libraries/Omeka/Db.php
@@ -1,15 +1,18 @@
-<?php 
+<?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Database manager object for Omeka
  *
  * While mostly a wrapper for a Zend_Db_Adapter instance, this also provides 
  * shortcuts for retrieving table objects and table names for use in SQL.
+ * 
+ * @package Omeka\Db
  */
 class Omeka_Db
 {
@@ -106,7 +109,6 @@ public function __get($name)
      * Set logger for SQL queries.
      *
      * @param Zend_Log $logger
-     * @return void
      */
     public function setLogger($logger)
     {
@@ -189,7 +191,6 @@ public function getTable($class) {
      *
      * @param string $alias
      * @param Omeka_Db_Table $table
-     * @return void
      */
     public function setTable($alias, Omeka_Db_Table $table)
     {

diff --git a/application/libraries/Omeka/Db/Migration/AbstractMigration.php b/application/libraries/Omeka/Db/Migration/AbstractMigration.php
@@ -1,16 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
- * @access private
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Database migration classes may inherit from this one.
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
+ * 
+ * @package Omeka\Db\Migration
  */
 abstract class Omeka_Db_Migration_AbstractMigration implements Omeka_Db_Migration_MigrationInterface
 {

diff --git a/application/libraries/Omeka/Db/Migration/Exception.php b/application/libraries/Omeka/Db/Migration/Exception.php
@@ -1,15 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Indicates an error during the database migration process.
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
+ * 
+ * @package Omeka\Db\Migration
  */
 class Omeka_Db_Migration_Exception extends Exception
 {}
diff --git a/application/libraries/Omeka/Db/Migration/Manager.php b/application/libraries/Omeka/Db/Migration/Manager.php
@@ -1,20 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
- * @access private
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Manages database migrations (both upgrades and downgrades).
- *
- * Partially ported from Ruby on Rails.
- *
- * @internal This implements Omeka internals and is not part of the public API.
- * @access private
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
+ * 
+ * @package Omeka\Db\Migration
  */
 class Omeka_Db_Migration_Manager
 {

diff --git a/application/libraries/Omeka/Db/Migration/MigrationInterface.php b/application/libraries/Omeka/Db/Migration/MigrationInterface.php
@@ -1,15 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
+ * Migration interface.
  * 
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
+ * @package Omeka\Db\Migration
  */
 interface Omeka_Db_Migration_MigrationInterface
 {

diff --git a/application/libraries/Omeka/Db/Select.php b/application/libraries/Omeka/Db/Select.php
@@ -1,15 +1,15 @@
-<?php 
+<?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2009-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Class for SQL SELECT generation and results.
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2009-2010
+ * 
+ * @package Omeka\Db
  */
 class Omeka_Db_Select extends Zend_Db_Select
 {

diff --git a/application/libraries/Omeka/Db/Select/PublicPermissions.php b/application/libraries/Omeka/Db/Select/PublicPermissions.php
@@ -1,14 +1,15 @@
-<?php 
+<?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2012
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
- 
+
 /**
  * Encapsulates the permissions check for a record that can be public or private.
- *
- * @package Omeka
+ * 
+ * @package Omeka\Db
  */
 class Omeka_Db_Select_PublicPermissions
 {

diff --git a/application/libraries/Omeka/Db/Table.php b/application/libraries/Omeka/Db/Table.php
@@ -1,15 +1,18 @@
-<?php 
+<?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Database table classes.
  * 
  * Subclasses attached to models must follow the naming convention: 
  * Table_TableName, e.g. Table_ElementSet in models/Table/ElementSet.php.
+ * 
+ * @package Omeka\Db\Table
  */
 class Omeka_Db_Table
 {

diff --git a/application/libraries/globals.php b/application/libraries/globals.php
@@ -1,7 +1,11 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
+ * Omeka
+ * 
+ * Global functions.
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  * @package Omeka
  */
 

diff --git a/application/migrations/20100401000000_addPasswordSalt.php b/application/migrations/20100401000000_addPasswordSalt.php
@@ -1,15 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Adds a salt for all the user passwords in Omeka.
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
+ * 
+ * @package Omeka\Db\Migration
  */
 class addPasswordSalt extends Omeka_Db_Migration_AbstractMigration
 {

diff --git a/application/migrations/20100810120000_detachCollectorsFromEntities.php b/application/migrations/20100810120000_detachCollectorsFromEntities.php
@@ -1,15 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Removes all associations between Entities and Collections.
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2010
+ * 
+ * @package Omeka\Db\Migration
  */
 class detachCollectorsFromEntities extends Omeka_Db_Migration_AbstractMigration
 {

diff --git a/application/migrations/20110113000000_convertCollectorArrays.php b/application/migrations/20110113000000_convertCollectorArrays.php
@@ -1,16 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2011
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
- * @subpackage Migrations
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Converts mis-migrated collector arrays to plain strings.
- *
- * @package Omeka
- * @subpackage Migrations
+ * 
+ * @package Omeka\Db\Migration
  */
 class convertCollectorArrays extends Omeka_Db_Migration_AbstractMigration
 {

diff --git a/application/migrations/20110124000001_addStoredToFiles.php b/application/migrations/20110124000001_addStoredToFiles.php
@@ -1,5 +1,16 @@
 <?php
+/**
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
+ */
 
+/**
+ * Add stored flag to files table.
+ * 
+ * @package Omeka\Db\Migration
+ */
 class addStoredToFiles extends Omeka_Db_Migration_AbstractMigration
 {
     public function up()

diff --git a/application/migrations/20110301103900_removeHeaderCheckOption.php b/application/migrations/20110301103900_removeHeaderCheckOption.php
@@ -1,16 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2007-2011
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
- * @subpackage Migrations
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Removes the stored "header check" option for file validation.
- *
- * @package Omeka
- * @subpackage Migrations
+ * 
+ * @package Omeka\Db\Migration
  */
 class removeHeaderCheckOption extends Omeka_Db_Migration_AbstractMigration
 {

diff --git a/application/migrations/20110328192100_addSystemInfoOption.php b/application/migrations/20110328192100_addSystemInfoOption.php
@@ -1,15 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2011
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Add a 'display_system_info' option.
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2011
+ * 
+ * @package Omeka\Db\Migration
  */
 class addSystemInfoOption extends Omeka_Db_Migration_AbstractMigration
 {

diff --git a/application/migrations/20110426181300_addTagDelimiterOption.php b/application/migrations/20110426181300_addTagDelimiterOption.php
@@ -1,15 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2011
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Add a 'tag_delimiter' option.
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2011
+ * 
+ * @package Omeka\Db\Migration
  */
 class addTagDelimiterOption extends Omeka_Db_Migration_AbstractMigration
 {

diff --git a/application/migrations/20110601112200_addSessionsTable.php b/application/migrations/20110601112200_addSessionsTable.php
@@ -1,15 +1,15 @@
 <?php
 /**
- * @copyright Roy Rosenzweig Center for History and New Media, 2011
- * @license http://www.gnu.org/licenses/gpl-3.0.txt
- * @package Omeka
+ * Omeka
+ * 
+ * @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
  */
 
 /**
  * Add a 'sessions' table.
- *
- * @package Omeka
- * @copyright Roy Rosenzweig Center for History and New Media, 2011
+ * 
+ * @package Omeka\Db\Migration
  */
 class addSessionsTable extends Omeka_Db_Migration_AbstractMigration
 {