silverstripe / silverstripe-framework

ORM/Hierarchy/Hierarchy.php

Doc Comments +3 added lines, -3 removed lines

@@ -419,7 +419,7 @@ 
 	/**
 	 * Return the IDs of all the marked nodes.
 	 *
-	 * @return array
+	 * @return integer[]
 	 */
 	public function markedNodeIDs() {
 		return array_keys($this->markedNodes);
@@ -636,7 +636,7 @@ 
 	/**
 	 * Return all the children that this page had, including pages that were deleted from both stage & live.
 	 *
-	 * @return DataList
+	 * @return \SilverStripe\ORM\DataList
 	 * @throws Exception
 	 */
 	public function AllHistoricalChildren() {
@@ -826,7 +826,7 @@ 
 	 * Get the next node in the tree of the type. If there is no instance of the className descended from this node,
 	 * then search the parents.
 	 * @param string     $className Class name of the node to find.
-	 * @param string|int $root      ID/ClassName of the node to limit the search to
+	 * @param integer $root      ID/ClassName of the node to limit the search to
 	 * @param DataObject $afterNode Used for recursive calls to this function
 	 * @return DataObject
 	 */

ORM/Queries/SQLExpression.php

Doc Comments +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 	/**
 	 * Execute this query.
 	 *
-	 * @return SS_Query
+	 * @return \SilverStripe\ORM\Connect\SS_Query
 	 */
 	public function execute() {
 		$sql = $this->sql($parameters);

ORM/Versioning/ChangeSetItem.php

Doc Comments +4 added lines, -4 removed lines

@@ -138,7 +138,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);
@@ -147,7 +147,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);
@@ -331,7 +331,7 @@ 
 	 * Get the ChangeSetItems that reference a passed DataObject
 	 *
 	 * @param DataObject $object
-	 * @return DataList
+	 * @return \SilverStripe\ORM\DataList
 	 */
 	public static function get_for_object($object) {
 		return ChangeSetItem::get()->filter([
@@ -345,7 +345,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\ORM\DataList
 	 */
 	public static function get_for_object_by_id($objectID, $objectClass) {
 		return ChangeSetItem::get()->filter([

ORM/Versioning/Versioned.php

Doc Comments +7 added lines, -7 removed lines

@@ -1069,7 +1069,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
@@ -1189,7 +1189,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param null|DataObject $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1299,7 +1299,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
@@ -1374,7 +1374,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -1439,7 +1439,7 @@ 
 	/**
 	 * Get the latest published DataObject.
 	 *
-	 * @return DataObject
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -1918,7 +1918,7 @@ 
 	/**
 	 * Determine if the current user is able to set the given site stage / archive
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param \SS_HTTPRequest $request
 	 * @return bool
 	 */
 	public static function can_choose_site_stage($request) {
@@ -2431,7 +2431,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {

ORM/Versioning/VersionedGridFieldItemRequest.php

Doc Comments +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
      *
      * @param array $data
      * @param Form $form
-	 * @return SS_HTTPResponse
+	 * @return \SS_HTTPResponse|null
      */
 	public function doArchive($data, $form) {
 		$record = $this->getRecord();

search/SearchContext.php

Doc Comments +1 added lines, -1 removed lines

@@ -179,7 +179,7 @@
 	 * @param array $searchParams
 	 * @param array|bool|string $sort
 	 * @param array|bool|string $limit
-	 * @return SS_List
+	 * @return DataList
 	 * @throws Exception
 	 */
 	public function getResults($searchParams, $sort = false, $limit = false) {

security/Member.php

Doc Comments +3 added lines, -3 removed lines

@@ -826,7 +826,7 @@ 
 	/**
 	 * Returns the current logged in user
 	 *
-	 * @return Member|null
+	 * @return DataObject|null
 	 */
 	public static function currentUser() {
 		$id = Member::currentUserID();
@@ -1270,7 +1270,7 @@ 
 	 * If no $groups is passed, all members will be returned
 	 *
 	 * @param mixed $groups - takes a SS_List, an array or a single Group.ID
-	 * @return SS_Map Returns an SS_Map that returns all Member data.
+	 * @return SilverStripe\ORM\SS_Map Returns an SS_Map that returns all Member data.
 	 */
 	public static function map_in_groups($groups = null) {
 		$groupIDList = array();
@@ -1308,7 +1308,7 @@ 
 	 *
 	 * @param array $groups Groups to consider or NULL to use all groups with
 	 *                      CMS permissions.
-	 * @return SS_Map Returns a map of all members in the groups given that
+	 * @return SilverStripe\ORM\SS_Map Returns a map of all members in the groups given that
 	 *                have CMS permissions.
 	 */
 	public static function mapInCMSGroups($groups = null) {

tests/i18n/i18nTextCollectorTest.php

Doc Comments +10 added lines

@@ -843,6 +843,10 @@ 
  * Assist with testing of specific protected methods
  */
 class i18nTextCollectorTest_Collector extends i18nTextCollector implements TestOnly {
+
+	/**
+	 * @param string $directory
+	 */
 	public function getModules_Test($directory) {
 		return $this->getModules($directory);
 	}
@@ -851,6 +855,9 @@ 
 		return $this->resolveDuplicateConflicts($entitiesByModule);
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public function getFileListForModule_Test($module) {
 		return $this->getFileListForModule($module);
 	}
@@ -859,6 +866,9 @@ 
 		return $this->getConflicts($entitiesByModule);
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function findModuleForClass_Test($class) {
 		return $this->findModuleForClass($class);
 	}

tests/model/VersionedOwnershipTest.php

Doc Comments +2 added lines, -2 removed lines

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