sminnee / silverstripe-framework

tests/view/ContentNegotiatorTest.php

Doc Comments +1 added lines

@@ -5,6 +5,7 @@
 	/**
 	 * Small helper to render templates from strings
 	 * Cloned from SSViewerTest
+	 * @param string $templateString
 	 */
 	private function render($templateString, $data = null) {
 		$t = SSViewer::fromString($templateString);

model/DataObject.php

Unused Use Statements -3 removed lines

@@ -2,10 +2,8 @@ 
 
 namespace SilverStripe\Model;
 
-use SilverStripe\Model\FieldType\DBPolymorphicForeignKey;
 use SilverStripe\Model\FieldType\DBField;
 use SilverStripe\Model\FieldType\DBDatetime;
-use SilverStripe\Model\FieldType\DBPrimaryKey;
 use SilverStripe\Model\FieldType\DBComposite;
 use SilverStripe\Model\FieldType\DBClassName;
 use Object;
@@ -14,7 +12,6 @@ 
 use i18nEntityProvider;
 use Config;
 use FieldList;
-
 use SQLSelect;
 
 

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');

control/Controller.php

Doc Comments +6 added lines, -6 removed lines

@@ -143,10 +143,10 @@ 
 	 * $this->pushCurrent() and end the method with $this->popCurrent(). Failure to do this will create
 	 * weird session errors.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @param DataModel $model
 	 *
-	 * @return SS_HTTPResponse
+	 * @return string
 	 */
 	public function handleRequest(HTTPRequest $request, DataModel $model) {
 		if(!$request) user_error("Controller::handleRequest() not passed a request!", E_USER_ERROR);
@@ -281,7 +281,7 @@ 
 	/**
 	 * Sets the SS_HTTPResponse object that this controller is building up.
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 *
 	 * @return $this
 	 */
@@ -322,7 +322,7 @@ 
 	 *
 	 * @param string $action
 	 *
-	 * @return HTMLText
+	 * @return \SilverStripe\Model\FieldType\DBField
 	 */
 	public function defaultAction($action) {
 		return $this->getViewer($action)->process($this);
@@ -458,7 +458,7 @@ 
 	 *
 	 * @param array $params
 	 *
-	 * @return string
+	 * @return \SilverStripe\Model\FieldType\DBField
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -623,7 +623,7 @@ 
 	 * Tests whether a redirection has been requested. If redirect() has been called, it will return
 	 * the URL redirected to. Otherwise, it will return null.
 	 *
-	 * @return null|string
+	 * @return boolean
 	 */
 	public function redirectedTo() {
 		return $this->getResponse() && $this->getResponse()->getHeader('Location');

Unused Use Statements -2 removed lines

@@ -16,8 +16,6 @@
 
 use SilverStripe\Model\DataModel;
 use BasicAuth;
-
-
 use Debug;
 use Object;
 use SSViewer;

control/Director.php

Doc Comments +4 added lines, -4 removed lines

@@ -414,7 +414,7 @@ 
 	/**
 	 * Handle an HTTP request, defined with a SS_HTTPRequest object.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @param Session $session
 	 * @param DataModel $model
 	 *
@@ -560,7 +560,7 @@ 
 	 * Returns the domain part of the URL 'http://www.mysite.com'. Returns FALSE is this environment
 	 * variable isn't set.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function protocolAndHost() {
 		$alternate = Config::inst()->get('SilverStripe\Control\Director', 'alternate_base_url');
@@ -893,7 +893,7 @@ 
 	/**
 	 * Returns true if the given file exists. Filename should be relative to the site root.
 	 *
-	 * @param $file
+	 * @param string $file
 	 *
 	 * @return bool
 	 */
@@ -1111,7 +1111,7 @@ 
 	 * Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and
 	 * {@link Director::isLive()}.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function get_environment_type() {
 		if (Director::isLive()) {

Unused Use Statements -3 removed lines

@@ -9,9 +9,6 @@
 use Injector;
 use ArrayIterator;
 use ViewableData;
-
-
-
 use SilverStripe\Model\Filterable;
 use SilverStripe\Model\Sortable;
 use SilverStripe\Model\Limitable;