MINOR Unified @package PHPdoc (added where missing, removed duplicates)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@56212 467b73ca-7a2a-4603-9d3b-597d59a354a9

api/RSSFeed.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage integration
- */
-
 /**
  * RSSFeed class
  *

api/RestfulServer.php

@@ -23,6 +23,9 @@
  *  - DELETE /api/v1/(ClassName)/(ID)/(Relation)/(ForeignID) - remove the relationship between two database records, but don't actually delete the foreign object (NOT IMPLEMENTED YET)
  *
  *  - POST /api/v1/(ClassName)/(ID)/(MethodName) - executes a method on the given object (e.g, publish)
+ *
+ * @package sapphire
+ * @subpackage api
  */
 class RestfulServer extends Controller {
 	protected static $api_base = "api/v1/";

api/RestfulService.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage integration
- */
-
 /**
  * RestfulService class allows you to consume various RESTful APIs.
  * Through this you could connect and aggregate data of various web services.

api/SapphireSoapServer.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage integration
- */
-
 /**
  * Soap server class
  * @todo Improve documentation

api/SimplePie.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage integration
- */
-
 /**
  * A PHP-Based RSS and Atom Feed Framework
  * Takes the hard work out of managing a complete RSS/Atom solution.

api/Spyc.php

@@ -7,8 +7,6 @@
  * @link http://spyc.sourceforge.net/
  * @copyright Copyright 2005-2006 Chris Wanstrath
  * @license http://www.opensource.org/licenses/mit-license.php MIT License
- * @package sapphire
- * @subpackage misc
  */
 
 /**

cli/CliController.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Base class invoked from CLI rather than the webserver (Cron jobs, handling email bounces)
  * @package sapphire

cli/DailyTask.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run daily extend this class
  * @todo Improve documentation

cli/MonthlyTask.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run monthly extend this class
  * @package sapphire

cli/ScheduledTask.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Abstract task representing scheudled tasks
  * @todo Improve documentation

cli/WeeklyTask.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run weekly extend this class
  * @package sapphire

cli/YearlyTask.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run yearly extend this class
  * @package sapphire

core/ArrayData.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage view
- */
-
 /**
  * Lets you wrap a bunch of array data into a {@link ViewableData} object.
  *

core/ArrayLib.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Library of static methods for manipulating arrays.
  * @package sapphire

core/ClassInfo.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage core
- */
-
 /**
  * Provides introspection information about the class tree.
  * It's a cached wrapper around the built-in class functions.  Sapphire uses class introspection heavily

core/Convert.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Library of conversion functions, implemented as static methods.
  *

core/Cookie.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * A set of static methods for manipulating cookies.
  * @package sapphire

core/Extension.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage core
- */
-
 /**
  * Add extension that can be added to an object with Object::add_extension().
  * For DataObject extensions, use DataObjectDecorator

core/HTTP.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * A class with HTTP-related helpers.
  * Like Debug, this is more a bundle of methods than a class ;-)

core/Mailer.php

@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package sapphire
+ * @subpackage email
+ */
 
 /**
  * Mailer objects are responsible for actually sending emails.

core/ManifestBuilder.php

@@ -1,13 +1,5 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage core
- */
-
-/**
- * Name of the manifest file
- */
+// Name of the manifest file
 define("MANIFEST_FILE", TEMP_FOLDER . "/manifest" . str_replace(array("/",":", "\\"),"_", $_SERVER['SCRIPT_FILENAME']));
 
 /**

core/Requirements.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage view
- */
-
 /**
  * Requirements tracker, for javascript and css.
  * @todo Document the requirements tracker, and discuss it with the others.

core/SSViewer.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage view
- */
-
 /**
  * The SSViewer executes a .ss template file.
  * The SSViewer class handles rendering of .ss templates.  In addition to a full template in

core/Session.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Handles all manipulation of the session.
  * 

core/TokenisedRegularExpression.php

@@ -3,6 +3,8 @@
 /**
  * A tokenised regular expression is a parser, similar to a regular expression, that acts on tokens rather than characters.
  * This is a crucial component of the ManifestBuilder.
+ * @package sapphire
+ * @subpackage core
  */ 
 class TokenisedRegularExpression extends Object {
 	/**

core/ValidationResult.php

@@ -3,6 +3,8 @@
 /**
  * A class that combined as a boolean result with an optional list of error messages.
  * This is used for returning validation results from validators
+ * @package sapphire
+ * @subpackage core
  */
 class ValidationResult extends Object {
 	/**

core/ViewableData.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage view
- */
-
 /**
  * Generic class for all data that will be accessed from a view.
  * 

core/control/ContentController.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * The most common kind of controller; effectively a controller linked to a {@link DataObject}.
  *

core/control/ContentNegotiator.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * The content negotiator performs text/html or application/xhtml+xml switching.
  * It does this through the static function ContentNegotiator::process()

core/control/Controller.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Base controller class.
  * Controllers are the cornerstone of all site functionality in Sapphire.  The {@link Director}

core/control/Director.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Director is responsible for processing URLs, and providing environment information.
  * 

core/control/FormResponse.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage core
- */
-
 /**
  * This class collects all output that needs to be returned after an Form-Request to the client. It automatically determines
  * if it needs to send back javascript after an Ajax-Request or just redirect to another page (on a normal request).

core/control/HTTPResponse.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Represenets an HTTPResponse returned by a controller.
  *

core/control/ModelAsController.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * ModelAsController will hand over all control to the appopriate model object
  * It uses URLSegment to determine the right object.  Also, if (ModelClass)_Controller exists,

core/control/NestedController.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Interface that is implemented by controllers that are designed to hand control over to another controller.  
  * ModelAsController, which selects up a SiteTree object and passes control over to a suitable subclass of ContentController, is a good

core/control/RootURLController.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * This controller handles what happens when you visit the root URL.
  *

core/control/SapphireInfo.php

@@ -1,7 +1,8 @@
 <?php
-
 /**
  * Returns information about the current site instance.
+ * @package sapphire
+ * @subpackage control
  */
 class SapphireInfo extends Controller {
 	function Version() {

core/i18n.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Base-class for storage and retrieval of translated entities.
  * Most common use is translation of the CMS-interface through the _t()-method

core/model/ComponentSet.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * This is a special kind of DataObjectSet used to represent the items linked to in a 1-many or many-many
  * join.  It provides add and remove methods that will update the database.

core/model/CurrentPageIdentifier.php

@@ -1,12 +1,8 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * This interface lets us set up objects that will tell us what the current page is.
- * @package cms
+ * @package sapphire
+ * @subpackage model
  */
 interface CurrentPageIdentifier {
 	/**

core/model/DB.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Global database interface, complete with static methods.
  * Use this class for interacting with the database.

core/model/DataObject.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * A single database record & abstract class for the data-access-model.
  * @package sapphire

core/model/DataObjectDecorator.php

@@ -1,11 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
-
 /**
  * Plug-ins for additional functionality in your DataObjects
  *

core/model/DataObjectLog.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * A DataObjectLog is a log of changes that have been made to the database in this session.
  * It was designed to help with updates to the CMS tree, and could be used wherever an Ajax call 

core/model/Database.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Abstract database connectivity class.
  * Sub-classes of this implement the actual database connection libraries

core/model/ErrorPage.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * ErrorPage holds the content for the page of an error response.
  * @package cms

core/model/GhostPage.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * Ghost pages are placeholder pages that are used to facilitate the apparent support for
  * multiple parents.

core/model/HiddenClass.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * Anything that implements HiddenClass won't be shown in user-interface elements.  For example,
  * DataObjects that implement HiddenClass won't be showing in the "new page" dropdown.

core/model/Hierarchy.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * DataObjects that use the Hierachy decorator can be be organised as a hierachy, with children and parents.
  * The most obvious example of this is SiteTree.

core/model/Image.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage filesystem
- */
-
 /**
  * Represents an image attached to a page.
  * @package sapphire

core/model/MySQLDatabase.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * MySQL connector class.
  * @package sapphire

core/model/PDODatabase.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * PDO (general database) connector class.
  * @package sapphire

core/model/RedirectorPage.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage content
- */
-
 /**
  * A redirector page redirects when the page is visited.
  * @package cms

core/model/SQLMap.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * This is a class used to represent key->value pairs generated from database queries.
  * The query isn't actually executed until you need it.

core/model/SQLQuery.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Object representing a SQL query.
  * The various parts of the SQL query can be manipulated individually.

core/model/SiteTree.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * Basic data-object representing all pages within the site tree.
  * This data-object takes care of the heirachy.  All page types that live within the heirachy

core/model/Translatable.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * The {Translatable} decorator allows your DataObjects to have versions in different languages,
  * defining which fields are can be translated.

core/model/Versioned.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * The Versioned decorator allows your DataObjects to have several versions, allowing
  * you to rollback changes and view history. An example of this is the pages used in the CMS.

core/model/VirtualPage.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
 * Virtual Page creates an instance of a  page, with the same fields that the original page had, but readonly.
 * This allows you can have a page in mulitple places in the site structure, with different children without duplicating the content

core/model/fieldtypes/Boolean.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a boolean field.
  * @package sapphire

core/model/fieldtypes/Currency.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a decimal field containing a currency amount.
  * Currency the currency class only supports single currencies.

core/model/fieldtypes/DBField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Single field in the database.
  * Every field from the database is represented as a sub-class of DBField.  In addition to supporting

core/model/fieldtypes/Date.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a date field.
  * @package sapphire

core/model/fieldtypes/Datetime.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 if(!class_exists('Datetime')) {
 	/**
 	 * @package sapphire

core/model/fieldtypes/Decimal.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a Decimal field.
  * @package sapphire

core/model/fieldtypes/Double.php

@@ -1,6 +1,7 @@
 <?php
 /**
- * 
+ * @package sapphire
+ * @subpackage model
  */
 class Double extends DBField {
 	

core/model/fieldtypes/Enum.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents an enumeration field.
  * @package sapphire

core/model/fieldtypes/Float.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a floating point field.
  * @package sapphire

core/model/fieldtypes/HTMLText.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a large text field that contains HTML content.
  * 

core/model/fieldtypes/HTMLVarchar.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a short text field that is intended to contain HTML content.
  *

core/model/fieldtypes/Int.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents an integer field.
  * @package sapphire

core/model/fieldtypes/Percentage.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a decimal field from 0-1 containing a percentage value.
  * @package sapphire

core/model/fieldtypes/SSDatetime.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a date-time field.
  * @package sapphire

core/model/fieldtypes/Text.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a long text field.
  * @package sapphire

core/model/fieldtypes/Time.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a column in the database with the type 'Time'
  * @package sapphire

core/model/fieldtypes/Varchar.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a short text field.
  * @package sapphire

core/model/fieldtypes/Year.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * @package sapphire
- * @subpackage model
- */
-
 /**
  * Represents a single year field.
  * 

dev/BuildTask.php

@@ -8,6 +8,8 @@
  * the $Disabled property on the subclass.
  * 
  * @todo move from sapphire/testing to sapphire/dev or sapphire/development?
+ * @package sapphire
+ * @subpackage dev
  */
 abstract class BuildTask {
 	

dev/CSSContentParser.php

@@ -8,6 +8,9 @@
  * 
  * It was built to facilitate testing using PHPUnit and contains a number of assert methods that will throw PHPUnit
  * assertion exception when applicable.
+ * 
+ * @package sapphire
+ * @subpackage core
  */
 class CSSContentParser extends Object {
 	protected $simpleXML = null;

dev/Debug.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage core
- */
-
 /**
  * Supports debugging and core error handling.
  * 

dev/DebugView.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * @package sapphire
- * @subpackage dev
- */
-
 /**
  * A basic HTML wrapper for stylish rendering of a developement info view.
  * Used to output error messages, and test results.

dev/DevelopmentAdmin.php

@@ -5,6 +5,8 @@
  * TestRunner and TaskRunner.
  *
  * @todo documentation for how to add new unit tests and tasks
+ * @package sapphire
+ * @subpackage dev
  */
 class DevelopmentAdmin extends Controller {
 	

dev/FunctionalTest.php

@@ -18,6 +18,9 @@
  *     $this->assertExactMatchBySelector("#MyForm_ID p.error", array("That email address is invalid."));
  *  }	
  * </code>
+ * 
+ * @package sapphire
+ * @subpackage testing
  */
 class FunctionalTest extends SapphireTest {
 	/**

dev/InstallerTest.php

@@ -1,14 +1,8 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Simple controller that the installer uses to test that URL rewriting is working.
  * @package sapphire
- * @subpackage misc
+ * @subpackage testing
  */
 class InstallerTest extends Controller {
 

dev/MigrationTask.php

@@ -3,7 +3,9 @@
  * A migration task is a build task that is reversible.
  * 
  * Up and Down methods must be implemented.
- *
+ * 
+ * @package sapphire
+ * @subpackage dev
  */
 abstract class MigrationTask extends BuildTask {
 	

dev/TaskRunner.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage dev
+ */
 class TaskRunner extends Controller {
 	
 	static $url_handlers = array(

dev/TestMailer.php

@@ -1,7 +1,7 @@
 <?php
-
 /**
- * Test
+ * @package sapphire
+ * @subpackage email
  */
 class TestMailer extends Mailer {
 	protected $emailsSent = array();

dev/TestOnly.php

@@ -1,7 +1,8 @@
 <?php
-
 /**
  * Classes that implement TestOnly are only to be used during testing
+ * @package sapphire
+ * @subpackage testing
  */
 interface TestOnly {
 

dev/TestRunner.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * @package sapphire
  * @subpackage testing

dev/TestSession.php

@@ -1,8 +1,9 @@
 <?php
-
 /**
  * Represents a test usage session of a web-app
  * It will maintain session-state from request to request
+ * @package sapphire
+ * @subpackage testing
  */
 class TestSession {
 	private $session;

dev/TestViewer.php

@@ -1,7 +1,8 @@
 <?php
-
 /**
  * Allows human reading of a test in a format suitable for agile documentation
+ * @package sapphire
+ * @subpackage testing
  */
 class TestViewer extends Controller {
 	/**

email/Notifications.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * The Notifications class allows you to create email notifications for various events.
  * It lets your scripts generate a number of notifications, and delay sending of the emails until

email/QueuedEmail.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage email
- */
-
 /**
  * Stores a queued email to be sent at the given time
  * @package sapphire

email/QueuedEmailDispatchTask.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage email
- */
-
 /**
  * Daily task to send queued email.
  * @package sapphire

filesystem/Archive.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage filesystem
- */
-
 /**
  * Class for handling archives.
  * To implement a specific archive system, create a subclass of this abstract class, and amend the implementation of Archive::open().

filesystem/File.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage filesystem
- */
-
 /**
  * This class handles the representation of a File within Sapphire
  * Note: The files are stored in the "/assets/" directory, but sapphire

filesystem/Filesystem.php

@@ -1,7 +1,6 @@
 <?php
 /**
- * A collection of static methods for manipulating the filesystem.
- 
+ * A collection of static methods for manipulating the filesystem. 
  * @package sapphire
  * @subpackage filesystem
  */

filesystem/Folder.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage filesystem
- */
-
 /**
  * Represents a folder in the assets directory.
  * @package sapphire

filesystem/GD.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage filesystem
- */
-
 /**
  * A wrapper class for GD-based images, with lots of manipulation functions.
  * @package sapphire

filesystem/PostBackup.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage core
- */
-
 /**
  * Writes the POST array to a file as a last-ditch effort to preserve entered data.
  * @package forms

filesystem/TarballArchive.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage filesystem
- */
-
 /**
  * Implementation of .tar, .tar.gz, and .tar.bz2 archive handler.
  * @package sapphire

forms/AjaxFormAction.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage actions
- */
-
 /**
  * Action button with Ajax/JavaScript overloading.
  * @package forms

forms/AjaxUniqueTextField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Text field that automatically checks that the value entered is unique for the given
  * set of fields in a given set of tables

forms/AutocompleteTextField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Autocompleting text field, using script.aculo.us
  * @package forms

forms/BankAccountField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Field for displaying bank account numbers. It separates the bank, branch, account-number and account-suffix.
  * @package forms

forms/CalendarDateField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-datetime
- */
-
 /**
  * This field creates a date field that shows a calendar on pop-up
  * @package forms

forms/CheckboxField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Single checkbox field.
  * @package forms

forms/CheckboxFieldDisabled.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Single checkbox field, disabled
  * @package forms

forms/CheckboxSetField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Displays a set of checkboxes as a logical group.
  *

forms/ComplexRequiredFields.php

@@ -1,10 +1,4 @@
 <?php 
-
-/**
- * @package forms
- * @subpackage validators
- */
-
 /**
  * Validator that makes it easy to do required-fields while still allowing custom behaviour.
  * @package forms

forms/ComplexTableField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * Provides a tabuar list in your form with view, edit and add links to edit records
  * with a "has-one"-relationship. Detail-views are shown in a greybox-iframe.

forms/CompositeDateField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-datetime
- */
-
 /**
  * Date field that provides 3 dropdowns for entering a date
  * @package forms

forms/CompositeField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-structural
- */
-
 /**
  * Base class for all fields that contain other fields.
  * Implements sequentialisation - so that when we're saving / loading data, we can populate

forms/ConfirmedFormAction.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage actions
- */
-
 /**
  * Action button with confirmation text.
  * These button are useful for things like delete buttons.

forms/CountryDropdownField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * A simple extension to dropdown field, pre-configured to list countries.
  * It will default to the country of the current visiotr.

forms/CreditCardField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * CreditCard field, contains validation and formspec for creditcard fields.
  * @package forms

forms/CurrencyField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Currency field.
  * @package forms

forms/CustomRequiredFields.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage validators
- */
-
 /**
  * Specify special required fields to be executed as part of form validation
  * @package forms

forms/CustomValidator.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage validators
- */
-
 /**
  * Custom javascript validation
  * @package forms

forms/DMYCalendarDateField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-datetime
- */
-
 /**
  * Displays a date field with day, month and year boxes, with a calendar to select
  * the date

forms/DMYDateField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-datetime
- */
-
 /**
  * Displays a date field with day, month and year boxes, with a calendar to select
  * the date

forms/DataReport.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-reports
- */
-
 /**
  * Displays complex reports based on base Table of DataObject and available functions/fields provided to
  * the object.

forms/DatalessField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * Abstract class for all fields without data.
  * Labels, headings and the like should extend from this.

forms/DateField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-datetime
- */
-
 /**
  * Date field.
  * Default Value represented in the format

forms/DisabledTransformation.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage transformations
- */
-
 /**
  * Transformation that disables all the fields on the form.
  * @package forms

forms/DropdownField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Dropdown field, created from a <select> tag.
  * @package forms

forms/DropdownTimeField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-datetime
- */
-
 /**
  * Field for entering time that provides clock for selecting time.
  * @package forms

forms/EditForm.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage core
- */
-
 /**
  * Creates an edit form on a site page.
  * Extends the basic form class to automatically look up, and save to, the data-object referred to

forms/EditableButton.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableButton
  * Allows a user to modify the text on the button

forms/EditableCheckbox.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableCheckbox
  * A user modifiable checkbox on a UserDefinedForm

forms/EditableCheckboxGroupField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableDropdown
  * Represents a set of selectable radio buttons

forms/EditableCheckboxOption.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableDropdownOption
  * Represents a single entry in an EditableRadioField

forms/EditableDateField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableDateField
  * Allows a user to add a date field to the Field Editor

forms/EditableDropdown.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableDropdown
  * Represents a modifiable dropdown box on a form

forms/EditableDropdownOption.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableDropdownOption
  * Represents a single entry in an EditableDropdown

forms/EditableEmailField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableEmailField
  * Allow users to define a validating editable email field for a UserDefinedForm

forms/EditableFileField.php

@@ -1,7 +1,6 @@
 <?php
 /**
- * Allows a user to add a field that can be used to upload a file
- 
+ * Allows a user to add a field that can be used to upload a file 
  * @package forms
  * @subpackage fieldeditor
  */

forms/EditableFormField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * Represents an editable form field
  * @package forms

forms/EditableFormHeading.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * Allows an editor to insert a generic heading into a field
  * @package forms

forms/EditableMemberListField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * Creates an editable field that displays members in a given group
  * @package forms

forms/EditableRadioField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableDropdown
  * Represents a set of selectable radio buttons

forms/EditableRadioOption.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableDropdownOption
  * Represents a single entry in an EditableRadioField

forms/EditableTextField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * EditableTextField
  * This control represents a user-defined field in a user defined form

forms/EmailField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Text field with Email Validation.
  * @package forms

forms/EncryptField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Duplicate of {@link PasswordField}.
  * @package forms

forms/FieldGroup.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-structural
- */
-
 /**
  * Lets you include a nested group of fields inside a template.
  * This control gives you more flexibility over form layout.

forms/FieldSet.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-structural
- */
-
 /**
  * DataObjectSet designed for form fields.
  * It extends the DataObjectSet with the ability to get a sequential set of fields.

forms/FormAction.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage actions
- */
-
 /**
  * Single action button.
  * The action buttons are <input type="submit"> tags.

forms/FormField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage core
- */
-
 /**
  * Represents a field in a form.  
  * A FieldSet contains a number of FormField objects which make up the whole of a form.

forms/FormTransformation.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage transformations
- */
-
 /**
  * This class represents "transformations" of a form - such as making it printable or making it readonly.
  * The idea is that sometimes you will want to make your own such transformations, and you shouldn't have

forms/GSTNumberField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Field for displaying NZ GST numbers (usually 8-9 digits in the format ##-###-### or ##-###-####).
  * @package forms

forms/GroupedDropdownField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Grouped dropdown, using <optgroup> tags.
  * 

forms/HasManyComplexTableField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * ComplexTableField designed to edit a has_many join.
  * @package forms

forms/HasOneComplexTableField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * ComplexTableField with a radio button column, designed to edit a has_one join.
  * @package forms

forms/HeaderField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * Field that generates a heading tag.
  * This can be used to add extra text in your forms.

forms/HiddenField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * Hidden field.
  * @package forms

forms/HiddenFieldGroup.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-structural
- */
-
 /**
  * Lets you include a nested group of fields inside a template.
  * This control gives you more flexibility over form layout.

forms/HtmlEditorField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * A WYSIWYG editor field, powered by tinymce.
  * tinymce editor fields are created from <textarea> tags which are then converted with javascript.

forms/HtmlOneLineField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * A WYSIWYG editor field, powered by tinymce.
  * tinymce editor fields are created from <textarea> tags which are then converted with javascript.

forms/ImageField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-files
- */
-
 /**
  * A field that will upload attached images.
  * @package forms

forms/ImageFormAction.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage actions
- */
-
 /**
  * Action that uses an image instead of a button
  * @package forms

forms/InlineFormAction.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage actions
- */
-
 /**
  * Render a button that will act as 
  * If you want to add custom behaviour, please set {inlcudeDefaultJS} to false and work with behaviour.js.

forms/LabelField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * Simple label tag.
  * This can be used to add extra text in your forms.

forms/LabelledLiteralField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * It's a LiteralField ... with a Label
  * @package forms

forms/LanguageDropdownField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * An extension to dropdown field, pre-configured to list languages.
  * The languages already used in the site will be on top.

forms/ListboxField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Multi-line listbox field, created from a <select> tag.
  * @package forms

forms/LiteralField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * This field lets you put an arbitrary piece of HTML into your forms.
  * If there's not much behaviour around the HTML, it might not be worth going to the effort of

forms/LookupField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Read-only complement of {@link DropdownField}.
  * Shows the "human value" of the dropdown field for the currently selected value.

forms/ManyManyComplexTableField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * Special ComplexTableField for editing a many_many relation.
  * @package forms
@@ -28,12 +22,12 @@ class ManyManyComplexTableField extends HasManyComplexTableField {
 				$this->manyManyParentClass = $class;
 				$manyManyTable = $class . '_' . $this->name;
 				break;
-			}
-			$belongsManyManyRelations = $singleton->uninherited( 'belongs_many_many', true );
-			 if( isset( $belongsManyManyRelations ) && array_key_exists( $this->name, $belongsManyManyRelations ) ) {
+			}
+			$belongsManyManyRelations = $singleton->uninherited( 'belongs_many_many', true );
+			 if( isset( $belongsManyManyRelations ) && array_key_exists( $this->name, $belongsManyManyRelations ) ) {
 				$this->manyManyParentClass = $class;
 				$manyManyTable = $belongsManyManyRelations[$this->name] . '_' . $this->name;
-				break;
+				break;
 			}
 		}
 		$tableClasses = ClassInfo::dataClassesFor($this->sourceClass);
@@ -108,4 +102,4 @@ class ManyManyComplexTableField_Item extends ComplexTableField_Item {
 	}
 }
 
-?>
+?>

forms/NamedLabelField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * A {@link LabelField} that lets you give it a name; makes it easier to delete ;)
  * @package forms

forms/NoScriptField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * This field lets you put an arbitrary piece of HTML into your forms.
  * If there's not much behaviour around the HTML, it might not be worth going to the effort of

forms/NoScriptFormAction.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage actions
- */
-
 /**
  * Action that will only be shown if javascript is disabled.
  * @package forms

forms/NumericField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * A Single Numeric field extending a typical 
  * TextField but with validation.

forms/OptionsetField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Set of radio buttons designed to emulate a dropdown.
  * It even uses the same constructor as a dropdown field.

forms/PasswordField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Password input field.
  * @package forms

forms/PhoneNumberField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Field for displaying phone numbers. It separates the number, the area code and optionally the country code
  * and extension.

forms/PopupDateTimeField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-datetime
- */
-
 /**
  * Field for entering a date/time pair.
  * @package forms

forms/PrintableTransformation.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage transformations
- */
-
 /**
  * Transformation that will make a form printable.
  * Builds on readonly forms with different behaviour for tabsets.

forms/ProgressBar.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * Displays a progress bar in a form.
  * These are currently only linked to Batch Processes.

forms/ReadonlyField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Read-only field, with <label> and <span>
  * @package forms

forms/ReadonlyTransformation.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage transformations
- */
-
 /**
  * Transformation that will turn a form into a readonly version of itself
  * @package forms

forms/RelatedDataEditor.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * RelatedDataEditor puts a "sub-form" into a form that lets you edit a record on the other side of a
  * one-to-many relationship.  For example, you could be editing a workshop, and you want to provide fields

forms/ReportField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-reports
- */
-
 /**
  * Displays complex reports based on the list of tables and fields provided to
  * the object.

forms/RequiredFields.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage validators
- */
-
 /**
  * Required Fields allows you to set which fields
  * need to be present before submitting the form

forms/ResetFormAction.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage actions
- */
-
 /**
  * Action that clears all fields on a form.
  * Inserts an input tag with type=reset.

forms/RestrictedTextField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formatted
- */
-
 /**
  * A Text field that cannot contain certain characters
  * @package forms

forms/SQLReport.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-reports
- */
-
 /**
  * @package forms
  * @subpackage fields-reports

forms/SelectionGroup.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-structural
- */
-
 /**
  * SelectionGroup represents a number of fields that are selectable by a radio button that appears at
  * the beginning of each item.  Using CSS, you can configure the field to only display its contents if

forms/SimpleImageField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-files
- */
-
 /**
  * SimpleImageField provides an easy way of uploading images to Image has_one relationships.
  * Unlike ImageField, it doesn't use an iframe.

forms/SubmittedFileField.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * A file uploaded on a UserDefinedForm field
  * @package cms

forms/SubmittedForm.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * Contents of an UserDefinedForm submission
  * @package cms

forms/SubmittedFormField.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * Data received from a UserDefinedForm submission
  * @package cms

forms/SubmittedFormReportField.php

@@ -1,9 +1,4 @@
 <?php
-
-/**
- * @package cms
- */
-
 /**
  * Displays a summary of instances of a form submitted to the website
  * @package cms

forms/Tab.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-structural
- */
-
 /**
  * Implements a single tab in a {@link TabSet}.
  * @package forms

forms/TabSet.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * @package forms
- * @subpackage fields-structural
- */
-
 /**
  * Defines a set of tabs in a form.
  * The tabs are build with our standard tabstrip javascript library.  By default, the HTML is

forms/TableListField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * Form field that embeds a list into a form, such as a member list or a file list.
  * 

forms/TabularStyle.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage transformations
- */
-
 /**
  * This is a form decorator (a class that wraps around a form) providing us with some functions
  * to display it in a Tabular style.

forms/TextField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Text input field.
  * @package forms

forms/TextareaField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-basic
- */
-
 /**
  * Multi-line text area.
  * @package forms

forms/TimeField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-datetime
- */
-
 /**
  * Time field.
  * Default Value represented in the format passed as constructor.

forms/ToggleCompositeField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-structural
- */
-
 /**
  * Allows visibility of a group of fields to be toggled using '+' and '-' icons
  * @package forms

forms/ToggleField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-dataless
- */
-
 /**
  * ReadonlyField with added toggle-capabilities - will preview the first sentence of the contained text-value,
  * and show the full content by a javascript-switch.

forms/TreeDropdownField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * Dropdown-like field that gives you a tree of items, using ajax.
  * @package forms

forms/TreeMultiselectField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * This formfield represents many-many joins using a tree selector shown in a dropdown styled element
  * which can be added to any form usually in the CMS. 

forms/TreeSelectorField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * @deprecated Use {@link TreeDropdownField} or {@link TreeMultiselectField}
  * @package forms

forms/TypeDropdown.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-relational
- */
-
 /**
  * Create a dropdown from all instances of a class
  * @package forms

forms/UniqueRestrictedTextField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Text field that automatically checks that the value entered is unique for the given
  * set of fields in a given set of tables

forms/UniqueTextField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fields-formattedinput
- */
-
 /**
  * Text field that automatically checks that the value entered is unique for the given
  * set of fields in a given set of tables

forms/Validator.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage validators
- */
-
 /**
  * This validation class handles all form and custom form validation through
  * the use of Required fields.

forms/editor/FieldEditor.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage fieldeditor
- */
-
 /**
  * Allows CMS user to create forms dynamically.
  * @package forms

integration/XML.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Base class for XML parsers
  * @package sapphire

misc/GoogleSitemap.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Initial implementation of Sitemap support.
  * GoogleSitemap should handle requests to 'sitemap.xml'

parsers/BBCodeParser.php

@@ -1,13 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
-/**
- *
- */
 require_once('HTML/HTMLBBCodeParser.php');
 /*Seting up the PEAR bbcode parser*/  
 $config = parse_ini_file('BBCodeParser.ini', true);

parsers/HTML/BBCodeParser/Filter.php

@@ -1,11 +1,4 @@
 <?php
-/**
- * @package  sapphire
- * @subpackage misc
- */
-
-/**
- */
 require_once 'HTML/HTMLBBCodeParser.php';
 
 /**

parsers/HTML/HTMLBBCodeParser.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package  sapphire
- * @subpackage misc
- */
-
 /* vim: set expandtab tabstop=4 shiftwidth=4: */
 // +----------------------------------------------------------------------+
 // | PHP Version 4                                                        |

parsers/TextParser.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Parses text in a variety of ways.
  * 

profiler/Profiler.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /********************************************************************************\
  * Copyright (C) Carl Taylor (cjtaylor@adepteo.com)                             *
  * Copyright (C) Torben Nehmer (torben@nehmer.net) for Code Cleanup             *

search/AdvancedSearchForm.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage search
- */
-
 /**
  * More advanced search form
  * @package sapphire

search/SearchForm.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage search
- */
-
 /**
  * Standard basic search form
  * @package sapphire

security/Authenticator.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Abstract base class for an authentication method
  *

security/BasicAuth.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Provides an interface to HTTP basic authentication.
  * @package sapphire

security/ChangePasswordForm.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Standard Change Password Form
  * @package sapphire

security/Geoip.php

@@ -1,11 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
-
 /**
  * Routines for DNS to country resolution
  * 

security/Group.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * A security group.
  * @package sapphire

security/LoginForm.php

@@ -1,11 +1,4 @@
 <?php
-
-/**
- * @author Markus Lanthaler <markus@silverstripe.com>
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Abstract base class for a login form
  *

security/Member.php

@@ -1,11 +1,4 @@
 <?php
-
-/**
- * Member classes
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * The member class which represents the users of the system
  * @package sapphire

security/MemberAuthenticator.php

@@ -1,11 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- * @author Markus Lanthaler <markus@silverstripe.com>
- */
-
 /**
  * Authenticator for the default "member" method
  *

security/MemberLoginForm.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Log-in form for the "member" authentication method
  * @package sapphire

security/MemberPassword.php

@@ -1,7 +1,8 @@
 <?php
-
 /**
  * Keep track of users' previous passwords, so that we can check that new passwords aren't changed back to old ones.
+ * @package sapphire
+ * @subpackage security
  */
 class MemberPassword extends DataObject {
 	static $db = array(

security/NZGovtPasswordValidator.php

@@ -1,7 +1,8 @@
 <?php
-
 /**
  * This {@link PasswordValidator} implements the NZ E-Government Guidelines for passwords
+ * @package sapphire
+ * @subpackage security
  */
 class NZGovtPasswordValidator extends PasswordValidator {
 	function __construct() {

security/PasswordValidator.php

@@ -11,6 +11,9 @@
  * 
  * Member::set_password_validator($pwdValidator);
  * </code>
+ *
+ * @package sapphire
+ * @subpackage security
  */
 class PasswordValidator extends Object {
 	static $character_strength_tests = array(

security/Permission.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Represents a permission assigned to a group.
  * @package sapphire

security/PermissionDropdownField.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Special kind of dropdown field that has all permission codes as its dropdown source.
  * Note: This would ordinarily be overkill; the main reason we have it is that TableField doesn't let you specify a dropdown source;

security/PermissionProvider.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Used to let classes provide new permission codes.
  * Every implementor of PermissionProvider is accessed and providePermissions() called to get the full list of permission codes.

security/Security.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage security
- */
-
 /**
  * Implements a basic security model
  * @package sapphire

tests/DataObjectTest.php

@@ -1,12 +1,7 @@
 <?php
-
 /**
- * @package tests
- */
-
-/**
- * Tests for DataObject
- * @package tests
+ * @package sapphire
+ * @subpackage tests
  */
 class DataObjectTest extends SapphireTest {
 	static $fixture_file = 'sapphire/tests/DataObjectTest.yml';

tests/ManifestBuilderTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class ManifestBuilderTest extends SapphireTest {
 	function testManifest() {
 		$baseFolder = TEMP_FOLDER . '/manifest-test';

tests/ObjectTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class ObjectTest extends SapphireTest {
 	
 	function testHasmethodBehaviour() {

tests/SiteTreeTest.php

@@ -1,11 +1,7 @@
 <?php
-
 /**
- * @package tests
- */
-
-/**
- * Tests for SiteTree
+ * @package sapphire
+ * @subpackage tests
  */
 class SiteTreeTest extends SapphireTest {
 	static $fixture_file = 'sapphire/tests/SiteTreeTest.yml';

tests/TokenisedRegularExpressionTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class TokenisedRegularExpressionTest extends SapphireTest {
 	function getTokens() {
 		return token_get_all(<<<PHP

tests/api/RSSFeedTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class RSSFeedTest extends SapphireTest {
 	
 	function testRSSFeed() {

tests/api/RestfulServerTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class RestfulServerTest extends SapphireTest {
 	static $fixture_file = 'sapphire/tests/api/RestfulServerTest.yml';
 	

tests/control/DirectorTest.php

@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class DirectorTest extends SapphireTest {
 	
 	public function testFileExists() {

tests/control/RootURLControllerTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class RootURLControllerTest extends SapphireTest {
 	static $fixture_file = 'sapphire/tests/control/RootURLControllerTest.yml';
 	

tests/fieldtypes/CurrencyTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class CurrencyTest extends SapphireTest {
 	function testNiceFormatting() {
 		// Test a bunch of different data values and results in Nice() and Whole()

tests/filesystem/UploadTest.php

@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class UploadTest extends SapphireTest {
 	static $fixture_file = 'sapphire/tests/filesystem/UploadTest.yml';
 

tests/forms/FormTest.php

@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class FormTest extends SapphireTest {
 	
 	public function testLoadDataFromRequest() {

tests/i18nTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class i18nTest extends SapphireTest {
 	function testGetExistingTranslations() {
 		$translations = i18n::get_existing_translations();

tests/security/GroupTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class GroupTest extends SapphireTest {
 	static $fixture_file = 'sapphire/tests/security/GroupTest.yml';
 	

tests/security/MemberTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class MemberTest extends SapphireTest {
 	static $fixture_file = 'sapphire/tests/security/MemberTest.yml';
 	

tests/security/SecurityTest.php

@@ -2,6 +2,9 @@
 
 /**
  * Test the security class, including log-in form, change password form, etc
+ *
+ * @package sapphire
+ * @subpackage tests
  */
 class SecurityTest extends SapphireTest {
 	static $fixture_file = 'sapphire/tests/security/MemberTest.yml';

tests/testing/CSSContentParserTest.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage tests
+ */
 class CSSContentParserTest extends SapphireTest {
 	function testSelector2xpath() {
 		$parser = new CSSContentParser("<html><head><title>test</title></head><body><p>test</p></body></html>");

widgets/Widget.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage widgets
- */
-
 /**
  * Base class for widgets.
  * Widgets let CMS authors drag and drop small pieces of functionality into defined areas of their websites.

widgets/WidgetArea.php

@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage widgets
- */
-
 /**
  * Represents a set of widgets shown on a page.
  * @package sapphire

widgets/WidgetFormProxy.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @package sapphire
+ * @subpackage widgets
+ */
 class WidgetFormProxy extends Controller {
 	function getFormOwner() {
 		$widget = DataObject::get_by_id("Widget", $this->urlParams['ID']);