silverstripe / silverstripe-framework

ORM/DataQuery.php

Doc Comments +2 added lines, -2 removed lines

@@ -98,7 +98,7 @@ 
 	/**
 	 * Remove a filter from the query
 	 *
-	 * @param string|array $fieldExpression The predicate of the condition to remove
+	 * @param string|null $fieldExpression The predicate of the condition to remove
 	 * (ignoring parameters). The expression will be considered a match if it's
 	 * contained within any other predicate.
 	 * @return DataQuery Self reference
@@ -177,7 +177,7 @@ 
 	/**
 	 * Ensure that the query is ready to execute.
 	 *
-	 * @param array|null $queriedColumns Any columns to filter the query by
+	 * @param string[] $queriedColumns Any columns to filter the query by
 	 * @return SQLSelect The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {

ORM/Versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -1065,7 +1065,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1185,7 +1185,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param Member|null $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1295,7 +1295,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -1371,7 +1371,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -1436,7 +1436,7 @@ 
 	/**
 	 * Determines if the current draft version is the same as live
 	 *
-	 * @return bool
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -2433,7 +2433,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {

Security/Security.php

Doc Comments +2 added lines, -2 removed lines

@@ -507,7 +507,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -1082,7 +1082,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;

View/SSTemplateParser.php

Doc Comments +7 added lines, -3 removed lines

@@ -114,6 +114,8 @@ 
 
 	/**
 	 * Override the function that constructs the result arrays to also prepare a 'php' item in the array
+	 * @param string $matchrule
+	 * @param string $name
 	 */
 	function construct($matchrule, $name, $arguments = null) {
 		$res = parent::construct($matchrule, $name, $arguments);
@@ -175,9 +177,9 @@ 
 
 	/**
 	 * Ensures that the arguments to addOpenBlock and addClosedBlock are valid
-	 * @param $name
-	 * @param $callable
-	 * @param $type
+	 * @param string $name
+	 * @param callable $callable
+	 * @param string $type
 	 * @throws InvalidArgumentException
 	 */
 	protected function validateExtensionBlock($name, $callable, $type) {
@@ -262,6 +264,7 @@ 
 	 * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to
 	 * get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj)
 	 * depending on the context the lookup is used in.
+	 * @param string $method
 	 */
 	function Lookup_AddLookupStep(&$res, $sub, $method) {
 		$res['LookupSteps'][] = $sub;
@@ -1174,6 +1177,7 @@ 
 
 	/**
 	 * @param string $code
+	 * @param string $templateName
 	 * @return string $code
 	 */
 	protected function includeDebuggingComments($code, $templateName) {

admin/code/LeftAndMain.php

Doc Comments +4 added lines, -4 removed lines

@@ -252,7 +252,7 @@ 
 	/**
 	 * Gets the combined configuration of all LeafAndMain subclasses required by the client app.
 	 *
-	 * @return array
+	 * @return string
 	 *
 	 * WARNING: Experimental API
 	 */
@@ -691,7 +691,7 @@ 
 	 *
 	 * @param string $url
 	 * @param int $code
-	 * @return HTTPResponse|string
+	 * @return string|null
 	 */
 	public function redirect($url, $code=302) {
 		if($this->getRequest()->isAjax()) {
@@ -969,7 +969,7 @@ 
 	 * {@link SSViewer::get_templates_by_class()}
 	 *
 	 * @param string $suffix
-	 * @return array
+	 * @return string
 	 */
 	public function getTemplatesWithSuffix($suffix) {
 		$templates = SSViewer::get_templates_by_class(get_class($this), $suffix, __CLASS__);
@@ -2039,7 +2039,7 @@ 
 	}
 
 	/**
-	 * @return String
+	 * @return DBField
 	 */
 	public function Locale() {
 		return DBField::create_field('Locale', i18n::get_locale());

Control/Controller.php

Doc Comments +3 added lines, -2 removed lines

@@ -142,6 +142,7 @@ 
 	 * {@inheritdoc}
 	 *
 	 * Also set the URLParams
+	 * @param HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$return = parent::setRequest($request);
@@ -501,7 +502,7 @@ 
 	 *
 	 * @param array $params
 	 *
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -664,7 +665,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');

Control/HTTPRequest.php

Doc Comments +2 added lines, -2 removed lines

@@ -427,9 +427,9 @@
 	 * it's only advisable to send small files through this method.
 	 *
 	 * @static
-	 * @param $fileData
+	 * @param string $fileData
 	 * @param $fileName
-	 * @param null $mimeType
+	 * @param string $mimeType
 	 * @return SS_HTTPResponse
 	 */
 	public static function send_file($fileData, $fileName, $mimeType = null) {

Control/RequestHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -289,7 +289,7 @@
 	 *
 	 * Must not raise HTTPResponse_Exceptions - instead it should return
 	 *
-	 * @param $request
+	 * @param HTTPRequest $request
 	 * @param $action
 	 * @return HTTPResponse
 	 */

View/Parsers/HTMLValue.php

Doc Comments +1 added lines

@@ -139,6 +139,7 @@
 	/**
 	 * Get the body element, or false if there isn't one (we haven't loaded any content
 	 * or this instance is in an invalid state)
+	 * @return \DOMElement
 	 */
 	public function getBody() {
 		$doc = $this->getDocument();