silverstripe / silverstripe-framework

model/DataObject.php

Doc Comments +13 added lines, -6 removed lines

@@ -549,7 +549,7 @@ 
 	 * The destinationObject must be written to the database already and have an ID. Writing is performed
 	 * automatically when adding the new relations.
 	 *
-	 * @param $sourceObject the source object to duplicate from
+	 * @param DataObject $sourceObject the source object to duplicate from
 	 * @param $destinationObject the destination object to populate with the duplicated relations
 	 * @return DataObject with the new many_many relations copied in
 	 */
@@ -956,6 +956,7 @@ 
 	 * @param $includeRelations Boolean Merge any existing relations (optional)
 	 * @param $overwriteWithEmpty Boolean Overwrite existing left values with empty right values.
 	 *                            Only applicable with $priority='right'. (optional)
+	 * @param DataObject|null $rightObj
 	 * @return Boolean
 	 */
 	public function merge($rightObj, $priority = 'right', $includeRelations = true, $overwriteWithEmpty = false) {
@@ -1579,10 +1580,10 @@ 
 	 *
 	 * @param string $componentName Name of the component
 	 * @param string|null $filter Deprecated. A filter to be inserted into the WHERE clause
-	 * @param string|null|array $sort Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted,
+	 * @param string $sort Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted,
 	 *                                the static field $default_sort on the component class will be used.
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
-	 * @param string|null|array $limit Deprecated. A limit expression to be inserted into the LIMIT clause
+	 * @param string $limit Deprecated. A limit expression to be inserted into the LIMIT clause
 	 *
 	 * @return HasManyList The components of the one-to-many relationship.
 	 */
@@ -1642,7 +1643,7 @@ 
 	/**
 	 * Find the foreign class of a relation on this DataObject, regardless of the relation type.
 	 *
-	 * @param $relationName Relation name.
+	 * @param string $relationName Relation name.
 	 * @return string Class name, or null if not found.
 	 */
 	public function getRelationClass($relationName) {
@@ -2208,6 +2209,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2675,7 +2677,7 @@ 
 	 * can be saved into the Image table.
 	 *
 	 * @param string $fieldName Name of the field
-	 * @param mixed $value New field value
+	 * @param mixed $val New field value
 	 * @return DataObject $this
 	 */
 	public function setCastedField($fieldName, $val) {
@@ -2695,6 +2697,7 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $field
 	 */
 	public function castingHelper($field) {
 		if ($fieldSpec = $this->db($field)) {
@@ -3059,6 +3062,7 @@ 
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
 	 * @param $fieldPath string
+	 * @param string $fieldName
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3127,7 +3131,7 @@ 
 	 * @param string $callerClass The class of objects to be returned
 	 * @param string|array $filter A filter to be inserted into the WHERE clause.
 	 * Supports parameterised queries. See SQLQuery::addWhere() for syntax examples.
-	 * @param string|array $sort A sort expression to be inserted into the ORDER
+	 * @param string $sort A sort expression to be inserted into the ORDER
 	 * BY clause.  If omitted, self::$default_sort will be used.
 	 * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
 	 * @param string|array $limit A limit expression to be inserted into the LIMIT clause.
@@ -3178,6 +3182,7 @@ 
 
 	/**
 	 * @deprecated
+	 * @param string $class
 	 */
 	public function Aggregate($class = null) {
 		Deprecation::notice('4.0', 'Call aggregate methods on a DataList directly instead. In templates'
@@ -3199,6 +3204,7 @@ 
 
 	/**
 	 * @deprecated
+	 * @param string $relationship
 	 */
 	public function RelationshipAggregate($relationship) {
 		Deprecation::notice('4.0', 'Call aggregate methods on a relationship directly instead.');
@@ -3367,6 +3373,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

model/Image.php

Doc Comments +4 added lines, -4 removed lines

@@ -589,7 +589,7 @@ 
 	/**
 	 * Resize this image for the CMS. Use in templates with $CMSThumbnail
 	 *
-	 * @return Image_Cached|null
+	 * @return Image|null
 	 */
 	public function CMSThumbnail() {
 		return $this->Pad($this->stat('cms_thumbnail_width'),$this->stat('cms_thumbnail_height'));
@@ -631,7 +631,7 @@ 
 	/**
 	 * Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.
 	 *
-	 * @return Image_Cached|null
+	 * @return Image|null
 	 */
 	public function StripThumbnail() {
 		return $this->Fill($this->stat('strip_thumbnail_width'),$this->stat('strip_thumbnail_height'));
@@ -868,7 +868,7 @@ 
 	/**
 	 * Generate patterns that will help to match filenames of cached images
 	 * @param string $filename Filename of source image
-	 * @return array
+	 * @return string
 	 */
 	private function getFilenamePatterns($filename) {
 		$methodNames = $this->allMethodNames(true);
@@ -1024,7 +1024,7 @@ 
 
 	/**
 	 * Get the orientation of this image.
-	 * @return ORIENTATION_SQUARE | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE
+	 * @return integer | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE
 	 */
 	public function getOrientation() {
 		$width = $this->getWidth();

model/URLSegmentFilter.php

Doc Comments +1 added lines

@@ -89,6 +89,7 @@
 	 * Determines if the field should render open or closed by default.
 	 * 
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function startClosed($bool) {
 		($bool) ? $this->addExtraClass('startClosed') : $this->removeExtraClass('startClosed');

model/Versioned.php

Doc Comments +6 added lines, -7 removed lines

@@ -758,7 +758,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
@@ -832,7 +832,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -898,7 +898,7 @@ 
 	/**
 	 * Get the latest published version of this object.
 	 *
-	 * @return DataObject
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -1022,7 +1022,7 @@ 
 	 * @param string $limit
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
 	 * @param string $having
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function Versions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
 		return $this->allVersions($filter, $sort, $limit, $join, $having);
@@ -1036,7 +1036,7 @@ 
 	 * @param  string $limit
 	 * @param  string $join Deprecated, use leftJoin($table, $joinClause) instead
 	 * @param  string $having
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function allVersions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
 		// Make sure the table names are not postfixed (e.g. _Live)
@@ -1144,7 +1144,6 @@ 
 	 * - If $_GET['archiveDate'] is set, it will use that date, and store it in the session.
 	 * - If neither of these are set, it checks the session, otherwise the stage is set to 'Live'.
 	 *
-	 * @param Session $session Optional session within which to store the resulting stage
 	 */
 	public static function choose_site_stage() {
 		// Check any pre-existing session mode
@@ -1356,7 +1355,7 @@ 
 	 * @param string     $filter         A filter to be inserted into the WHERE clause.
 	 * @param string     $sort           A sort expression to be inserted into the ORDER BY clause.
 	 * @param string     $join           Deprecated, use leftJoin($table, $joinClause) instead
-	 * @param string|int $limit          A limit on the number of records returned from the database.
+	 * @param integer $limit          A limit on the number of records returned from the database.
 	 * @param string     $containerClass The container class for the result set (default is DataList)
 	 *
 	 * @return DataList A modified DataList designated to the specified stage

oembed/Oembed.php

Doc Comments +6 added lines, -1 removed lines

@@ -46,6 +46,7 @@ 
 	 *
 	 * @param $url Human-readable URL.
 	 * @returns string/bool URL of an endpoint, or false if no matching provider exists.
+	 * @return string
 	 */
 	protected static function find_endpoint($url) {
 		foreach(self::get_providers() as $scheme=>$endpoint) {
@@ -117,7 +118,7 @@ 
 	 * Given a response body, determine if there is an autodiscover url
 	 *
 	 * @param string $body
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function autodiscover_from_body($body) {
 		// Look within the body for an oembed link.
@@ -259,6 +260,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getOembedURL() {
 		return $this->url;
 	}
@@ -343,6 +347,7 @@ 
 
 	/**
 	 * Wrap the check for looking into Oembed JSON within $this->data.
+	 * @param string $field
 	 */
 	public function hasField($field) {
 		$this->loadData();

security/Security.php

Doc Comments +4 added lines, -5 removed lines

@@ -466,7 +466,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return HTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -646,7 +646,6 @@ 
 	 * - t: plaintext token
 	 *
 	 * @param Member $member Member object associated with this link.
-	 * @param string $autoLoginHash The auto login token.
 	 */
 	public static function getPasswordResetLink($member, $autologinToken) {
 		$autologinToken = urldecode($autologinToken);
@@ -737,7 +736,7 @@ 
 	/**
 	 * Factory method for the lost password form
 	 *
-	 * @return Form Returns the lost password form
+	 * @return Security Returns the lost password form
 	 */
 	public function ChangePasswordForm() {
 		return Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
@@ -921,7 +920,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1076,7 +1075,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;