silverstripe-australia / advancedworkflow

code/admin/AdvancedWorkflowAdmin.php

Doc Comments +1 added lines, -2 removed lines

@@ -214,9 +214,8 @@
 	/**
 	 * Get WorkflowInstance Target objects to show for users in initial gridfield(s)
 	 *
-	 * @param Member $member
 	 * @param string $fieldName The name of the gridfield that determines which dataset to return
-	 * @return DataList
+	 * @return ArrayList
 	 * @todo Add the ability to see embargo/expiry dates in report-gridfields at-a-glance if QueuedJobs module installed
 	 */
 	public function userObjects(Member $user, $fieldName) {

code/admin/WorkflowDefinitionExporter.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 	 * Used for pushing data to the browser to prompt for download
 	 * 
 	 * @param string $str
-	 * @return number $bytes
+	 * @return integer $bytes
 	 */
 	public function getExportSize($str) {
 		return mb_strlen($str, 'UTF-8');

code/controllers/FrontEndWorkflowController.php

Doc Comments +1 added lines, -1 removed lines

@@ -79,7 +79,7 @@
 	 * - required fields from the Context Object
 	 * - Actions from the connected WorkflowTransitions
 	 * 
-	 * @return Form
+	 * @return null|FrontendWorkflowForm
 	 */
 	public function Form(){
 		

code/dataobjects/WorkflowAction.php

Doc Comments +3 added lines, -3 removed lines

@@ -53,7 +53,7 @@ 
 	 * if null is returned from this method.
 	 *
 	 * @param  DataObject $target
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function canEditTarget(DataObject $target) {
 		return null;
@@ -63,7 +63,7 @@ 
 	 * Does this action restrict viewing of the document?
 	 *
 	 * @param  DataObject $target
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function canViewTarget(DataObject $target) {
 		return null;
@@ -73,7 +73,7 @@ 
 	 * Does this action restrict the publishing of a document?
 	 *
 	 * @param  DataObject $target
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function canPublishTarget(DataObject $target) {
 		return null;

code/dataobjects/WorkflowActionInstance.php

Doc Comments +7 added lines

@@ -43,6 +43,7 @@ 
 
 	/**
 	 * Gets fields for when this is part of an active workflow
+	 * @param FieldList $fields
 	 */
 	public function updateWorkflowFields($fields) {
 		if ($this->BaseAction()->AllowCommenting) {
@@ -50,6 +51,9 @@ 
 		}
 	}
 
+	/**
+	 * @param FieldList $fields
+	 */
 	public function updateFrontendWorkflowFields($fields){
 		if ($this->BaseAction()->AllowCommenting) {
 			$fields->push(new TextareaField('WorkflowActionInstanceComment', _t('WorkflowAction.FRONTENDCOMMENT', 'Comment')));
@@ -82,6 +86,9 @@ 
 		return $obj;
 	}
 
+	/**
+	 * @param FieldList $actions
+	 */
 	public function updateFrontEndWorkflowActions($actions) {
 		$ba = $this->BaseAction();
 

code/dataobjects/WorkflowDefinition.php

Doc Comments +2 added lines, -1 removed lines

@@ -392,7 +392,7 @@ 
 	/**
 	 *
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function canView($member=null) {
 		return $this->userHasAccess($member);
@@ -437,6 +437,7 @@ 
 	 * Checks whether the passed user is able to view this ModelAdmin
 	 *
 	 * @param $memberID
+	 * @param Member|null $member
 	 */
 	protected function userHasAccess($member) {
 		if (!$member) {

code/dataobjects/WorkflowInstance.php

Doc Comments +4 added lines, -3 removed lines

@@ -428,6 +428,7 @@ 
 	 * workflow
 	 *
 	 * @param $memberID
+	 * @param Member|null $member
 	 */
 	protected function userHasAccess($member) {
 		if (!$member) {
@@ -479,7 +480,7 @@ 
 	/**
 	 * Does this action restrict the publishing of a document?
 	 *
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function canPublishTarget() {
 		if ($this->CurrentActionID) {
@@ -491,7 +492,7 @@ 
 	 * Get the current set of transitions that are valid for the current workflow state,
 	 * and are available to the current user.
 	 *
-	 * @return array
+	 * @return ArrayList
 	 */
 	public function validTransitions() {
 		$action    = $this->CurrentAction();
@@ -647,7 +648,7 @@ 
 	/**
 	 * Tells us if $member has had permissions over some part of the current WorkflowInstance.
 	 *
-	 * @param $member
+	 * @param Member $member
 	 * @return \WorkflowAction | boolean
 	 */
 	public function getMostRecentActionForUser($member = null) {

code/extensions/WorkflowApplicable.php

Doc Comments +1 added lines

@@ -285,6 +285,7 @@
 	/**
 	 * Gets the history of a workflow instance
 	 *
+	 * @param integer $limit
 	 * @return DataObjectSet
 	 */
 	public function getWorkflowHistory($limit = null) {

code/formfields/WorkflowField.php

Doc Comments +4 added lines

@@ -15,6 +15,10 @@
 
 	protected $definition;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title, WorkflowDefinition $definition) {
 		$this->definition = $definition;
 		$this->addExtraClass('workflow-field');