From 60860cc1b996e6630885f9bd0031b647492aa807 Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Sun, 15 Jun 2008 13:33:53 +0000 Subject: [PATCH] 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 | 6 ------ api/RestfulServer.php | 3 +++ api/RestfulService.php | 6 ------ api/SapphireSoapServer.php | 6 ------ api/SimplePie.php | 6 ------ api/Spyc.php | 2 -- cli/CliController.php | 6 ------ cli/DailyTask.php | 6 ------ cli/MonthlyTask.php | 6 ------ cli/ScheduledTask.php | 6 ------ cli/WeeklyTask.php | 6 ------ cli/YearlyTask.php | 6 ------ core/ArrayData.php | 6 ------ core/ArrayLib.php | 6 ------ core/ClassInfo.php | 6 ------ core/Convert.php | 6 ------ core/Cookie.php | 6 ------ core/Extension.php | 6 ------ core/HTTP.php | 6 ------ core/Mailer.php | 4 ++++ core/ManifestBuilder.php | 10 +--------- core/Requirements.php | 6 ------ core/SSViewer.php | 6 ------ core/Session.php | 6 ------ core/TokenisedRegularExpression.php | 2 ++ core/ValidationResult.php | 2 ++ core/ViewableData.php | 6 ------ core/control/ContentController.php | 6 ------ core/control/ContentNegotiator.php | 5 ----- core/control/Controller.php | 6 ------ core/control/Director.php | 6 ------ core/control/FormResponse.php | 6 ------ core/control/HTTPResponse.php | 6 ------ core/control/ModelAsController.php | 6 ------ core/control/NestedController.php | 6 ------ core/control/RootURLController.php | 6 ------ core/control/SapphireInfo.php | 3 ++- core/i18n.php | 6 ------ core/model/ComponentSet.php | 5 ----- core/model/CurrentPageIdentifier.php | 8 ++------ core/model/DB.php | 6 ------ core/model/DataObject.php | 6 ------ core/model/DataObjectDecorator.php | 7 ------- core/model/DataObjectLog.php | 6 ------ core/model/Database.php | 6 ------ core/model/ErrorPage.php | 5 ----- core/model/GhostPage.php | 5 ----- core/model/HiddenClass.php | 5 ----- core/model/Hierarchy.php | 6 ------ core/model/Image.php | 6 ------ core/model/MySQLDatabase.php | 6 ------ core/model/PDODatabase.php | 6 ------ core/model/RedirectorPage.php | 6 ------ core/model/SQLMap.php | 6 ------ core/model/SQLQuery.php | 6 ------ core/model/SiteTree.php | 5 ----- core/model/Translatable.php | 6 ------ core/model/Versioned.php | 6 ------ core/model/VirtualPage.php | 5 ----- core/model/fieldtypes/Boolean.php | 6 ------ core/model/fieldtypes/Currency.php | 6 ------ core/model/fieldtypes/DBField.php | 6 ------ core/model/fieldtypes/Date.php | 6 ------ core/model/fieldtypes/Datetime.php | 6 ------ core/model/fieldtypes/Decimal.php | 6 ------ core/model/fieldtypes/Double.php | 3 ++- core/model/fieldtypes/Enum.php | 6 ------ core/model/fieldtypes/Float.php | 6 ------ core/model/fieldtypes/HTMLText.php | 6 ------ core/model/fieldtypes/HTMLVarchar.php | 6 ------ core/model/fieldtypes/Int.php | 6 ------ core/model/fieldtypes/Percentage.php | 6 ------ core/model/fieldtypes/SSDatetime.php | 6 ------ core/model/fieldtypes/Text.php | 6 ------ core/model/fieldtypes/Time.php | 6 ------ core/model/fieldtypes/Varchar.php | 6 ------ core/model/fieldtypes/Year.php | 5 ----- dev/BuildTask.php | 2 ++ dev/CSSContentParser.php | 3 +++ dev/Debug.php | 6 ------ dev/DebugView.php | 5 ----- dev/DevelopmentAdmin.php | 2 ++ dev/FunctionalTest.php | 3 +++ dev/InstallerTest.php | 8 +------- dev/MigrationTask.php | 4 +++- dev/TaskRunner.php | 5 ++++- dev/TestMailer.php | 4 ++-- dev/TestOnly.php | 3 ++- dev/TestRunner.php | 1 - dev/TestSession.php | 3 ++- dev/TestViewer.php | 3 ++- email/Notifications.php | 5 ----- email/QueuedEmail.php | 6 ------ email/QueuedEmailDispatchTask.php | 6 ------ filesystem/Archive.php | 6 ------ filesystem/File.php | 6 ------ filesystem/Filesystem.php | 3 +-- filesystem/Folder.php | 6 ------ filesystem/GD.php | 6 ------ filesystem/PostBackup.php | 6 ------ filesystem/TarballArchive.php | 6 ------ forms/AjaxFormAction.php | 6 ------ forms/AjaxUniqueTextField.php | 6 ------ forms/AutocompleteTextField.php | 6 ------ forms/BankAccountField.php | 6 ------ forms/CalendarDateField.php | 6 ------ forms/CheckboxField.php | 6 ------ forms/CheckboxFieldDisabled.php | 6 ------ forms/CheckboxSetField.php | 6 ------ forms/ComplexRequiredFields.php | 6 ------ forms/ComplexTableField.php | 6 ------ forms/CompositeDateField.php | 6 ------ forms/CompositeField.php | 6 ------ forms/ConfirmedFormAction.php | 6 ------ forms/CountryDropdownField.php | 6 ------ forms/CreditCardField.php | 6 ------ forms/CurrencyField.php | 6 ------ forms/CustomRequiredFields.php | 6 ------ forms/CustomValidator.php | 6 ------ forms/DMYCalendarDateField.php | 6 ------ forms/DMYDateField.php | 6 ------ forms/DataReport.php | 6 ------ forms/DatalessField.php | 6 ------ forms/DateField.php | 6 ------ forms/DisabledTransformation.php | 6 ------ forms/DropdownField.php | 6 ------ forms/DropdownTimeField.php | 6 ------ forms/EditForm.php | 6 ------ forms/EditableButton.php | 6 ------ forms/EditableCheckbox.php | 6 ------ forms/EditableCheckboxGroupField.php | 6 ------ forms/EditableCheckboxOption.php | 6 ------ forms/EditableDateField.php | 6 ------ forms/EditableDropdown.php | 6 ------ forms/EditableDropdownOption.php | 6 ------ forms/EditableEmailField.php | 6 ------ forms/EditableFileField.php | 3 +-- forms/EditableFormField.php | 6 ------ forms/EditableFormHeading.php | 6 ------ forms/EditableMemberListField.php | 6 ------ forms/EditableRadioField.php | 6 ------ forms/EditableRadioOption.php | 6 ------ forms/EditableTextField.php | 6 ------ forms/EmailField.php | 6 ------ forms/EncryptField.php | 6 ------ forms/FieldGroup.php | 6 ------ forms/FieldSet.php | 6 ------ forms/FormAction.php | 6 ------ forms/FormField.php | 6 ------ forms/FormTransformation.php | 6 ------ forms/GSTNumberField.php | 6 ------ forms/GroupedDropdownField.php | 6 ------ forms/HasManyComplexTableField.php | 6 ------ forms/HasOneComplexTableField.php | 6 ------ forms/HeaderField.php | 6 ------ forms/HiddenField.php | 6 ------ forms/HiddenFieldGroup.php | 6 ------ forms/HtmlEditorField.php | 6 ------ forms/HtmlOneLineField.php | 6 ------ forms/ImageField.php | 6 ------ forms/ImageFormAction.php | 6 ------ forms/InlineFormAction.php | 6 ------ forms/LabelField.php | 6 ------ forms/LabelledLiteralField.php | 6 ------ forms/LanguageDropdownField.php | 6 ------ forms/ListboxField.php | 6 ------ forms/LiteralField.php | 6 ------ forms/LookupField.php | 6 ------ forms/ManyManyComplexTableField.php | 16 +++++----------- forms/NamedLabelField.php | 6 ------ forms/NoScriptField.php | 6 ------ forms/NoScriptFormAction.php | 6 ------ forms/NumericField.php | 6 ------ forms/OptionsetField.php | 6 ------ forms/PasswordField.php | 6 ------ forms/PhoneNumberField.php | 6 ------ forms/PopupDateTimeField.php | 6 ------ forms/PrintableTransformation.php | 6 ------ forms/ProgressBar.php | 6 ------ forms/ReadonlyField.php | 6 ------ forms/ReadonlyTransformation.php | 6 ------ forms/RelatedDataEditor.php | 6 ------ forms/ReportField.php | 6 ------ forms/RequiredFields.php | 6 ------ forms/ResetFormAction.php | 6 ------ forms/RestrictedTextField.php | 6 ------ forms/SQLReport.php | 6 ------ forms/SelectionGroup.php | 6 ------ forms/SimpleImageField.php | 6 ------ forms/SubmittedFileField.php | 5 ----- forms/SubmittedForm.php | 5 ----- forms/SubmittedFormField.php | 5 ----- forms/SubmittedFormReportField.php | 5 ----- forms/Tab.php | 6 ------ forms/TabSet.php | 5 ----- forms/TableListField.php | 6 ------ forms/TabularStyle.php | 6 ------ forms/TextField.php | 6 ------ forms/TextareaField.php | 6 ------ forms/TimeField.php | 6 ------ forms/ToggleCompositeField.php | 6 ------ forms/ToggleField.php | 6 ------ forms/TreeDropdownField.php | 6 ------ forms/TreeMultiselectField.php | 6 ------ forms/TreeSelectorField.php | 6 ------ forms/TypeDropdown.php | 6 ------ forms/UniqueRestrictedTextField.php | 6 ------ forms/UniqueTextField.php | 6 ------ forms/Validator.php | 6 ------ forms/editor/FieldEditor.php | 6 ------ integration/XML.php | 6 ------ misc/GoogleSitemap.php | 6 ------ parsers/BBCodeParser.php | 9 --------- parsers/HTML/BBCodeParser/Filter.php | 7 ------- parsers/HTML/HTMLBBCodeParser.php | 6 ------ parsers/TextParser.php | 6 ------ profiler/Profiler.php | 6 ------ search/AdvancedSearchForm.php | 6 ------ search/SearchForm.php | 6 ------ security/Authenticator.php | 6 ------ security/BasicAuth.php | 6 ------ security/ChangePasswordForm.php | 6 ------ security/Geoip.php | 7 ------- security/Group.php | 6 ------ security/LoginForm.php | 7 ------- security/Member.php | 7 ------- security/MemberAuthenticator.php | 7 ------- security/MemberLoginForm.php | 6 ------ security/MemberPassword.php | 3 ++- security/NZGovtPasswordValidator.php | 3 ++- security/PasswordValidator.php | 3 +++ security/Permission.php | 6 ------ security/PermissionDropdownField.php | 6 ------ security/PermissionProvider.php | 6 ------ security/Security.php | 6 ------ tests/DataObjectTest.php | 9 ++------- tests/ManifestBuilderTest.php | 5 ++++- tests/ObjectTest.php | 5 ++++- tests/SiteTreeTest.php | 8 ++------ tests/TokenisedRegularExpressionTest.php | 5 ++++- tests/api/RSSFeedTest.php | 5 ++++- tests/api/RestfulServerTest.php | 5 ++++- tests/control/DirectorTest.php | 4 ++++ tests/control/RootURLControllerTest.php | 5 ++++- tests/fieldtypes/CurrencyTest.php | 5 ++++- tests/filesystem/UploadTest.php | 4 ++++ tests/forms/FormTest.php | 4 ++++ tests/i18nTest.php | 5 ++++- tests/security/GroupTest.php | 5 ++++- tests/security/MemberTest.php | 5 ++++- tests/security/SecurityTest.php | 3 +++ tests/testing/CSSContentParserTest.php | 5 ++++- widgets/Widget.php | 6 ------ widgets/WidgetArea.php | 6 ------ widgets/WidgetFormProxy.php | 5 ++++- 255 files changed, 125 insertions(+), 1330 deletions(-) diff --git a/api/RSSFeed.php b/api/RSSFeed.php index eda9de17f..708564afa 100755 --- a/api/RSSFeed.php +++ b/api/RSSFeed.php @@ -1,10 +1,4 @@ value pairs generated from database queries. * The query isn't actually executed until you need it. diff --git a/core/model/SQLQuery.php b/core/model/SQLQuery.php index 2a2839cdb..d4cc01090 100755 --- a/core/model/SQLQuery.php +++ b/core/model/SQLQuery.php @@ -1,10 +1,4 @@ assertExactMatchBySelector("#MyForm_ID p.error", array("That email address is invalid.")); * } * + * + * @package sapphire + * @subpackage testing */ class FunctionalTest extends SapphireTest { /** diff --git a/dev/InstallerTest.php b/dev/InstallerTest.php index e56a5dce6..f35f972e1 100644 --- a/dev/InstallerTest.php +++ b/dev/InstallerTest.php @@ -1,14 +1,8 @@ tag. * @package forms diff --git a/forms/DropdownTimeField.php b/forms/DropdownTimeField.php index 3d19b8857..73ef8b0d4 100644 --- a/forms/DropdownTimeField.php +++ b/forms/DropdownTimeField.php @@ -1,10 +1,4 @@ tags. diff --git a/forms/FormField.php b/forms/FormField.php index 9bfdd6ec3..3616694b6 100644 --- a/forms/FormField.php +++ b/forms/FormField.php @@ -1,10 +1,4 @@ tags. * diff --git a/forms/HasManyComplexTableField.php b/forms/HasManyComplexTableField.php index 9ad5b8038..9bdf462c5 100644 --- a/forms/HasManyComplexTableField.php +++ b/forms/HasManyComplexTableField.php @@ -1,10 +1,4 @@ tags which are then converted with javascript. diff --git a/forms/HtmlOneLineField.php b/forms/HtmlOneLineField.php index 0c53b52b8..b37277555 100755 --- a/forms/HtmlOneLineField.php +++ b/forms/HtmlOneLineField.php @@ -1,10 +1,4 @@ tags which are then converted with javascript. diff --git a/forms/ImageField.php b/forms/ImageField.php index c8df0a556..e36a81f94 100755 --- a/forms/ImageField.php +++ b/forms/ImageField.php @@ -1,10 +1,4 @@ tag. * @package forms diff --git a/forms/LiteralField.php b/forms/LiteralField.php index 3578b87a0..4211fff7e 100755 --- a/forms/LiteralField.php +++ b/forms/LiteralField.php @@ -1,10 +1,4 @@ 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 { } } -?> +?> diff --git a/forms/NamedLabelField.php b/forms/NamedLabelField.php index 433989f39..e9f78b391 100755 --- a/forms/NamedLabelField.php +++ b/forms/NamedLabelField.php @@ -1,10 +1,4 @@ and * @package forms diff --git a/forms/ReadonlyTransformation.php b/forms/ReadonlyTransformation.php index 6a3ffddf2..98f325c55 100755 --- a/forms/ReadonlyTransformation.php +++ b/forms/ReadonlyTransformation.php @@ -1,10 +1,4 @@ - * @package sapphire - * @subpackage security - */ - /** * Abstract base class for a login form * diff --git a/security/Member.php b/security/Member.php index f139c78cf..e4459ede2 100644 --- a/security/Member.php +++ b/security/Member.php @@ -1,11 +1,4 @@ - */ - /** * Authenticator for the default "member" method * diff --git a/security/MemberLoginForm.php b/security/MemberLoginForm.php index bcb435974..ad880f539 100644 --- a/security/MemberLoginForm.php +++ b/security/MemberLoginForm.php @@ -1,10 +1,4 @@ + * + * @package sapphire + * @subpackage security */ class PasswordValidator extends Object { static $character_strength_tests = array( diff --git a/security/Permission.php b/security/Permission.php index bcf25a9c0..9bb0d6b90 100755 --- a/security/Permission.php +++ b/security/Permission.php @@ -1,10 +1,4 @@ test

test

"); diff --git a/widgets/Widget.php b/widgets/Widget.php index 295a846a5..75bf70801 100644 --- a/widgets/Widget.php +++ b/widgets/Widget.php @@ -1,10 +1,4 @@ urlParams['ID']);