Simplify isAdmin function and add documentation

Jamie Snape · Jamie Snape · commit d00713fddbeb · 2015-09-14T10:00:41.000-04:00
diff --git a/core/models/dao/UserDao.php b/core/models/dao/UserDao.php
@@ -84,21 +84,17 @@ class UserDao extends AppDao
     /**
      * Return true if this user is an administrator.
      *
-     * @return bool
+     * @return bool true if this user is an administrator, false otherwise.
      */
     public function isAdmin()
     {
-        if ($this->getAdmin() == 1) {
-            return true;
-        }
-
-        return false;
+        return $this->getAdmin() == 1;
     }
 
     /**
      * Return the full name of this user.
      *
-     * @return string
+     * @return string full name of this user
      */
     public function getFullName()
     {

Original file line number	Diff line number	Diff line change
`@@ -84,21 +84,17 @@ class UserDao extends AppDao`
`84`	`84`	`/**`
`85`	`85`	`* Return true if this user is an administrator.`
`86`	`86`	`*`
`87`		`- * @return bool`
	`87`	`+ * @return bool true if this user is an administrator, false otherwise.`
`88`	`88`	`*/`
`89`	`89`	`public function isAdmin()`
`90`	`90`	`{`
`91`		`- if ($this->getAdmin() == 1) {`
`92`		`- return true;`
`93`		`- }`
`94`		`-`
`95`		`- return false;`
	`91`	`+ return $this->getAdmin() == 1;`
`96`	`92`	`}`
`97`	`93`
`98`	`94`	`/**`
`99`	`95`	`* Return the full name of this user.`
`100`	`96`	`*`
`101`		`- * @return string`
	`97`	`+ * @return string full name of this user`
`102`	`98`	`*/`
`103`	`99`	`public function getFullName()`
`104`	`100`	`{`