silverstripe / silverstripe-framework

filesystem/FileMigrationHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 	/**
 	 * Get list of File dataobjects to import
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	protected function getFileQuery() {
 		// Select all records which have a Filename value, but not FileFilename.

model/connect/MySQLStatement.php

Doc Comments +2 added lines, -2 removed lines

@@ -78,8 +78,8 @@
 
 	/**
 	 * Hook the result-set given into a Query class, suitable for use by SilverStripe.
-	 * @param mysqli_stmt $statement The related statement, if present
-	 * @param mysqli_result $metadata The metadata for this statement
+	 * @param \mysqli_stmt $statement The related statement, if present
+	 * @param \mysqli_result $metadata The metadata for this statement
 	 */
 	public function __construct($statement, $metadata) {
 		$this->statement = $statement;

model/versioning/ChangeSetItem.php

Doc Comments +4 added lines, -4 removed lines

@@ -132,7 +132,7 @@ 
 	 * Find version of this object in the given stage
 	 *
 	 * @param string $stage
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectInStage($stage) {
 		return Versioned::get_by_stage($this->ObjectClass, $stage)->byID($this->ObjectID);
@@ -141,7 +141,7 @@ 
 	/**
 	 * Find latest version of this object
 	 *
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectLatestVersion() {
 		return Versioned::get_latest_version($this->ObjectClass, $this->ObjectID);
@@ -325,7 +325,7 @@ 
 	 * Get the ChangeSetItems that reference a passed DataObject
 	 *
 	 * @param DataObject $object
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public static function get_for_object($object) {
 		return ChangeSetItem::get()->filter([
@@ -339,7 +339,7 @@ 
 	 *
 	 * @param int $objectID The ID of the object
 	 * @param string $objectClass The class of the object (or any parent class)
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public static function get_for_object_by_id($objectID, $objectClass) {
 		return ChangeSetItem::get()->filter([

tests/model/VersionedOwnershipTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -728,7 +728,7 @@ 
 	/**
 	 * All custom objects with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function Custom() {
 		$title = str_replace('Page', 'Custom', $this->Title);
@@ -782,7 +782,7 @@ 
 	/**
 	 * All pages with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function Pages() {
 		$title = str_replace('Custom', 'Page', $this->Title);

admin/code/CampaignAdmin.php

Doc Comments +8 added lines, -8 removed lines

@@ -194,9 +194,9 @@ 
 	/**
 	 * REST endpoint to get a list of campaigns.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	public function readCampaigns(HTTPRequest $request) {
 		$response = new HTTPResponse();
@@ -335,7 +335,7 @@ 
 	/**
 	 * Gets viewable list of campaigns
 	 *
-	 * @return SS_List
+	 * @return SilverStripe\Model\ArrayList
 	 */
 	protected function getListItems() {
 		return ChangeSet::get()
@@ -349,7 +349,7 @@ 
 	/**
 	 * REST endpoint to get a campaign.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return SS_HTTPResponse
 	 */
@@ -382,9 +382,9 @@ 
 	/**
 	 * REST endpoint to delete a campaign.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	public function deleteCampaign(HTTPRequest $request) {
 		$id = $request->param('ID');
@@ -409,9 +409,9 @@ 
 	/**
 	 * REST endpoint to publish a {@link ChangeSet} and all of its items.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	public function publishCampaign(HTTPRequest $request) {
 		// Protect against CSRF on destructive action

admin/code/CMSBatchActionHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -127,7 +127,7 @@ 
 	 * Respond with the list of applicable pages for a given filter
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	public function handleApplicablePages($request) {
 		// Find the action handler
@@ -154,7 +154,7 @@ 
 	 * Check if this action has a confirmation step
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse
 	 */
 	public function handleConfirmation($request) {
 		// Find the action handler

admin/code/LeftAndMain.php

Doc Comments +8 added lines, -4 removed lines

@@ -199,7 +199,7 @@ 
 	/**
 	 * Gets the combined configuration of all LeafAndMain subclasses required by the client app.
 	 *
-	 * @return array
+	 * @return string
 	 *
 	 * WARNING: Experimental API
 	 */
@@ -283,7 +283,7 @@ 
 	 * schema if X-Formschema-Request header is set.
 	 *
 	 * @param Form $form
-	 * @return SS_HTTPResponse
+	 * @return HTTPResponse|null
 	 */
 	protected function getSchemaResponse($form) {
 		$request = $this->getRequest();
@@ -889,6 +889,7 @@ 
 	 * Return a list of appropriate templates for this class, with the given suffix using
 	 * {@link SSViewer::get_templates_by_class()}
 	 *
+	 * @param string $suffix
 	 * @return array
 	 */
 	public function getTemplatesWithSuffix($suffix) {
@@ -1758,7 +1759,7 @@ 
 	 * The controller might not have any previewable content, in which case
 	 * this method returns FALSE.
 	 *
-	 * @return String|boolean
+	 * @return boolean
 	 */
 	public function LinkPreview() {
 		return false;
@@ -1945,7 +1946,7 @@ 
 	}
 
 	/**
-	 * @return String
+	 * @return DBField
 	 */
 	public function Locale() {
 		return DBField::create_field('Locale', i18n::get_locale());
@@ -2111,6 +2112,9 @@ 
 		return (parent::isFinished() || $this->isFinished);
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setIsFinished($bool) {
 		$this->isFinished = $bool;
 	}

admin/code/ModelAdmin.php

Doc Comments +3 added lines

@@ -117,6 +117,9 @@
 		Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/client/dist/js/ModelAdmin.js');
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		if(!$action) $action = $this->sanitiseClassName($this->modelClass);
 		return parent::Link($action);

control/ContentNegotiator.php

Doc Comments +4 added lines, -3 removed lines

@@ -119,6 +119,7 @@ 
 	/**
 	 * Returns true if negotiation is enabled for the given response. By default, negotiation is only
 	 * enabled for pages that have the xml header.
+	 * @param HTTPResponse $response
 	 */
 	public static function enabled_for($response) {
 		$contentType = $response->getHeader("Content-Type");
@@ -134,7 +135,7 @@ 
 	}
 
 	/**
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public static function process(HTTPResponse $response) {
 		if(!self::enabled_for($response)) return;
@@ -184,7 +185,7 @@ 
 	 * Replaces a few common tags and entities with their XHTML representations (<br>, <img>, &nbsp;
 	 * <input>, checked, selected).
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 *
 	 * @todo Search for more xhtml replacement
 	 */
@@ -224,7 +225,7 @@ 
 	 * - Replaces all occurrences of "application/xhtml+xml" with "text/html" in the template.
 	 * - Removes "xmlns" attributes and any <?xml> Pragmas.
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public function html(HTTPResponse $response) {
 		$encoding = Config::inst()->get('SilverStripe\Control\ContentNegotiator', 'encoding');