fix(docblock): Updated docblock and removed depreciated method

Signed-off-by: Stuart McCulloch Anderson's avatarStuart McCulloch Anderson <stuart@nxfifteen.me.uk>
parent 406718ea
......@@ -112,7 +112,7 @@ class ApiBabel
/**
* @param Fitbit $fitbitapi
*
* @todo Consider test case
*/
public function setLibrary($fitbitapi)
{
......@@ -122,7 +122,7 @@ class ApiBabel
/**
* @param mixed $userAccessToken
*
* @todo Consider test case
*/
public function setUserAccessToken($userAccessToken)
{
......@@ -134,7 +134,6 @@ class ApiBabel
* @param string $trigger
* @param bool $return
*
* @todo Consider test case
* @return mixed|null|SimpleXMLElement|string
*/
public function pull($user, $trigger, $return = false)
......@@ -410,7 +409,7 @@ class ApiBabel
/**
* @param mixed $activeUser
*
* @todo Consider test case
*/
public function setActiveUser($activeUser)
{
......@@ -736,7 +735,6 @@ class ApiBabel
* @param string $trigger
* @param bool $quiet
*
* @todo Consider test case
* @return bool|string
*/
public function isAllowed($trigger, $quiet = false)
......@@ -778,7 +776,6 @@ class ApiBabel
* @param string $trigger
* @param bool $reset
*
* @todo Consider test case
* @return bool
*/
public function isTriggerCooled($trigger, $reset = false)
......@@ -919,7 +916,6 @@ class ApiBabel
/**
* @param string|int $xml
*
* @todo Consider test case
* @return bool
*/
public function isApiError($xml)
......@@ -1012,7 +1008,6 @@ class ApiBabel
* @param bool $debugOutput
* @param bool $supportFailures
*
* @todo Consider test case
* @return mixed
*/
public function pullBabel($path, $returnObject = false, $debugOutput = false, $supportFailures = false)
......@@ -1079,15 +1074,15 @@ class ApiBabel
die();
} else {
$this->getAppClass()->getErrorRecording()->captureException( $e, array(
'level' => 'error',
'extra' => array(
'api_path' => $path,
'user' => $this->activeUser,
'php_version' => phpversion(),
'core_version' => $this->getAppClass()->getSetting( "version", "0.0.0.1", TRUE )
),
) );
$this->getAppClass()->getErrorRecording()->captureException($e, array(
'level' => 'error',
'extra' => array(
'api_path' => $path,
'user' => $this->activeUser,
'php_version' => phpversion(),
'core_version' => $this->getAppClass()->getSetting("version", "0.0.0.1", TRUE)
),
));
if ($supportFailures) {
return $e->getCode();
} else {
......@@ -1137,7 +1132,6 @@ class ApiBabel
}
/**
* @todo Consider test case
* @return Fitbit
*/
public function getLibrary()
......@@ -3017,7 +3011,6 @@ class ApiBabel
* @param string $user
* @param string $string
*
* @todo Consider test case
* @return bool|int
*/
public function getDBCurrentBody($user, $string)
......@@ -3339,7 +3332,6 @@ class ApiBabel
* @param string|DateTime $baseDate DateTime or 'today', to_period
* @param string|DateTime $to_period DateTime or '1d, 7d, 30d, 1w, 1m, 3m, 6m, 1y, max'
*
* @todo Consider test case
* @return array|boolean
*/
public function getTimeSeries($type, $baseDate, $to_period)
......@@ -3839,7 +3831,7 @@ class ApiBabel
/**
* @param boolean $forceSync
*
* @todo Consider test case
*/
public function setForceSync($forceSync)
{
......@@ -3849,7 +3841,6 @@ class ApiBabel
/**
* @param string $_nx_fb_usr
*
* @todo Consider test case
* @return bool
*/
public function validateOAuth($_nx_fb_usr)
......@@ -3889,7 +3880,6 @@ class ApiBabel
/**
* @param mixed $newUserProfile
*
* @todo Consider test case
* @return bool
*/
public function createNewUser($newUserProfile)
......
......@@ -402,7 +402,6 @@ class Config
*
* @param string $fuid User fuid
* @param string $key Setting to query
* @param string $value Value to store
*
* @return bool was data stored correctly
*/
......
......@@ -271,8 +271,8 @@ class Core
}
/**
* @param bool $reset
* @param string $userFitbitId
* @param bool $reset
*
* @return ApiBabel
*/
......
This diff is collapsed.
......@@ -121,7 +121,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return Config
*/
public function getSettings()
......@@ -130,7 +129,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return Medoo
*/
public function getDatabase()
......@@ -139,7 +137,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return String
*/
public function getInstallingVersion()
......@@ -148,7 +145,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return int
*/
public function getNumUpdates()
......@@ -161,7 +157,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return array
*/
public function getUpdatesRequired()
......@@ -206,7 +201,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return String
*/
public function getInstallVersion()
......@@ -227,7 +221,6 @@ class Upgrade
* @param null $default
* @param bool $query_db
*
* @todo Consider test case
* @return string
*/
public function getSetting($key, $default = null, $query_db = true)
......@@ -250,7 +243,6 @@ class Upgrade
* @param string $value
* @param bool $query_db
*
* @todo Consider test case
* @return bool
*/
public function setSetting($key, $value, $query_db = true)
......@@ -259,7 +251,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return array
*/
public function getUpdates()
......@@ -272,7 +263,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return array
*/
public function getUpdateFunctions()
......@@ -285,7 +275,6 @@ class Upgrade
}
/**
* @todo Consider test case
* @return bool
*/
public function runUpdates()
......
......@@ -118,7 +118,6 @@ class Gaming extends Delivery
*
* @param array $key Setting to query
* @param array $value Value to store
* @param bool $query_db Boolean to store in database or not
*
* @return bool was data stored correctly
*/
......
......@@ -92,7 +92,6 @@ class Modules
$this->getRewardsClass()->issueAwards($recordReward, $rewardKey, "pending", $recordReward['system']);
$this->getRewardsClass()->setRewardReason($recordReward['name'] . "|" . $recordReward['description']);
$this->getRewardsClass()->notifyUser("icon-diamond", "bg-success", '+2 hours');
nxr(3, "File Award Processed '" . $recordReward['name'] . "', " . $recordReward['description']);
} else {
......@@ -129,11 +128,6 @@ class Modules
if ($state != "noaward") {
$this->getRewardsClass()->issueAwards($recordReward, $rewardKey, $state, $delivery);
$this->getRewardsClass()->setRewardReason($recordReward['name'] . "|" . $recordReward['description']);
if ($state == "pending") {
$this->getRewardsClass()->notifyUser("icon-hourglass", "bg-primary", '+6 hours');
} else {
$this->getRewardsClass()->notifyUser("icon-diamond", "bg-success", '+2 hours');
}
nxr(3, "DB Award Processed '" . $recordReward['name'] . "', " . $recordReward['description']);
}
......@@ -201,7 +195,6 @@ class Modules
}
/**
* @todo Consider test case
* @return String
*/
protected function getUserID()
......@@ -210,7 +203,6 @@ class Modules
}
/**
* @todo Consider test case
*
* @param String $UserID
*/
......
......@@ -208,8 +208,8 @@ class Rewards
/**
* @param array $recordReward
* @param string $state
* @param string $rewardKey
* @param string $state
* @param string $delivery
*/
public function issueAwards($recordReward, $rewardKey, $state = "pending", $delivery = "Default")
......@@ -307,18 +307,6 @@ class Rewards
]);
}
/**
* @deprecated
*
* @param string $ico Icon to use in notification
* @param string $icoColour Colour of icon
* @param string $expire Time notification will expire
*/
public function notifyUser($ico, $icoColour, $expire)
{
$bold = "";
}
/**
* @return array
*/
......
......@@ -73,7 +73,6 @@ class RewardsSystem
}
/**
* @todo Consider test case
* @return String
*/
public function getUserMinecraftID()
......@@ -93,7 +92,6 @@ class RewardsSystem
}
/**
* @todo Consider test case
* @return array
*/
public function queryMinecraftRewards()
......@@ -206,7 +204,6 @@ class RewardsSystem
}
/**
* @todo Consider test case
* @return String
*/
public function getUserID()
......@@ -215,7 +212,6 @@ class RewardsSystem
}
/**
* @todo Consider test case
*
* @param String $UserID
*/
......
......@@ -99,7 +99,6 @@ class NxFitAdmin
* @param null $default
* @param bool $query_db
*
* @todo Consider test case
* @return string
*/
public function getApiSetting($key = "", $default = null, $query_db = true)
......@@ -108,7 +107,6 @@ class NxFitAdmin
}
/**
* @todo Consider test case
* @return Config
*/
public function getApiSettingClass()
......@@ -117,7 +115,6 @@ class NxFitAdmin
}
/**
* @todo Consider test case
* @return Core
*/
public function getNxFit()
......@@ -126,7 +123,6 @@ class NxFitAdmin
}
/**
* @todo Consider test case
* @return medoo
*/
public function getDatabase()
......@@ -145,7 +141,6 @@ class NxFitAdmin
/**
* @param string $key
*
* @todo Consider test case
* @return array
*/
public function getConfig($key = "")
......@@ -160,7 +155,7 @@ class NxFitAdmin
/**
* @param array $config
*
* @todo Consider test case
*/
public function setConfig($config)
{
......@@ -215,7 +210,6 @@ class NxFitAdmin
}
/**
* @todo Consider test case
* @return Config
*/
public function getUserProfile()
......@@ -245,7 +239,6 @@ class NxFitAdmin
}
/**
* @todo Consider test case
* @return string
*/
public function getActiveUser()
......@@ -256,7 +249,7 @@ class NxFitAdmin
/**
* @param string $activeUser
*
* @todo Consider test case
*/
public function setActiveUser($activeUser)
{
......@@ -266,7 +259,6 @@ class NxFitAdmin
/**
* @param null $scope
*
* @todo Consider test case
* @return DateTime
*/
public function getOldestScope($scope = null)
......@@ -306,7 +298,6 @@ class NxFitAdmin
}
/**
* @todo Consider test case
* @return string
*/
public function getLocalWeatherImage()
......@@ -354,7 +345,6 @@ class NxFitAdmin
}
/**
* @todo Consider test case
* @return string
*/
public function getLocalWeatherCode()
......@@ -371,7 +361,6 @@ class NxFitAdmin
}
/**
* @todo Consider test case
* @return string|array
*/
public function getUserTheme()
......@@ -385,7 +374,6 @@ class NxFitAdmin
/**
* @param string $trigger
*
* @todo Consider test case
* @return DateTime
*/
public function getScopeCoolDown($trigger)
......@@ -413,7 +401,6 @@ class NxFitAdmin
* @param string $string
* @param array $array
*
* @todo Consider test case
* @return string
*/
public function getThemeWidgets($string, $array)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment