diff --git a/_config.php b/_config.php
index 211048e54..86dbfe158 100644
--- a/_config.php
+++ b/_config.php
@@ -12,10 +12,11 @@
*
* Authenticator::register_authenticator('OpenIDAuthenticator');
*
+ *
+ * @package sapphire
+ * @subpackage core
*/
-
-
/**
* Add pear parser to include path
*/
diff --git a/api/RSSFeed.php b/api/RSSFeed.php
index 8e446b385..1553ecb53 100755
--- a/api/RSSFeed.php
+++ b/api/RSSFeed.php
@@ -9,6 +9,8 @@
* RSSFeed class
*
* This class is used to create an RSS feed.
+ * @package sapphire
+ * @subpackage integration
*/
class RSSFeed extends ViewableData {
@@ -191,6 +193,8 @@ class RSSFeed extends ViewableData {
* This class is used for entries of an RSS feed.
*
* @see RSSFeed
+ * @package sapphire
+ * @subpackage integration
*/
class RSSFeed_Entry extends ViewableData {
diff --git a/api/RestfulService.php b/api/RestfulService.php
index 7cd905cd8..484c0d532 100644
--- a/api/RestfulService.php
+++ b/api/RestfulService.php
@@ -8,6 +8,8 @@
/**
* RestfulService class allows you to consume various RESTful APIs.
* Through this you could connect and aggregate data of various web services.
+ * @package sapphire
+ * @subpackage integration
*/
class RestfulService extends ViewableData {
protected $baseURL;
@@ -24,7 +26,7 @@ class RestfulService extends ViewableData {
/**
* Sets the Query string parameters to send a request.
- * @param params An array passed with necessary parameters.
+ * @param $params array An array passed with necessary parameters.
*/
function setQueryString($params=NULL){
$this->queryString = http_build_query($params,'','&');
@@ -85,9 +87,9 @@ class RestfulService extends ViewableData {
/**
* Gets attributes as an array, of a particular type of element.
- * @params xml - the source xml to parse, this could be the original response received.
- * @params collection - parent node which wraps the elements, if available
- * @params element - element we need to extract the attributes.
+ * @param $xml string The source xml to parse, this could be the original response received.
+ * @param $collection string The name of parent node which wraps the elements, if available
+ * @param $element string The element we need to extract the attributes.
* Example :
* returns id, owner,secret and sever attribute values of all such photo elements.
*/
@@ -117,10 +119,10 @@ class RestfulService extends ViewableData {
/**
* Gets an attribute of a particular element.
- * @params xml - the source xml to parse, this could be the original response received.
- * @params collection - parent node which wraps the element, if available
- * @params element - element we need to extract the attribute
- * @params attr - name of the attribute
+ * @param $xml string The source xml to parse, this could be the original response received.
+ * @param $collection string The name of the parent node which wraps the element, if available
+ * @param $element string The element we need to extract the attribute
+ * @param $attr string The name of the attribute
*/
function getAttribute($xml, $collection=NULL, $element=NULL, $attr){
@@ -142,9 +144,9 @@ class RestfulService extends ViewableData {
/**
* Gets set of node values as an array.
* When you get to the depth in the hierachchy use node_child_subchild syntax to get the value.
- * @params xml - the source xml to parse, this could be the original response received.
- * @params collection - parent node which wraps the elements, if available
- * @params element - element we need to extract the node values.
+ * @param $xml string The the source xml to parse, this could be the original response received.
+ * @param $collection string The name of parent node which wraps the elements, if available
+ * @param $element string The element we need to extract the node values.
*/
function getValues($xml, $collection=NULL, $element=NULL){
@@ -182,9 +184,9 @@ class RestfulService extends ViewableData {
/**
* Gets a single node value.
- * @params xml - the source xml to parse, this could be the original response received.
- * @params collection - parent node which wraps the elements, if available
- * @params element - element we need to extract the node value.
+ * @param $xml string The source xml to parse, this could be the original response received.
+ * @param $collection string The name of parent node which wraps the elements, if available
+ * @param $element string The element we need to extract the node value.
*/
function getValue($xml, $collection=NULL, $element=NULL){
diff --git a/api/SapphireSoapServer.php b/api/SapphireSoapServer.php
index 043519446..e851d7f41 100755
--- a/api/SapphireSoapServer.php
+++ b/api/SapphireSoapServer.php
@@ -7,6 +7,8 @@
/**
* Soap server class
+ * @package sapphire
+ * @subpackage integration
*/
class SapphireSoapServer extends Controller {
static $methods = array();
diff --git a/api/SimplePie.php b/api/SimplePie.php
index cf8f5170f..eda5b46db 100755
--- a/api/SimplePie.php
+++ b/api/SimplePie.php
@@ -5,28 +5,18 @@
* @subpackage integration
*/
-/****************************************************
-SIMPLEPIE
-A PHP-Based RSS and Atom Feed Framework
-Takes the hard work out of managing a complete RSS/Atom solution.
-
-Version: "Lemon Meringue"
-Updated: 3 November 2006
-Copyright: 2004-2006 Ryan Parman, Geoffrey Sneddon
-http://simplepie.org
-
-*****************************************************
-LICENSE:
-
-GNU Lesser General Public License 2.1 (LGPL)
-http://creativecommons.org/licenses/LGPL/2.1/
-
-*****************************************************
-Please submit all bug reports and feature requests to the SimplePie forums.
-http://simplepie.org/support/
-
-****************************************************/
-
+/**
+ * A PHP-Based RSS and Atom Feed Framework
+ * Takes the hard work out of managing a complete RSS/Atom solution.
+ * Version: "Lemon Meringue"
+ * Updated: 3 November 2006
+ * Copyright: 2004-2006 Ryan Parman, Geoffrey Sneddon
+ * http://simplepie.org
+ * LICENSE: GNU Lesser General Public License 2.1 (LGPL)
+ * Please submit all bug reports and feature requests to the SimplePie forums. http://simplepie.org/support/
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie
{
// SimplePie Info
@@ -1178,6 +1168,10 @@ EOT;
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_Item
{
var $data;
@@ -1687,6 +1681,10 @@ class SimplePie_Item
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_Author
{
var $name;
@@ -1738,6 +1736,10 @@ class SimplePie_Author
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_Enclosure
{
var $link;
@@ -2125,6 +2127,10 @@ class SimplePie_Enclosure
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_File
{
var $url;
@@ -2383,6 +2389,10 @@ class SimplePie_File
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_Cache
{
var $location;
@@ -2450,6 +2460,10 @@ class SimplePie_Cache
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_Misc
{
function absolutize_url($relative, $base)
@@ -3560,6 +3574,10 @@ class SimplePie_Misc
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_Locator
{
var $useragent;
@@ -3764,6 +3782,10 @@ class SimplePie_Locator
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_Parser
{
var $encoding;
@@ -4396,6 +4418,10 @@ class SimplePie_Parser
}
}
+/**
+ * @package sapphire
+ * @subpackage integration
+ */
class SimplePie_Sanitize
{
// Private vars
diff --git a/api/Spyc.php b/api/Spyc.php
index 20a96aed3..4e6a41b4f 100644
--- a/api/Spyc.php
+++ b/api/Spyc.php
@@ -13,6 +13,8 @@
/**
* A node, used by Spyc for parsing YAML.
+ * @package sapphire
+ * @subpackage misc
*/
class YAMLNode {
/**#@+
@@ -60,6 +62,8 @@ class YAMLNode {
* $parser = new Spyc;
* $array = $parser->load($file);
*
+ * @package sapphire
+ * @subpackage misc
*/
class Spyc {
@@ -842,7 +846,7 @@ class Spyc {
* An ever-so-slightly modified version of the array_kmerge() function posted
* to php.net by mail at nospam dot iaindooley dot com on 2004-04-08.
*
- * http://us3.php.net/manual/en/function.array-merge.php#41394
+ * http://us3.php.net/manual/en/function.array-merge.php
*
* @access private
* @param array $arr1
diff --git a/cli-script.php b/cli-script.php
index c6afb0ca8..8f4644166 100755
--- a/cli-script.php
+++ b/cli-script.php
@@ -1,8 +1,17 @@
#!/usr/bin/php5
disableBasicAuth();
diff --git a/cli/DailyTask.php b/cli/DailyTask.php
index 0065c4dba..92e00dbee 100755
--- a/cli/DailyTask.php
+++ b/cli/DailyTask.php
@@ -7,6 +7,8 @@
/**
* Classes that must be run daily extend this class
+ * @package sapphire
+ * @subpackage cron
*/
class DailyTask extends ScheduledTask {
diff --git a/cli/MonthlyTask.php b/cli/MonthlyTask.php
index 7ae3bc6b0..f029a1d60 100755
--- a/cli/MonthlyTask.php
+++ b/cli/MonthlyTask.php
@@ -7,6 +7,8 @@
/**
* Classes that must be run monthly extend this class
+ * @package sapphire
+ * @subpackage cron
*/
class MonthlyTask extends ScheduledTask {
diff --git a/cli/ScheduledTask.php b/cli/ScheduledTask.php
index 6bd4749a3..17b047f03 100755
--- a/cli/ScheduledTask.php
+++ b/cli/ScheduledTask.php
@@ -7,6 +7,8 @@
/**
* Abstract task representing scheudled tasks
+ * @package sapphire
+ * @subpackage cron
*/
abstract class ScheduledTask extends CliController {
// this class exists as a logical extension
diff --git a/cli/WeeklyTask.php b/cli/WeeklyTask.php
index f8bdb9054..178816353 100755
--- a/cli/WeeklyTask.php
+++ b/cli/WeeklyTask.php
@@ -7,6 +7,8 @@
/**
* Classes that must be run weekly extend this class
+ * @package sapphire
+ * @subpackage cron
*/
class WeeklyTask extends ScheduledTask {
diff --git a/core/ArrayData.php b/core/ArrayData.php
index b2cb6e243..d4662a007 100755
--- a/core/ArrayData.php
+++ b/core/ArrayData.php
@@ -15,6 +15,8 @@
* "ClassName" => "Page",
* "AddAction" => "Add a new Page page",
* ));
+ * @package sapphire
+ * @subpackage view
*/
class ArrayData extends ViewableData {
diff --git a/core/ArrayLib.php b/core/ArrayLib.php
index 3f4e9eda7..776c1ab5c 100755
--- a/core/ArrayLib.php
+++ b/core/ArrayLib.php
@@ -7,6 +7,8 @@
/**
* Library of static methods for manipulating arrays.
+ * @package sapphire
+ * @subpackage misc
*/
class ArrayLib extends Object {
static function invert($arr) {
diff --git a/core/ClassInfo.php b/core/ClassInfo.php
index a1e3e86a1..4f95c5d66 100755
--- a/core/ClassInfo.php
+++ b/core/ClassInfo.php
@@ -1,4 +1,10 @@
'Varchar',
@@ -924,6 +933,8 @@ class Email_BounceRecord extends DataObject {
/**
* This class is responsible for ensuring that members who are on it receive NO email
* communication at all. any correspondance is caught before the email is sent.
+ * @package sapphire
+ * @subpackage email
*/
class Email_BlackList extends DataObject{
static $db = array(
diff --git a/core/Extension.php b/core/Extension.php
index 198e577f5..5152d6a35 100644
--- a/core/Extension.php
+++ b/core/Extension.php
@@ -1,5 +1,10 @@
customise() to create.
+ * @package sapphire
+ * @subpackage view
*/
class ViewableData_Customised extends ViewableData {
public function castingHelperPair($field) {
@@ -991,6 +995,8 @@ class ViewableData_Customised extends ViewableData {
/**
* A ViewableData object that has been customised with an extra object. Use
* ViewableData->customise() to create.
+ * @package sapphire
+ * @subpackage view
*/
class ViewableData_ObjectCustomised extends ViewableData {
function __construct($obj, $extraObj) {
@@ -1060,6 +1066,8 @@ class ViewableData_ObjectCustomised extends ViewableData {
/**
* Debugger helper.
+ * @package sapphire
+ * @subpackage view
* @todo Finish this off
*/
class ViewableData_Debugger extends ViewableData {
diff --git a/core/control/ContentController.php b/core/control/ContentController.php
index 7666fe3c0..57f07bf58 100644
--- a/core/control/ContentController.php
+++ b/core/control/ContentController.php
@@ -1,4 +1,10 @@
urlParams;
@@ -59,11 +61,32 @@ class Controller extends ViewableData {
}
/**
+ * Executes this controller, and return an {@link HTTPResponse} object with the result.
+ *
+ * This method first does a few set-up activities:
+ * - Push this controller ont to the controller stack - see {@link Controller::curr()} for information about this.
+ * - Call {@link init()}
+ *
+ * Then it looks for the action method. The action is taken from $this->urlParams['Action'] - for this reason, it's important
+ * to have $Action included in your Director rule
+ *
+ * If $requestParams['executeForm'] is set, then the Controller assumes that we're processing a form. This is usually
+ * set by adding ?executeForm=XXX to the form's action URL. Form processing differs in the following ways:
+ * - The action name will be the name of the button clicked. If no button-click can be detected, the first button in the
+ * list will be assumed.
+ * - If the given action method doesn't exist on the controller, Controller will look for that method on the Form object.
+ * this lets developers package both a form and its action handlers in a single subclass of Form.
+ *
+ * NOTE: You should rarely need to overload run() - this kind of change is only really appropriate for things like nested
+ * controllers - {@link ModelAsController} and {@link RootURLController} are two examples here. If you want to make more
+ * orthodox functionality, it's better to overload {@link init()} or {@link index()}.
+ *
+ *
+ *
* Execute the appropriate action handler. If none is given, use defaultAction to display
* a template. The default action will be appropriate in most cases where displaying data
* is the core goal; the Viewer can call methods on the controller to get the data it needs.
*
- * @param array $urlParams named parameters extracted from the URL, including Action.
* @param array $requestParams GET and POST variables.
* @return HTTPResponse The response that this controller produces, including HTTP headers such as redirection info
*/
diff --git a/core/control/Director.php b/core/control/Director.php
index a4a566da6..d9071cb00 100644
--- a/core/control/Director.php
+++ b/core/control/Director.php
@@ -1,14 +1,21 @@
class;
@@ -1408,7 +1404,10 @@ class DataObject extends Controller implements DataObjectInterface {
}
/**
- * Get a bunch of fields in a list - a
of
name: value
+ * Get a bunch of fields in an HTML LI, like this:
+ * - name: value
+ * - name: value
+ * - name: value
*
* @return string The fields as an HTML unordered list
*/
diff --git a/core/model/DataObjectDecorator.php b/core/model/DataObjectDecorator.php
index 843fd966a..39700684d 100755
--- a/core/model/DataObjectDecorator.php
+++ b/core/model/DataObjectDecorator.php
@@ -10,6 +10,8 @@
* Plug-ins for additional functionality in your DataObjects
*
* DataObject decorators add extra functionality to your data objects.
+ * @package sapphire
+ * @subpackage model
*/
abstract class DataObjectDecorator extends Extension {
diff --git a/core/model/DataObjectInterface.php b/core/model/DataObjectInterface.php
index 859510ff7..137e1a574 100755
--- a/core/model/DataObjectInterface.php
+++ b/core/model/DataObjectInterface.php
@@ -9,6 +9,8 @@
* similar to DataObject.
*
* In addition to the methods defined below, the data of the object should be directly accessible as fields.
+ * @package sapphire
+ * @subpackage model
*/
interface DataObjectInterface {
/**
diff --git a/core/model/DataObjectLog.php b/core/model/DataObjectLog.php
index 1d90cb73c..8448dfcf9 100755
--- a/core/model/DataObjectLog.php
+++ b/core/model/DataObjectLog.php
@@ -9,6 +9,8 @@
* 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
* needs to update a complex on-screen representation of your data.
+ * @package sapphire
+ * @subpackage model
*/
class DataObjectLog extends Object {
/**
diff --git a/core/model/DataObjectSet.php b/core/model/DataObjectSet.php
index 85b49004f..8243e8c57 100644
--- a/core/model/DataObjectSet.php
+++ b/core/model/DataObjectSet.php
@@ -7,6 +7,8 @@
/**
* This class represents a set of database objects, such as the results of a query
+ * @package sapphire
+ * @subpackage model
*/
class DataObjectSet extends ViewableData implements Iterator {
/**
diff --git a/core/model/Database.php b/core/model/Database.php
index 01c081c67..cc211dff0 100755
--- a/core/model/Database.php
+++ b/core/model/Database.php
@@ -8,6 +8,8 @@
/**
* Abstract database connectivity class.
* Sub-classes of this implement the actual database connection libraries
+ * @package sapphire
+ * @subpackage model
*/
abstract class Database extends Object {
/**
diff --git a/core/model/DatabaseAdmin.php b/core/model/DatabaseAdmin.php
index 476fa41ac..f43f86d50 100644
--- a/core/model/DatabaseAdmin.php
+++ b/core/model/DatabaseAdmin.php
@@ -20,6 +20,8 @@ require_once("core/model/DB.php");
*
* Utility functions for administrating the database. These can be accessed
* via URL, e.g. http://www.yourdomain.com/db/build.
+ * @package sapphire
+ * @subpackage model
*/
class DatabaseAdmin extends Controller {
diff --git a/core/model/ErrorPage.php b/core/model/ErrorPage.php
index 2115da76d..3fa087894 100755
--- a/core/model/ErrorPage.php
+++ b/core/model/ErrorPage.php
@@ -6,6 +6,7 @@
/**
* ErrorPage holds the content for the page of an error response.
+ * @package cms
*/
class ErrorPage extends Page {
diff --git a/core/model/GhostPage.php b/core/model/GhostPage.php
index 1eb65e432..2717880e7 100755
--- a/core/model/GhostPage.php
+++ b/core/model/GhostPage.php
@@ -7,6 +7,7 @@
/**
* Ghost pages are placeholder pages that are used to facilitate the apparent support for
* multiple parents.
+ * @package cms
*/
class GhostPage extends SiteTree implements HiddenClass {
static $has_one = array(
diff --git a/core/model/HiddenClass.php b/core/model/HiddenClass.php
index 07f8690b8..2fdecaa4d 100644
--- a/core/model/HiddenClass.php
+++ b/core/model/HiddenClass.php
@@ -7,6 +7,7 @@
/**
* 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.
+ * @package cms
*/
interface HiddenClass {
diff --git a/core/model/Hierarchy.php b/core/model/Hierarchy.php
index 9f2b48b51..723d41d6f 100644
--- a/core/model/Hierarchy.php
+++ b/core/model/Hierarchy.php
@@ -8,6 +8,8 @@
/**
* 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.
+ * @package sapphire
+ * @subpackage model
*/
class Hierarchy extends DataObjectDecorator {
protected $markedNodes;
@@ -295,7 +297,7 @@ class Hierarchy extends DataObjectDecorator {
}
/**
- * Return a partial tree as a
.
+ * Return a partial tree as an HTML UL.
*/
public function partialTreeAsUL($minCount = 50) {
$children = $this->owner->AllChildren();
diff --git a/core/model/Image.php b/core/model/Image.php
index 0afd88025..f0fe927b7 100755
--- a/core/model/Image.php
+++ b/core/model/Image.php
@@ -7,6 +7,8 @@
/**
* Represents an image attached to a page.
+ * @package sapphire
+ * @subpackage filesystem
*/
class Image extends File {
/**
diff --git a/core/model/MySQLDatabase.php b/core/model/MySQLDatabase.php
index beac26a00..23f36bee1 100644
--- a/core/model/MySQLDatabase.php
+++ b/core/model/MySQLDatabase.php
@@ -7,6 +7,8 @@
/**
* MySQL connector class.
+ * @package sapphire
+ * @subpackage model
*/
class MySQLDatabase extends Database {
/**
diff --git a/core/model/PDODatabase.php b/core/model/PDODatabase.php
index a2f88a005..49919d457 100644
--- a/core/model/PDODatabase.php
+++ b/core/model/PDODatabase.php
@@ -7,6 +7,8 @@
/**
* PDO (general database) connector class.
+ * @package sapphire
+ * @subpackage model
*/
class PDODatabase extends Database {
/**
diff --git a/core/model/PageView.php b/core/model/PageView.php
index 63942e952..f2264512b 100644
--- a/core/model/PageView.php
+++ b/core/model/PageView.php
@@ -5,6 +5,7 @@
/**
* Data object that represents any page view in the system.
+ * @package cms
*/
class PageView extends DataObject {
diff --git a/core/model/RedirectorPage.php b/core/model/RedirectorPage.php
index 3ffd7dbdb..5e8f267e4 100755
--- a/core/model/RedirectorPage.php
+++ b/core/model/RedirectorPage.php
@@ -6,6 +6,7 @@
/**
* A redirector page redirects when the page is visited.
+ * @package cms
*/
class RedirectorPage extends Page {
static $add_action = "Redirector to another page";
diff --git a/core/model/SQLMap.php b/core/model/SQLMap.php
index 923ae1075..d2b67ec8b 100755
--- a/core/model/SQLMap.php
+++ b/core/model/SQLMap.php
@@ -8,6 +8,8 @@
/**
* This is a class used to represent key->value pairs generated from database queries.
* The query isn't actually executed until you need it.
+ * @package sapphire
+ * @subpackage model
*/
class SQLMap extends Object implements Iterator {
/**
diff --git a/core/model/SQLQuery.php b/core/model/SQLQuery.php
index 8a01d1deb..2a2839cdb 100755
--- a/core/model/SQLQuery.php
+++ b/core/model/SQLQuery.php
@@ -8,6 +8,8 @@
/**
* Object representing a SQL query.
* The various parts of the SQL query can be manipulated individually.
+ * @package sapphire
+ * @subpackage model
*/
class SQLQuery extends Object {
/**
diff --git a/core/model/SiteTree.php b/core/model/SiteTree.php
index 0bdbd7ff7..d3c3406f9 100644
--- a/core/model/SiteTree.php
+++ b/core/model/SiteTree.php
@@ -10,6 +10,7 @@
* should inherit from this.
*
* In addition, it contains a number of static methods for querying the site tree.
+ * @package cms
*/
class SiteTree extends DataObject {
diff --git a/core/model/Translatable.php b/core/model/Translatable.php
index 4745c657c..ba6bc39f4 100755
--- a/core/model/Translatable.php
+++ b/core/model/Translatable.php
@@ -28,7 +28,8 @@
* e.g. when overriding the get_one()-calls (which are already extended by {Translatable}).
*
* @author Bernat Foj Capell
- *
+ * @package sapphire
+ * @subpackage misc
*/
class Translatable extends DataObjectDecorator {
@@ -148,7 +149,7 @@ class Translatable extends DataObjectDecorator {
/**
* Set default language.
*
- * @paran $lang String
+ * @param $lang String
*/
static function set_default_lang($lang) {
self::$default_lang = $lang;
diff --git a/core/model/Versioned.php b/core/model/Versioned.php
index 8a1f36a97..891f7e5a0 100755
--- a/core/model/Versioned.php
+++ b/core/model/Versioned.php
@@ -8,6 +8,8 @@
/**
* 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.
+ * @package sapphire
+ * @subpackage model
*/
class Versioned extends DataObjectDecorator {
/**
@@ -692,6 +694,9 @@ class Versioned extends DataObjectDecorator {
/**
* Represents a single version of a record.
+ * @package sapphire
+ * @subpackage model
+ * @see Versioned
*/
class Versioned_Version extends ViewableData {
protected $record;
diff --git a/core/model/VirtualPage.php b/core/model/VirtualPage.php
index 41f101d0d..e8c79b52c 100755
--- a/core/model/VirtualPage.php
+++ b/core/model/VirtualPage.php
@@ -8,6 +8,7 @@
* 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
* Note: This Only duplicates $db fields and not the $has_one etc..
+* @package cms
*/
class VirtualPage extends Page {
@@ -124,7 +125,8 @@ class VirtualPage extends Page {
}
/**
- * @desc
+ * Controller for the virtual page.
+ * @package cms
*/
class VirtualPage_Controller extends Page_Controller {
diff --git a/core/model/fieldtypes/Boolean.php b/core/model/fieldtypes/Boolean.php
index 09550c42a..5811df535 100644
--- a/core/model/fieldtypes/Boolean.php
+++ b/core/model/fieldtypes/Boolean.php
@@ -7,8 +7,8 @@
/**
* Represents a boolean field.
- *
- * @param $defaultVal int
+ * @package sapphire
+ * @subpackage model
*/
class Boolean extends DBField {
diff --git a/core/model/fieldtypes/Currency.php b/core/model/fieldtypes/Currency.php
index 3b7fc3d4e..ec3ce57c5 100644
--- a/core/model/fieldtypes/Currency.php
+++ b/core/model/fieldtypes/Currency.php
@@ -8,6 +8,8 @@
/**
* Represents a decimal field containing a currency amount.
* Currency the currency class only supports single currencies.
+ * @package sapphire
+ * @subpackage model
*/
class Currency extends Decimal {
diff --git a/core/model/fieldtypes/DBField.php b/core/model/fieldtypes/DBField.php
index 448b2ab56..4ebf7cda2 100644
--- a/core/model/fieldtypes/DBField.php
+++ b/core/model/fieldtypes/DBField.php
@@ -9,6 +9,8 @@
* Single field in the database.
* Every field from the database is represented as a sub-class of DBField. In addition to supporting
* the creation of the field in the database,
+ * @package sapphire
+ * @subpackage model
*/
abstract class DBField extends ViewableData {
diff --git a/core/model/fieldtypes/Date.php b/core/model/fieldtypes/Date.php
index f06b1d69a..87b468635 100644
--- a/core/model/fieldtypes/Date.php
+++ b/core/model/fieldtypes/Date.php
@@ -7,6 +7,8 @@
/**
* Represents a date field.
+ * @package sapphire
+ * @subpackage model
*/
class Date extends DBField {
diff --git a/core/model/fieldtypes/Datetime.php b/core/model/fieldtypes/Datetime.php
index 6931d0d45..2d4a58d12 100644
--- a/core/model/fieldtypes/Datetime.php
+++ b/core/model/fieldtypes/Datetime.php
@@ -6,6 +6,11 @@
*/
if(!class_exists('Datetime')) {
+ /**
+ * @package sapphire
+ * @subpackage model
+ * @deprecated Use {@link SSDatetime} instead, as PHP 5.2 has its own Datetime class. Object::create('Datetime') will instantiate an SSDatetime object.
+ */
class Datetime extends Date {
function __construct($name) {
user_error('Datetime is deprecated. Use SSDatetime instead.', E_USER_NOTICE);
diff --git a/core/model/fieldtypes/Decimal.php b/core/model/fieldtypes/Decimal.php
index 97dbc6281..b8d5ea301 100644
--- a/core/model/fieldtypes/Decimal.php
+++ b/core/model/fieldtypes/Decimal.php
@@ -7,6 +7,8 @@
/**
* Represents a Decimal field.
+ * @package sapphire
+ * @subpackage model
*/
class Decimal extends DBField {
protected $wholeSize, $decimalSize;
diff --git a/core/model/fieldtypes/Enum.php b/core/model/fieldtypes/Enum.php
index 588495709..ff398b009 100755
--- a/core/model/fieldtypes/Enum.php
+++ b/core/model/fieldtypes/Enum.php
@@ -7,6 +7,8 @@
/**
* Represents an enumeration field.
+ * @package sapphire
+ * @subpackage model
*/
class Enum extends DBField {
diff --git a/core/model/fieldtypes/Float.php b/core/model/fieldtypes/Float.php
index 08a2835ab..9834e6fd6 100644
--- a/core/model/fieldtypes/Float.php
+++ b/core/model/fieldtypes/Float.php
@@ -7,6 +7,8 @@
/**
* Represents a floating point field.
+ * @package sapphire
+ * @subpackage model
*/
class Float extends DBField {
diff --git a/core/model/fieldtypes/HTMLText.php b/core/model/fieldtypes/HTMLText.php
index c2b992a0d..93f089366 100755
--- a/core/model/fieldtypes/HTMLText.php
+++ b/core/model/fieldtypes/HTMLText.php
@@ -9,6 +9,8 @@
* Represents a large text field that contains HTML content.
*
* This behaves similarly to Text, but the template processor won't escape any HTML content within it.
+ * @package sapphire
+ * @subpackage model
*/
class HTMLText extends Text {
diff --git a/core/model/fieldtypes/HTMLVarchar.php b/core/model/fieldtypes/HTMLVarchar.php
index 9dc5f0f22..dc8dd7503 100755
--- a/core/model/fieldtypes/HTMLVarchar.php
+++ b/core/model/fieldtypes/HTMLVarchar.php
@@ -9,6 +9,8 @@
* Represents a short text field that is intended to contain HTML content.
*
* This behaves similarly to Varchar, but the template processor won't escape any HTML content within it.
+ * @package sapphire
+ * @subpackage model
*/
class HTMLVarchar extends Varchar {
diff --git a/core/model/fieldtypes/Int.php b/core/model/fieldtypes/Int.php
index 0aec08ea0..e39ea78ba 100644
--- a/core/model/fieldtypes/Int.php
+++ b/core/model/fieldtypes/Int.php
@@ -7,8 +7,8 @@
/**
* Represents an integer field.
- *
- * @param $defaultVal int
+ * @package sapphire
+ * @subpackage model
*/
class Int extends DBField {
diff --git a/core/model/fieldtypes/Percentage.php b/core/model/fieldtypes/Percentage.php
index c0282b9e0..65194aaa6 100644
--- a/core/model/fieldtypes/Percentage.php
+++ b/core/model/fieldtypes/Percentage.php
@@ -7,6 +7,8 @@
/**
* Represents a decimal field from 0-1 containing a percentage value.
+ * @package sapphire
+ * @subpackage model
*/
class Percentage extends Decimal {
diff --git a/core/model/fieldtypes/SSDatetime.php b/core/model/fieldtypes/SSDatetime.php
index 79cdc510b..f8f257e5c 100644
--- a/core/model/fieldtypes/SSDatetime.php
+++ b/core/model/fieldtypes/SSDatetime.php
@@ -7,6 +7,8 @@
/**
* Represents a date-time field.
+ * @package sapphire
+ * @subpackage model
*/
class SSDatetime extends Date {
function setValue($value) {
diff --git a/core/model/fieldtypes/Text.php b/core/model/fieldtypes/Text.php
index 11c8a3cf8..f4c1135f9 100644
--- a/core/model/fieldtypes/Text.php
+++ b/core/model/fieldtypes/Text.php
@@ -7,6 +7,8 @@
/**
* Represents a long text field.
+ * @package sapphire
+ * @subpackage model
*/
class Text extends DBField {
static $casting = array(
diff --git a/core/model/fieldtypes/Time.php b/core/model/fieldtypes/Time.php
index af46946c4..e859503e6 100755
--- a/core/model/fieldtypes/Time.php
+++ b/core/model/fieldtypes/Time.php
@@ -7,6 +7,8 @@
/**
* Represents a column in the database with the type 'Time'
+ * @package sapphire
+ * @subpackage model
*/
class Time extends DBField {
diff --git a/core/model/fieldtypes/Varchar.php b/core/model/fieldtypes/Varchar.php
index 18d75b309..df52af8b5 100644
--- a/core/model/fieldtypes/Varchar.php
+++ b/core/model/fieldtypes/Varchar.php
@@ -7,6 +7,8 @@
/**
* Represents a short text field.
+ * @package sapphire
+ * @subpackage model
*/
class Varchar extends DBField {
protected $size;
diff --git a/email/Notifications.php b/email/Notifications.php
index 929dd8808..68060ed04 100755
--- a/email/Notifications.php
+++ b/email/Notifications.php
@@ -8,6 +8,7 @@
* 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
* the end of execution, so that multiple notifications can collated together
+ * @package cms
*/
class Notifications extends Object {
protected static $events = array();
diff --git a/email/QueuedEmail.php b/email/QueuedEmail.php
index 55e29a99f..77b77711d 100644
--- a/email/QueuedEmail.php
+++ b/email/QueuedEmail.php
@@ -7,6 +7,8 @@
/**
* Stores a queued email to be sent at the given time
+ * @package sapphire
+ * @subpackage email
*/
class QueuedEmail extends DataObject {
diff --git a/email/QueuedEmailDispatchTask.php b/email/QueuedEmailDispatchTask.php
index d6de21f03..29494f100 100644
--- a/email/QueuedEmailDispatchTask.php
+++ b/email/QueuedEmailDispatchTask.php
@@ -7,6 +7,8 @@
/**
* Daily task to send queued email.
+ * @package sapphire
+ * @subpackage email
*/
class QueuedEmailDispatchTask extends DailyTask {
diff --git a/filesystem/Archive.php b/filesystem/Archive.php
index 40c5e6d80..e2c68f690 100644
--- a/filesystem/Archive.php
+++ b/filesystem/Archive.php
@@ -8,6 +8,8 @@
/**
* Class for handling archives.
* To implement a specific archive system, create a subclass of this abstract class, and amend the implementation of Archive::open().
+ * @package sapphire
+ * @subpackage filesystem
*/
abstract class Archive extends Object {
/**
diff --git a/filesystem/File.php b/filesystem/File.php
index ac979a71b..1976d73ed 100755
--- a/filesystem/File.php
+++ b/filesystem/File.php
@@ -11,6 +11,8 @@
* looks at the db object to gather information about a file such as URL
*
* It then uses this for all processing functions (like image manipulation)
+ * @package sapphire
+ * @subpackage filesystem
*/
class File extends DataObject {
static $default_sort = "Name";
diff --git a/filesystem/Filesystem.php b/filesystem/Filesystem.php
index f557b7b32..b875dc7f9 100755
--- a/filesystem/Filesystem.php
+++ b/filesystem/Filesystem.php
@@ -7,6 +7,8 @@
/**
* A collection of static methods for manipulating the filesystem.
+ * @package sapphire
+ * @subpackage filesystem
*/
class Filesystem extends Object {
diff --git a/filesystem/Folder.php b/filesystem/Folder.php
index 2828a8ca4..575cc7c6d 100755
--- a/filesystem/Folder.php
+++ b/filesystem/Folder.php
@@ -7,6 +7,8 @@
/**
* Represents a folder in the assets directory.
+ * @package sapphire
+ * @subpackage filesystem
*/
class Folder extends File {
diff --git a/filesystem/GD.php b/filesystem/GD.php
index eafd0f87a..71aba79cd 100755
--- a/filesystem/GD.php
+++ b/filesystem/GD.php
@@ -7,6 +7,8 @@
/**
* A wrapper class for GD-based images, with lots of manipulation functions.
+ * @package sapphire
+ * @subpackage filesystem
*/
class GD extends Object {
protected $gd, $width, $height;
diff --git a/filesystem/PostBackup.php b/filesystem/PostBackup.php
index 2b288814e..b7b723831 100644
--- a/filesystem/PostBackup.php
+++ b/filesystem/PostBackup.php
@@ -1,12 +1,14 @@
IF you pass your source as an array, you pass values as an array too.
* Likewise objects are handled the same.
+ * @package forms
+ * @subpackage fields-basic
*/
class CheckboxSetField extends OptionsetField {
diff --git a/forms/ComplexRequiredFields.php b/forms/ComplexRequiredFields.php
index a4a1a5a24..51ed5cb40 100755
--- a/forms/ComplexRequiredFields.php
+++ b/forms/ComplexRequiredFields.php
@@ -1,9 +1,16 @@
children
+ * @package forms
+ * @subpackage fields-structural
*/
class CompositeField extends FormField {
protected $children;
diff --git a/forms/ConfirmedFormAction.php b/forms/ConfirmedFormAction.php
index 6d14ec7c1..10c27cf1d 100755
--- a/forms/ConfirmedFormAction.php
+++ b/forms/ConfirmedFormAction.php
@@ -1,8 +1,15 @@
performDisabledTransformation($this);
diff --git a/forms/DropdownField.php b/forms/DropdownField.php
index 7c3f3326c..5007ba9ec 100755
--- a/forms/DropdownField.php
+++ b/forms/DropdownField.php
@@ -1,7 +1,14 @@
tag.
+ * @package forms
+ * @subpackage fields-basic
*/
class DropdownField extends FormField {
protected $source;
diff --git a/forms/DropdownTimeField.php b/forms/DropdownTimeField.php
index 11e4bbfc6..3d19b8857 100644
--- a/forms/DropdownTimeField.php
+++ b/forms/DropdownTimeField.php
@@ -1,5 +1,15 @@
data().
+ * @package forms
+ * @subpackage core
+ * @deprecated I'm not sure if this is in production use? Is this a legacy of a bygone era?
*/
class EditForm extends Form {
function __construct($controller, $name, FieldSet $fields) {
diff --git a/forms/EditableButton.php b/forms/EditableButton.php
index 054bb8ca0..b46fa8ea6 100755
--- a/forms/EditableButton.php
+++ b/forms/EditableButton.php
@@ -1,14 +1,14 @@
"Boolean"
+ );
+
+ static $singular_name = 'Checkbox';
+ static $plural_name = 'Checkboxes';
+
+ function CheckboxField() {
+ $checkbox = new CheckboxField("Fields[".$this->ID."][Default]", "Checked by default", $this->getField('Default'));
- // Could remove this and just use value
- static $db = array(
- "Checked" => "Boolean"
- );
+ if( $this->readonly )
+ $checkbox = $checkbox->performReadonlyTransformation();
- static $singular_name = 'Checkbox';
- static $plural_name = 'Checkboxes';
-
- function CheckboxField() {
- $checkbox = new CheckboxField("Fields[".$this->ID."][Default]", "Checked by default", $this->getField('Default'));
-
- if( $this->readonly )
- $checkbox = $checkbox->performReadonlyTransformation();
-
- return $checkbox->FieldHolder();
- }
-
- function populateFromPostData( $data ) {
- $this->setField('Checked', isset($data['Checked']) ? $data['Checked'] : null);
- parent::populateFromPostData( $data );
- }
-
- function getFormField() {
- return new CheckboxField( $this->Name, $this->Title, $this->getField('Default') );
- }
-
- function getFilterField() {
- return new OptionsetField( $this->Name,
- $this->Title,
- array( '-1' => '(Any)',
- 'on' => 'Selected',
- '0' => 'Not selected' )
- );
- }
+ return $checkbox->FieldHolder();
}
+
+ function populateFromPostData( $data ) {
+ $this->setField('Checked', isset($data['Checked']) ? $data['Checked'] : null);
+ parent::populateFromPostData( $data );
+ }
+
+ function getFormField() {
+ return new CheckboxField( $this->Name, $this->Title, $this->getField('Default') );
+ }
+
+ function getFilterField() {
+ return new OptionsetField( $this->Name,
+ $this->Title,
+ array( '-1' => '(Any)',
+ 'on' => 'Selected',
+ '0' => 'Not selected' )
+ );
+ }
+}
?>
\ No newline at end of file
diff --git a/forms/EditableCheckboxGroupField.php b/forms/EditableCheckboxGroupField.php
index 025ddd40b..c01ccce92 100755
--- a/forms/EditableCheckboxGroupField.php
+++ b/forms/EditableCheckboxGroupField.php
@@ -1,15 +1,16 @@
"Varchar",
+ "Title" => "Varchar",
+ "Default" => "Boolean",
+ "Sort" => "Int"
+ );
+ static $has_one = array(
+ "Parent" => "EditableCheckboxGroupField",
+ );
+
+ static $singular_name = "Checkbox option";
+ static $plural_name = "Checkbox options";
+
+ function EditSegment() {
+ return $this->renderWith('EditableFormFieldOption');
+ }
+
+ function TitleField() {
+ return new TextField( "Fields[{$this->ParentID}][{$this->ID}][Title]", null, $this->Title );
+ }
+
+ function Name() {
+ return "Fields[{$this->ParentID}][{$this->ID}]";
+ }
+
+ function populateFromPostData( $data ) {
+ $this->Title = $data['Title'];
+ $this->setField('Default', $data['Default']);
+ $this->Sort = $data['Sort'];
+ $this->write();
+ }
+
+ function Option() {
+ // return new radio field
+ /*$title = Convert::raw2att( $this->Title );
- // add required here?
- static $db = array(
- "Name" => "Varchar",
- "Title" => "Varchar",
- "Default" => "Boolean",
- "Sort" => "Int"
- );
- static $has_one = array(
- "Parent" => "EditableCheckboxGroupField",
- );
+ $default = "";
+
+ if( $this->getField('Default') )
+ $default = '+';
+ else
+ $default = '-';
+
+ //Debug::show($this);
+ return '';*/
+
+ return $this->EditSegment();
+ }
+
+ function ReadonlyOption() {
+ $this->readonly = true;
+ return $this->EditSegment();
+ }
+
+ function DefaultSelect() {
+ if( $this->readonly )
+ $disabled = " disabled=\"disabled\"";
- static $singular_name = "Checkbox option";
- static $plural_name = "Checkbox options";
+ if( $this->getField('Default') )
+ $default = " checked=\"checked\"";
- function EditSegment() {
- return $this->renderWith('EditableFormFieldOption');
- }
-
- function TitleField() {
- return new TextField( "Fields[{$this->ParentID}][{$this->ID}][Title]", null, $this->Title );
- }
-
- function Name() {
- return "Fields[{$this->ParentID}][{$this->ID}]";
- }
-
- function populateFromPostData( $data ) {
- $this->Title = $data['Title'];
- $this->setField('Default', $data['Default']);
- $this->Sort = $data['Sort'];
- $this->write();
- }
-
- function Option() {
- // return new radio field
- /*$title = Convert::raw2att( $this->Title );
-
- $default = "";
-
- if( $this->getField('Default') )
- $default = '+';
- else
- $default = '-';
-
- //Debug::show($this);
- return '';*/
-
- return $this->EditSegment();
- }
-
- function ReadonlyOption() {
- $this->readonly = true;
- return $this->EditSegment();
- }
-
- function DefaultSelect() {
- if( $this->readonly )
- $disabled = " disabled=\"disabled\"";
-
- if( $this->getField('Default') )
- $default = " checked=\"checked\"";
-
- return "ParentID}][{$this->ID}][Default]\" value=\"1\"".$disabled.$default." />";
- }
- }
+ return "ParentID}][{$this->ID}][Default]\" value=\"1\"".$disabled.$default." />";
+ }
+}
?>
\ No newline at end of file
diff --git a/forms/EditableDateField.php b/forms/EditableDateField.php
index e7f1e7193..e910602f9 100755
--- a/forms/EditableDateField.php
+++ b/forms/EditableDateField.php
@@ -1,13 +1,15 @@
readonly = true;
- return $this->EditSegment();
- }
-
- function isReadonly() {
- return $this->readonly;
- }
-
- static $default_sort = "Sort";
-
+/**
+ * EditableDropdownOption
+ * Represents a single entry in an EditableDropdown
+ * @package forms
+ * @subpackage fieldeditor
+ */
+class EditableDropdownOption extends DataObject {
+ protected $readonly;
+
+ function ReadonlyOption() {
+ $this->readonly = true;
+ return $this->EditSegment();
+ }
+
+ function isReadonly() {
+ return $this->readonly;
+ }
+
+ static $default_sort = "Sort";
+
// add required here?
static $db = array(
"Name" => "Varchar",
@@ -35,7 +35,7 @@
static $has_one = array(
"Parent" => "EditableDropdown",
);
-
+
static $singular_name = 'Dropdown option';
static $plural_name = 'Dropdown options';
@@ -56,29 +56,29 @@
$this->Sort = $data['Sort'];
$this->write();
}
-
- function Option() {
- // return new radio field
- /*$title = $this->Title;
-
- $default = "";
-
- if( $this->getField('Default') )
- $default = 'class="default"';
-
- //Debug::show($this);
- return '';*/
-
- return $this->EditSegment();
- }
-
- function DefaultSelect() {
- $disabled = ($this->readonly) ? " disabled=\"disabled\"" : '';
-
- if( $this->Parent()->getField('Default') == $this->ID )
- $default = " checked=\"checked\"";
-
- return "ParentID}][Default]\" value=\"{$this->ID}\"".$disabled.$default." />";
- }
- }
+
+ function Option() {
+ // return new radio field
+ /*$title = $this->Title;
+
+ $default = "";
+
+ if( $this->getField('Default') )
+ $default = 'class="default"';
+
+ //Debug::show($this);
+ return '';*/
+
+ return $this->EditSegment();
+ }
+
+ function DefaultSelect() {
+ $disabled = ($this->readonly) ? " disabled=\"disabled\"" : '';
+
+ if( $this->Parent()->getField('Default') == $this->ID )
+ $default = " checked=\"checked\"";
+
+ return "ParentID}][Default]\" value=\"{$this->ID}\"".$disabled.$default." />";
+ }
+}
?>
\ No newline at end of file
diff --git a/forms/EditableEmailField.php b/forms/EditableEmailField.php
index 66d0253b5..9fec75af4 100755
--- a/forms/EditableEmailField.php
+++ b/forms/EditableEmailField.php
@@ -1,14 +1,16 @@
readonly = true;
- return $this->EditSegment();
- }
-
- function isReadonly() {
- return $this->readonly;
- }
-
- static $default_sort = "Sort";
+class EditableRadioOption extends DataObject {
+ protected $readonly;
+ function ReadonlyOption() {
+ $this->readonly = true;
+ return $this->EditSegment();
+ }
+
+ function isReadonly() {
+ return $this->readonly;
+ }
+
+ static $default_sort = "Sort";
+
// add required here?
static $db = array(
"Name" => "Varchar",
"Title" => "Varchar",
"Default" => "Boolean",
- "Value" => "Varchar",
+ "Value" => "Varchar",
"Sort" => "Int"
);
static $has_one = array(
"Parent" => "EditableRadioField",
);
-
+
static $singular_name = 'Radio option';
static $plural_name = 'Radio options';
@@ -57,34 +57,34 @@
$this->Sort = $data['Sort'];
$this->write();
}
-
- function Option() {
- // return new radio field
- /*$title = Convert::raw2att( $this->Title );
-
- $default = "";
-
- if( $this->getField('Default') )
- $default = '+';
- else
- $default = '-';
-
- //Debug::show($this);
- return '';*/
-
- return $this->EditSegment();
- }
-
- function DefaultSelect() {
- $disabled = ($this->readonly) ? " disabled=\"disabled\"" : '';
-
- if($this->Parent()->getField('Default') == $this->ID) {
- $default = " checked=\"checked\"";
+
+ function Option() {
+ // return new radio field
+ /*$title = Convert::raw2att( $this->Title );
+
+ $default = "";
+
+ if( $this->getField('Default') )
+ $default = '+';
+ else
+ $default = '-';
+
+ //Debug::show($this);
+ return '';*/
+
+ return $this->EditSegment();
+ }
+
+ function DefaultSelect() {
+ $disabled = ($this->readonly) ? " disabled=\"disabled\"" : '';
+
+ if($this->Parent()->getField('Default') == $this->ID) {
+ $default = " checked=\"checked\"";
} else {
$default = '';
}
-
- return "ParentID}][Default]\" value=\"{$this->ID}\"".$disabled.$default." />";
- }
- }
+
+ return "ParentID}][Default]\" value=\"{$this->ID}\"".$disabled.$default." />";
+ }
+}
?>
\ No newline at end of file
diff --git a/forms/EditableTextField.php b/forms/EditableTextField.php
index 096f8a075..5b161d8b2 100755
--- a/forms/EditableTextField.php
+++ b/forms/EditableTextField.php
@@ -1,13 +1,15 @@
id() . "\" name=\"{$this->name}\" value=\"" . $this->attrValue() . "\" />";
diff --git a/forms/FieldGroup.php b/forms/FieldGroup.php
index dc0688aed..06496a4ad 100755
--- a/forms/FieldGroup.php
+++ b/forms/FieldGroup.php
@@ -1,10 +1,18 @@
tag, if the Title is set.
+ * @package forms
+ * @subpackage fields-structural
*/
class FieldGroup extends CompositeField {
protected $zebra;
diff --git a/forms/FieldSet.php b/forms/FieldSet.php
index 30d0b0609..f3d1f3dea 100755
--- a/forms/FieldSet.php
+++ b/forms/FieldSet.php
@@ -1,10 +1,15 @@
tags.
+ * @package forms
+ * @subpackage actions
*/
class FormAction extends FormField {
protected $extraData;
diff --git a/forms/FormField.php b/forms/FormField.php
index 0ec89875f..6f239ea61 100644
--- a/forms/FormField.php
+++ b/forms/FormField.php
@@ -1,8 +1,8 @@
transform(new MyTransformation());
+ * @package forms
+ * @subpackage transformations
*/
class FormTransformation extends Object {
function transform(FormField $field) {
diff --git a/forms/GSTNumberField.php b/forms/GSTNumberField.php
index ab556a0b6..03f950316 100755
--- a/forms/GSTNumberField.php
+++ b/forms/GSTNumberField.php
@@ -1,6 +1,14 @@
s.
+ * Returns a