diff --git a/Blacklight/AniDB.php b/Blacklight/AniDB.php index 6d4c42237..7830affd1 100755 --- a/Blacklight/AniDB.php +++ b/Blacklight/AniDB.php @@ -21,21 +21,21 @@ class AniDB /** * Updates stored AniDB entries in the database. * - * @param int $anidbID - * @param string $title - * @param string $type - * @param string $startdate - * @param string $enddate - * @param string $related - * @param string $similar - * @param string $creators - * @param string $description - * @param string $rating - * @param string $categories - * @param string $characters - * @param $epnos - * @param $airdates - * @param $episodetitles + * @param int $anidbID + * @param string $title + * @param string $type + * @param string $startdate + * @param string $enddate + * @param string $related + * @param string $similar + * @param string $creators + * @param string $description + * @param string $rating + * @param string $categories + * @param string $characters + * @param $epnos + * @param $airdates + * @param $episodetitles */ public function updateTitle($anidbID, $title, $type, $startdate, $enddate, $related, $similar, $creators, $description, $rating, $categories, $characters, $epnos, $airdates, $episodetitles): void { @@ -94,9 +94,8 @@ class AniDB * Retrieves a list of Anime titles, optionally filtered by starting character and title. * * - * @param string $letter - * @param string $animetitle - * + * @param string $letter + * @param string $animetitle * @return array */ public function getAnimeList($letter = '', $animetitle = ''): array @@ -137,8 +136,7 @@ class AniDB * Retrieves a range of Anime titles for site display. * * - * @param string $animetitle - * + * @param string $animetitle * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator */ public function getAnimeRange($animetitle = ''): \Illuminate\Contracts\Pagination\LengthAwarePaginator @@ -162,7 +160,6 @@ class AniDB * * * @param $anidbID - * * @return mixed */ public function getAnimeInfo($anidbID) diff --git a/Blacklight/Backfill.php b/Blacklight/Backfill.php index 26d45c058..e8de18036 100755 --- a/Blacklight/Backfill.php +++ b/Blacklight/Backfill.php @@ -30,12 +30,14 @@ class Backfill /** * Log and or echo debug. + * * @var bool */ protected $_debug = false; /** * Echo to cli? + * * @var bool */ protected $_echoCLI; @@ -54,6 +56,7 @@ class Backfill /** * Should we disable the group if we have backfilled far enough? + * * @var bool */ protected $_disableBackfillGroup; @@ -66,7 +69,7 @@ class Backfill /** * Constructor. * - * @param array $options Class instances / Echo to cli? + * @param array $options Class instances / Echo to cli? * * @throws \Exception */ @@ -100,9 +103,10 @@ class Backfill } /** - * @param string $groupName - * @param string|int $articles - * @param string $type + * @param string $groupName + * @param string|int $articles + * @param string $type + * * @throws \Throwable */ public function backfillAllGroups($groupName = '', $articles = '', $type = ''): void @@ -162,11 +166,11 @@ class Backfill /** * Backfill single group. * - * @param array $groupArr - * @param int $left - * @param int|string $articles - * + * @param array $groupArr + * @param int $left + * @param int|string $articles * @return void + * * @throws \Throwable */ public function backfillGroup($groupArr, $left, $articles = ''): void @@ -329,7 +333,8 @@ class Backfill } /** - * @param string $articles + * @param string $articles + * * @throws \Throwable */ public function safeBackfill($articles = ''): void diff --git a/Blacklight/Binaries.php b/Blacklight/Binaries.php index 5e4c5fa0c..f51062122 100755 --- a/Blacklight/Binaries.php +++ b/Blacklight/Binaries.php @@ -114,12 +114,14 @@ class Binaries /** * Max tries to download headers. + * * @var int */ protected $_partRepairMaxTries; /** * An array of BinaryBlacklist IDs that should have their activity date updated. + * * @var array(int) */ protected $_binaryBlacklistIdsToUpdate = []; @@ -207,7 +209,7 @@ class Binaries /** * Constructor. * - * @param array $options Class instances / echo to CLI? + * @param array $options Class instances / echo to CLI? * * @throws \Exception */ @@ -247,9 +249,9 @@ class Binaries /** * Download new headers for all active groups. * - * @param int $maxHeaders (Optional) How many headers to download max. - * + * @param int $maxHeaders (Optional) How many headers to download max. * @return void + * * @throws \Exception * @throws \Throwable */ @@ -305,10 +307,10 @@ class Binaries /** * Download new headers for a single group. * - * @param array $groupMySQL Array of MySQL results for a single group. - * @param int $maxHeaders (Optional) How many headers to download max. - * + * @param array $groupMySQL Array of MySQL results for a single group. + * @param int $maxHeaders (Optional) How many headers to download max. * @return void + * * @throws \Exception * @throws \Throwable */ @@ -533,13 +535,13 @@ class Binaries /** * Loop over range of wanted headers, insert headers into DB. * - * @param array $groupMySQL The group info from mysql. - * @param int $first The oldest wanted header. - * @param int $last The newest wanted header. - * @param string $type Is this partrepair or update or backfill? - * @param null|array $missingParts If we are running in partrepair, the list of missing article numbers. - * + * @param array $groupMySQL The group info from mysql. + * @param int $first The oldest wanted header. + * @param int $last The newest wanted header. + * @param string $type Is this partrepair or update or backfill? + * @param null|array $missingParts If we are running in partrepair, the list of missing article numbers. * @return array Empty on failure. + * * @throws \Exception * @throws \Throwable */ @@ -742,7 +744,7 @@ class Binaries * Parse headers into collections/binaries and store header data as parts. * * - * @param array $headers + * @param array $headers * * @throws \Exception * @throws \Throwable @@ -941,9 +943,9 @@ class Binaries /** * Gets the First and Last Article Number and Date for the received headers. * - * @param array $returnArray - * @param array $headers - * @param int $msgCount + * @param array $returnArray + * @param array $headers + * @param int $msgCount */ protected function getHighLowArticleInfo(array &$returnArray, array $headers, int $msgCount): void { @@ -1017,9 +1019,9 @@ class Binaries /** * If we failed to insert Collections/Binaries/Parts, rollback the transaction and add the parts to part repair. * - * @param array $headers Array of headers containing sub-arrays with parts. - * + * @param array $headers Array of headers containing sub-arrays with parts. * @return array Array of article numbers to add to part repair. + * * @throws \Exception */ protected function _rollbackAddToPartRepair(array $headers): array @@ -1038,9 +1040,9 @@ class Binaries /** * Attempt to get missing article headers. * - * @param array $groupArr The info for this group from mysql. - * + * @param array $groupArr The info for this group from mysql. * @return void + * * @throws \Exception * @throws \Throwable */ @@ -1166,10 +1168,10 @@ class Binaries /** * Returns unix time for an article number. * - * @param int $post The article number to get the time from. - * @param array $groupData Usenet group info from NNTP selectGroup method. + * @param int $post The article number to get the time from. + * @param array $groupData Usenet group info from NNTP selectGroup method. + * @return int Timestamp. * - * @return int Timestamp. * @throws \Exception */ public function postdate($post, array $groupData): int @@ -1235,10 +1237,10 @@ class Binaries /** * Returns article number based on # of days. * - * @param int $days How many days back we want to go. - * @param array $data Group data from usenet. - * + * @param int $days How many days back we want to go. + * @param array $data Group data from usenet. * @return string + * * @throws \Exception */ public function daytopost($days, $data): string @@ -1332,10 +1334,8 @@ class Binaries /** * Add article numbers from missing headers to DB. * - * @param array $numbers The article numbers of the missing headers. - * @param int $groupID The ID of this groups. - * - * + * @param array $numbers The article numbers of the missing headers. + * @param int $groupID The ID of this groups. * @return string */ private function addMissingParts($numbers, $groupID): string @@ -1353,10 +1353,10 @@ class Binaries /** * Clean up part repair table. * - * @param array $numbers The article numbers. - * @param int $groupID The ID of the group. - * + * @param array $numbers The article numbers. + * @param int $groupID The ID of the group. * @return void + * * @throws \Throwable */ private function removeRepairedParts(array $numbers, $groupID): void @@ -1372,6 +1372,7 @@ class Binaries /** * Are white or black lists loaded for a group name? + * * @var array */ protected $_listsFound = []; @@ -1379,8 +1380,7 @@ class Binaries /** * Get blacklist and cache it. Return if already cached. * - * @param string $groupName - * + * @param string $groupName * @return void */ protected function _retrieveBlackList($groupName): void @@ -1397,9 +1397,8 @@ class Binaries /** * Check if an article is blacklisted. * - * @param array $msg The article header (OVER format). - * @param string $groupName The group name. - * + * @param array $msg The article header (OVER format). + * @param string $groupName The group name. * @return bool */ public function isBlackListed($msg, $groupName): bool @@ -1451,11 +1450,10 @@ class Binaries /** * Return all blacklists. * - * @param bool $activeOnly Only display active blacklists ? - * @param int|string $opType Optional, get white or black lists (use Binaries constants). - * @param string $groupName Optional, group. - * @param bool $groupRegex Optional Join groups / binaryblacklist using regexp for equals. - * + * @param bool $activeOnly Only display active blacklists ? + * @param int|string $opType Optional, get white or black lists (use Binaries constants). + * @param string $groupName Optional, group. + * @param bool $groupRegex Optional Join groups / binaryblacklist using regexp for equals. * @return array */ public function getBlacklist($activeOnly = true, $opType = -1, $groupName = '', $groupRegex = false): array @@ -1494,8 +1492,7 @@ class Binaries /** * Return the specified blacklist. * - * @param int $id The blacklist ID. - * + * @param int $id The blacklist ID. * @return \Illuminate\Database\Eloquent\Model|null|static */ public function getBlacklistByID($id) @@ -1506,7 +1503,7 @@ class Binaries /** * Delete a blacklist. * - * @param int $id The ID of the blacklist. + * @param int $id The ID of the blacklist. */ public function deleteBlacklist($id): void { @@ -1533,7 +1530,7 @@ class Binaries /** * Adds a new blacklist from binary blacklist edit admin web page. * - * @param array $blacklistArray + * @param array $blacklistArray */ public function addBlacklist($blacklistArray): void { @@ -1552,11 +1549,12 @@ class Binaries /** * Delete Collections/Binaries/Parts for a Collection ID. * - * @param int $collectionID Collections table ID + * @param int $collectionID Collections table ID * * @note A trigger automatically deletes the parts/binaries. * * @return void + * * @throws \Throwable */ public function delete($collectionID): void @@ -1569,9 +1567,9 @@ class Binaries /** * Log / Echo message. * - * @param string $message Message to log. - * @param string $method Method that called this. - * @param string $color ColorCLI method name. + * @param string $message Message to log. + * @param string $method Method that called this. + * @param string $color ColorCLI method name. */ private function log($message, $method, $color): void { @@ -1583,9 +1581,8 @@ class Binaries /** * Check if we should ignore the file count and return true or false. * - * @param string $groupName - * @param string $subject - * + * @param string $groupName + * @param string $subject * @return bool */ protected function _ignoreFileCount($groupName, $subject): bool @@ -1600,7 +1597,6 @@ class Binaries /** * @param $query - * * @return bool */ protected function runQuery($query) diff --git a/Blacklight/Books.php b/Blacklight/Books.php index bebd48fe4..d751ed702 100755 --- a/Blacklight/Books.php +++ b/Blacklight/Books.php @@ -73,7 +73,7 @@ class Books protected $colorCli; /** - * @param array $options Class instances / Echo to cli. + * @param array $options Class instances / Echo to cli. * * @throws \Exception */ @@ -104,7 +104,6 @@ class Books /** * @param $id - * * @return \Illuminate\Database\Eloquent\Model|null|static */ public function getBookInfo($id) @@ -114,7 +113,6 @@ class Books /** * @param $title - * * @return \Illuminate\Database\Eloquent\Model */ public function getBookInfoByName($title) @@ -138,14 +136,14 @@ class Books } /** - * @param $page - * @param $cat - * @param $start - * @param $num - * @param $orderby - * @param array $excludedcats - * + * @param $page + * @param $cat + * @param $start + * @param $num + * @param $orderby + * @param array $excludedcats * @return array + * * @throws \Exception */ public function getBookRange($page, $cat, $start, $num, $orderby, array $excludedcats = []): array @@ -236,7 +234,6 @@ class Books /** * @param $orderby - * * @return array */ public function getBookOrder($orderby): array @@ -422,7 +419,6 @@ class Books * @param $release_name * @param $releaseID * @param $releasetype - * * @return bool|string */ public function parseTitle($release_name, $releaseID, $releasetype) @@ -475,10 +471,10 @@ class Books } /** - * @param string $bookInfo - * @param null $amazdata - * + * @param string $bookInfo + * @param null $amazdata * @return false|int|string + * * @throws \Exception */ public function updateBookInfo($bookInfo = '', $amazdata = null) @@ -569,8 +565,9 @@ class Books } /** - * @param string $bookInfo + * @param string $bookInfo * @return array|bool + * * @throws \DariusIII\ItunesApi\Exceptions\InvalidProviderException */ public function fetchItunesBookProperties(string $bookInfo) diff --git a/Blacklight/Categorize.php b/Blacklight/Categorize.php index 002670c46..3c767059c 100755 --- a/Blacklight/Categorize.php +++ b/Blacklight/Categorize.php @@ -39,18 +39,21 @@ class Categorize /** * Release name to sort through. + * * @var string */ public $releaseName; /** * Release poster to sort through. + * * @var string */ public $poster; /** * Group id of the releasename we are sorting through. + * * @var int|string */ public $groupid; @@ -76,11 +79,11 @@ class Categorize * Then work out which category is applicable for either a group or a binary. * Returns Category::OTHER_MISC if no category is appropriate. * - * @param $groupID - * @param string $releaseName - * @param string $poster - * + * @param $groupID + * @param string $releaseName + * @param string $poster * @return array + * * @throws \Exception */ public function determineCategory($groupID, $releaseName = '', $poster = ''): array @@ -1516,10 +1519,9 @@ class Categorize } /** - * @param string $regex Regex to use for match - * @param string $fromName Poster that needs to be matched by regex - * @param string $category Category to set if there is a match - * + * @param string $regex Regex to use for match + * @param string $fromName Poster that needs to be matched by regex + * @param string $category Category to set if there is a match * @return bool */ public function checkPoster($regex, $fromName, $category): bool diff --git a/Blacklight/CollectionsCleaning.php b/Blacklight/CollectionsCleaning.php index 63b7dd544..89fdd7be6 100755 --- a/Blacklight/CollectionsCleaning.php +++ b/Blacklight/CollectionsCleaning.php @@ -12,6 +12,7 @@ class CollectionsCleaning { /** * Used for matching endings in article subjects. + * * @const * @string */ @@ -19,6 +20,7 @@ class CollectionsCleaning /** * Used for matching file extension endings in article subjects. + * * @const * @string */ @@ -26,6 +28,7 @@ class CollectionsCleaning /** * Used for matching size strings in article subjects. + * * @example ' - 365.15 KB - ' * @const * @string @@ -93,9 +96,10 @@ class CollectionsCleaning } /** - * @param string $subject - * @param string $groupName + * @param string $subject + * @param string $groupName * @return array + * * @throws \Exception */ public function collectionsCleaner($subject, $groupName = ''): array diff --git a/Blacklight/ColorCLI.php b/Blacklight/ColorCLI.php index b3a468909..00b95df7e 100755 --- a/Blacklight/ColorCLI.php +++ b/Blacklight/ColorCLI.php @@ -23,8 +23,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function debug(string $str, bool $newline = false): void { @@ -35,8 +35,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function info(string $str, bool $newline = false): void { @@ -47,8 +47,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function notice(string $str, bool $newline = false): void { @@ -59,8 +59,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function warning(string $str, bool $newline = false): void { @@ -71,8 +71,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function error(string $str, bool $newline = false): void { @@ -83,8 +83,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function primary(string $str, bool $newline = false): void { @@ -95,8 +95,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function header(string $str, bool $newline = false): void { @@ -107,8 +107,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function alternate(string $str, bool $newline = false): void { @@ -119,8 +119,8 @@ class ColorCLI } /** - * @param string $str - * @param bool $newline + * @param string $str + * @param bool $newline */ public function tmuxOrange(string $str, bool $newline = false): void { @@ -131,7 +131,7 @@ class ColorCLI } /** - * @param string $str + * @param string $str */ public function primaryOver(string $str): void { @@ -139,7 +139,7 @@ class ColorCLI } /** - * @param string $str + * @param string $str */ public function headerOver(string $str): void { @@ -147,7 +147,7 @@ class ColorCLI } /** - * @param string $str + * @param string $str */ public function alternateOver(string $str): void { @@ -155,7 +155,7 @@ class ColorCLI } /** - * @param string $str + * @param string $str */ public function warningOver(string $str): void { diff --git a/Blacklight/Console.php b/Blacklight/Console.php index 5ba225ffb..3bbab3b10 100755 --- a/Blacklight/Console.php +++ b/Blacklight/Console.php @@ -76,6 +76,7 @@ class Console /** * Store names of failed Amazon lookup items. + * * @var array */ public $failCache; @@ -86,7 +87,8 @@ class Console protected $colorCli; /** - * @param array $options Class instances / Echo to cli. + * @param array $options Class instances / Echo to cli. + * * @throws \Exception */ public function __construct(array $options = []) @@ -122,9 +124,8 @@ class Console } /** - * @param string $title - * @param string $platform - * + * @param string $title + * @param string $platform * @return false|\Illuminate\Database\Eloquent\Model */ public function getConsoleInfoByName($title, $platform) @@ -148,14 +149,14 @@ class Console } /** - * @param $page - * @param $cat - * @param $start - * @param $num - * @param $orderBy - * @param array $excludedCats - * + * @param $page + * @param $cat + * @param $start + * @param $num + * @param $orderBy + * @param array $excludedCats * @return array + * * @throws \Exception */ public function getConsoleRange($page, $cat, $start, $num, $orderBy, array $excludedCats = []): array @@ -332,7 +333,7 @@ class Console * @param $esrb * @param $cover * @param $genres_id - * @param string $review + * @param string $review */ public function update($id, $title, $asin, $url, $salesrank, $platform, $publisher, $releasedate, $esrb, $cover, $genres_id, $review = 'review'): void { @@ -346,6 +347,7 @@ class Console /** * @param $gameInfo * @return int|mixed + * * @throws \Exception */ public function updateConsoleInfo($gameInfo) @@ -371,8 +373,8 @@ class Console } /** - * @param array $gameInfo - * @param array $con + * @param array $gameInfo + * @param array $con * @return bool */ protected function _matchConToGameInfo(array $gameInfo = [], array $con = []): bool @@ -482,8 +484,8 @@ class Console /** * @param $amaz - * * @return array + * * @throws \Exception */ protected function _matchGenre($amaz): array @@ -534,8 +536,8 @@ class Console /** * @param $genreName - * * @return false|int|string + * * @throws \Exception */ protected function _getGenreKey($genreName) @@ -553,6 +555,7 @@ class Console /** * @return array + * * @throws \Exception */ protected function _loadGenres(): array @@ -562,12 +565,11 @@ class Console return $gen->loadGenres(Genres::CONSOLE_TYPE); } - /** This function sets the platform retrieved + /** + * This function sets the platform retrieved * from the release to the Amazon equivalent. * - * @param string $platform - * - * + * @param string $platform * @return string */ protected function _replacePlatform($platform): string @@ -634,7 +636,7 @@ class Console } /** - * @param array $con + * @param array $con * @return int|mixed */ protected function _updateConsoleTable(array $con = []) @@ -693,8 +695,8 @@ class Console /** * @param $gameInfo * @param $gamePlatform - * * @return array|bool|\StdClass + * * @throws \Exception */ public function fetchIGDBProperties($gameInfo, $gamePlatform) @@ -871,7 +873,6 @@ class Console /** * @param $releaseName - * * @return array|false */ public function parseTitle($releaseName) @@ -939,7 +940,6 @@ class Console /** * @param $platform - * * @return string */ public function getBrowseNode($platform): string @@ -1011,7 +1011,6 @@ class Console /** * @param $nodeName - * * @return bool|string */ public function matchBrowseNode($nodeName) diff --git a/Blacklight/ConsoleTools.php b/Blacklight/ConsoleTools.php index fe4d3d89c..aea22d39a 100755 --- a/Blacklight/ConsoleTools.php +++ b/Blacklight/ConsoleTools.php @@ -22,8 +22,8 @@ class ConsoleTools extends ColorCLI } /** - * @param string $message - * @param bool $reset + * @param string $message + * @param bool $reset */ public function overWriteHeader($message, $reset = false): void { @@ -40,8 +40,8 @@ class ConsoleTools extends ColorCLI } /** - * @param string $message - * @param bool $reset + * @param string $message + * @param bool $reset */ public function overWritePrimary($message, $reset = false): void { @@ -58,8 +58,8 @@ class ConsoleTools extends ColorCLI } /** - * @param string $message - * @param bool $reset + * @param string $message + * @param bool $reset */ public function overWrite($message, $reset = false): void { @@ -76,7 +76,7 @@ class ConsoleTools extends ColorCLI } /** - * @param string $message + * @param string $message */ public function appendWrite($message): void { @@ -85,9 +85,8 @@ class ConsoleTools extends ColorCLI } /** - * @param int $cur - * @param int $total - * + * @param int $cur + * @param int $total * @return string */ public function percentString($cur, $total): string @@ -99,10 +98,9 @@ class ConsoleTools extends ColorCLI } /** - * @param int $first - * @param int $last - * @param int $total - * + * @param int $first + * @param int $last + * @param int $total * @return string */ public function percentString2($first, $last, $total): string @@ -117,8 +115,7 @@ class ConsoleTools extends ColorCLI /** * Convert seconds to minutes or hours, appending type at the end. * - * @param int $seconds - * + * @param int $seconds * @return string */ public function convertTime($seconds): string @@ -136,8 +133,7 @@ class ConsoleTools extends ColorCLI /** * Convert seconds to a timer, 00h:00m:00s. * - * @param int $seconds - * + * @param int $seconds * @return string */ public function convertTimer($seconds): string @@ -148,7 +144,7 @@ class ConsoleTools extends ColorCLI /** * Sleep for x seconds, printing timer on screen. * - * @param int $seconds + * @param int $seconds */ public function showSleep($seconds): void { diff --git a/Blacklight/Contents.php b/Blacklight/Contents.php index 222a3a8c6..28e60d5f9 100755 --- a/Blacklight/Contents.php +++ b/Blacklight/Contents.php @@ -99,7 +99,6 @@ class Contents /** * @param $id * @param $role - * * @return array|false */ public function getForMenuByTypeAndRole($id, $role) @@ -133,7 +132,6 @@ class Contents /** * @param $id * @param $role - * * @return bool|\Illuminate\Database\Eloquent\Collection|static[] */ public function getByID($id, $role) @@ -149,7 +147,6 @@ class Contents /** * @param $content - * * @return mixed */ public function validate($content) @@ -167,7 +164,6 @@ class Contents /** * @param $form - * * @return int */ public function add($form) @@ -181,7 +177,6 @@ class Contents /** * @param $id - * * @return mixed */ public function delete($id) @@ -191,7 +186,6 @@ class Contents /** * @param $form - * * @return mixed|Content */ public function update($form) @@ -203,7 +197,6 @@ class Contents /** * @param $content - * * @return int */ public function data_update($content): int @@ -228,7 +221,6 @@ class Contents /** * @param $content - * * @return int */ public function data_add($content) @@ -283,7 +275,6 @@ class Contents /** * @param $id * @param $role - * * @return \Illuminate\Database\Eloquent\Collection|static[] */ public function data_getByID($id, $role) @@ -328,7 +319,6 @@ class Contents /** * @param $id * @param $role - * * @return \Illuminate\Database\Eloquent\Collection|static[] */ public function data_getForMenuByTypeAndRole($id, $role) diff --git a/Blacklight/CouchPotato.php b/Blacklight/CouchPotato.php index e275089de..e6772d43e 100755 --- a/Blacklight/CouchPotato.php +++ b/Blacklight/CouchPotato.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author DariusIII * @copyright 2016 newznab-tmux */ @@ -30,18 +31,21 @@ class CouchPotato { /** * URL to the CP server. + * * @var string */ public $cpurl = ''; /** * The CP key. + * * @var string */ public $cpapi = ''; /** * Imdb ID. + * * @var string */ public $imdbid = ''; @@ -49,7 +53,7 @@ class CouchPotato /** * CouchPotato constructor. * - * @param \App\Http\Controllers\BasePageController $page + * @param \App\Http\Controllers\BasePageController $page */ public function __construct($page) { @@ -60,9 +64,9 @@ class CouchPotato /** * Send a movie to CouchPotato. * - * @param string $id - * + * @param string $id * @return bool|mixed + * * @throws \RuntimeException */ public function sendToCouchPotato($id) diff --git a/Blacklight/ElasticSearchSiteSearch.php b/Blacklight/ElasticSearchSiteSearch.php index e10494d5d..7d106dd86 100644 --- a/Blacklight/ElasticSearchSiteSearch.php +++ b/Blacklight/ElasticSearchSiteSearch.php @@ -11,8 +11,8 @@ use sspat\ESQuerySanitizer\Sanitizer; class ElasticSearchSiteSearch { /** - * @param string|array $phrases - * @param int $limit + * @param string|array $phrases + * @param int $limit * @return mixed */ public function indexSearch($phrases, int $limit) @@ -70,8 +70,8 @@ class ElasticSearchSiteSearch } /** - * @param string|array $searchName - * @param int $limit + * @param string|array $searchName + * @param int $limit * @return array */ public function indexSearchApi($searchName, int $limit) @@ -130,8 +130,9 @@ class ElasticSearchSiteSearch /** * Search function used in TV, TV API, Movies and Anime searches. - * @param string|array $name - * @param int $limit + * + * @param string|array $name + * @param int $limit * @return array */ public function indexSearchTMA($name, $limit) @@ -189,7 +190,7 @@ class ElasticSearchSiteSearch } /** - * @param string|array $search + * @param string|array $search * @return array|\Illuminate\Support\Collection */ public function predbIndexSearch($search) @@ -240,7 +241,7 @@ class ElasticSearchSiteSearch } /** - * @param array $parameters + * @param array $parameters */ public function insertRelease(array $parameters): void { @@ -264,7 +265,7 @@ class ElasticSearchSiteSearch } /** - * @param int $id + * @param int $id */ public function updateRelease(int $id) { @@ -374,7 +375,7 @@ class ElasticSearchSiteSearch } /** - * @param array|string $phrases + * @param array|string $phrases * @return string */ private function sanitize($phrases): string diff --git a/Blacklight/Games.php b/Blacklight/Games.php index 9bdf50931..5bc9db834 100755 --- a/Blacklight/Games.php +++ b/Blacklight/Games.php @@ -111,7 +111,8 @@ class Games /** * Games constructor. * - * @param array $options + * @param array $options + * * @throws \Exception */ public function __construct(array $options = []) @@ -153,8 +154,7 @@ class Games } /** - * @param string $title - * + * @param string $title * @return array|false */ public function getGamesInfoByName($title) @@ -193,6 +193,7 @@ class Games /** * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator + * * @throws \InvalidArgumentException */ public function getRange() @@ -217,14 +218,14 @@ class Games /** * @param $page - * @param $cat - * @param $start - * @param $num - * @param string|array $orderBy - * @param string $maxAge - * @param array $excludedCats - * + * @param $cat + * @param $start + * @param $num + * @param string|array $orderBy + * @param string $maxAge + * @param array $excludedCats * @return array + * * @throws \Exception */ public function getGamesRange($page, $cat, $start, $num, $orderBy = '', $maxAge = '', array $excludedCats = []): array @@ -318,8 +319,7 @@ class Games } /** - * @param string|array $orderBy - * + * @param string|array $orderBy * @return array */ public function getGamesOrder($orderBy): array @@ -432,8 +432,8 @@ class Games * Process each game, updating game information from Steam and Giantbomb. * * @param $gameInfo - * * @return bool + * * @throws \Exception * @throws \RuntimeException * @throws \InvalidArgumentException @@ -832,8 +832,7 @@ class Games /** * Parse the game release title. * - * @param string $releaseName - * + * @param string $releaseName * @return array|false */ public function parseTitle($releaseName) @@ -865,7 +864,6 @@ class Games * See if genre name exists. * * @param $gameGenre - * * @return bool|string */ public function matchGenreName($gameGenre) @@ -899,8 +897,7 @@ class Games /** * Matches Genres. * - * @param string $genre - * + * @param string $genre * @return string */ protected function _matchGenre($genre = ''): string diff --git a/Blacklight/Genres.php b/Blacklight/Genres.php index 3459434d7..fc58193f1 100755 --- a/Blacklight/Genres.php +++ b/Blacklight/Genres.php @@ -21,7 +21,8 @@ class Genres public const STATUS_DISABLED = 1; /** - * @param array $options Class instances. + * @param array $options Class instances. + * * @throws \Exception */ public function __construct(array $options = []) @@ -33,9 +34,8 @@ class Genres } /** - * @param string $type - * @param bool $activeOnly - * + * @param string $type + * @param bool $activeOnly * @return array|mixed */ public function getGenres($type = '', $activeOnly = false) @@ -54,7 +54,6 @@ class Genres /** * @param $type - * * @return array */ public function loadGenres($type): array @@ -69,8 +68,8 @@ class Genres } /** - * @param string $type - * @param bool $activeOnly + * @param string $type + * @param bool $activeOnly * @return string */ private function getListQuery($type = '', $activeOnly = false): string @@ -112,11 +111,10 @@ class Genres } /** - * @param string $type - * @param bool $activeOnly - * @param int $start - * @param int $num - * + * @param string $type + * @param bool $activeOnly + * @param int $start + * @param int $num * @return array */ public function getRange($type = '', $activeOnly = false, $start, $num): array @@ -128,8 +126,8 @@ class Genres } /** - * @param string $type - * @param bool $activeOnly + * @param string $type + * @param bool $activeOnly * @return mixed */ public function getCount($type = '', $activeOnly = false) diff --git a/Blacklight/IRCClient.php b/Blacklight/IRCClient.php index 9c89dc1b7..d7eb50a36 100755 --- a/Blacklight/IRCClient.php +++ b/Blacklight/IRCClient.php @@ -105,6 +105,7 @@ class IRCClient * );. * * @note Used with the processChannelMessages() function. + * * @var array */ protected $_channelData = []; @@ -185,7 +186,7 @@ class IRCClient * The default is fine, it will ping the server if the server does not ping us * within this time to keep the connection alive. * - * @param int $timeout Seconds. + * @param int $timeout Seconds. */ public function setSocketTimeout($timeout) { @@ -199,7 +200,7 @@ class IRCClient /** * Amount of time to wait before giving up when connecting. * - * @param int $timeout Seconds. + * @param int $timeout Seconds. */ public function setConnectionTimeout($timeout) { @@ -213,7 +214,7 @@ class IRCClient /** * Amount of times to retry before giving up when connecting. * - * @param int $retries + * @param int $retries */ public function setConnectionRetries($retries) { @@ -227,7 +228,7 @@ class IRCClient /** * Amount of time to wait between failed connects. * - * @param int $delay Seconds. + * @param int $delay Seconds. */ public function setReConnectDelay($delay) { @@ -241,10 +242,9 @@ class IRCClient /** * Connect to a IRC server. * - * @param string $hostname Host name of the IRC server (can be a IP or a name). - * @param int $port Port number of the IRC server. - * @param bool $tls Use encryption for the socket transport? (make sure the port is right). - * + * @param string $hostname Host name of the IRC server (can be a IP or a name). + * @param int $port Port number of the IRC server. + * @param bool $tls Use encryption for the socket transport? (make sure the port is right). * @return bool */ public function connect($hostname, $port = 6667, $tls = false) @@ -297,11 +297,10 @@ class IRCClient /** * Log in to a IRC server. * - * @param string $nickName The nick name - visible in the channel. - * @param string $userName The user name - visible in the host name. - * @param string $realName The real name - visible in the WhoIs. - * @param null $password The password - some servers require a password. - * + * @param string $nickName The nick name - visible in the channel. + * @param string $userName The user name - visible in the host name. + * @param string $realName The real name - visible in the WhoIs. + * @param null $password The password - some servers require a password. * @return bool */ public function login($nickName, $userName, $realName, $password = null) @@ -384,8 +383,7 @@ class IRCClient /** * Quit from IRC. * - * @param string $message Optional disconnect message. - * + * @param string $message Optional disconnect message. * @return bool */ public function quit($message = null) @@ -439,9 +437,8 @@ class IRCClient /** * Join a channel or multiple channels. * - * @param array $channels Array of channels with their passwords (null if the channel doesn't need a password). - * array( '#exampleChannel' => 'thePassword', '#exampleChan2' => null ); - * + * @param array $channels Array of channels with their passwords (null if the channel doesn't need a password). + * array( '#exampleChannel' => 'thePassword', '#exampleChan2' => null ); * @return bool */ public function joinChannels($channels = []) @@ -474,8 +471,8 @@ class IRCClient /** * Join a channel. * - * @param string $channel - * @param string $password + * @param string $channel + * @param string $password */ protected function _joinChannel($channel, $password) { @@ -485,7 +482,7 @@ class IRCClient /** * Send PONG to a host. * - * @param string $host + * @param string $host */ protected function _pong($host) { @@ -502,7 +499,7 @@ class IRCClient /** * Send PING to a host. * - * @param string $host + * @param string $host */ protected function _ping($host) { @@ -557,8 +554,7 @@ class IRCClient /** * Send a command to the IRC server. * - * @param string $command - * + * @param string $command * @return bool */ protected function _writeSocket($command) @@ -592,7 +588,6 @@ class IRCClient * Write a single character to the socket. * * @param string (char) $character A single character. - * * @return int|bool Number of bytes written or false. */ protected function _writeSocketChar($character) @@ -646,8 +641,7 @@ class IRCClient /** * Strips control characters from a IRC message. * - * @param string $text - * + * @param string $text * @return string */ protected function _stripControlCharacters($text) diff --git a/Blacklight/IRCScraper.php b/Blacklight/IRCScraper.php index 76795ed49..26469e8a9 100755 --- a/Blacklight/IRCScraper.php +++ b/Blacklight/IRCScraper.php @@ -14,30 +14,35 @@ class IRCScraper extends IRCClient { /** * Regex to ignore categories. + * * @var string|bool */ protected $_categoryIgnoreRegex; /** * Array of current pre info. + * * @var array */ protected $_curPre; /** * List of groups and their id's. + * * @var array */ protected $_groupList; /** * Array of ignored channels. + * * @var array */ protected $_ignoredChannels; /** * Is this pre nuked or un nuked? + * * @var bool */ protected $_nuked; @@ -49,12 +54,14 @@ class IRCScraper extends IRCClient /** * Run this in silent mode (no text output). + * * @var bool */ protected $_silent; /** * Regex to ignore PRE titles. + * * @var string|bool */ protected $_titleIgnoreRegex; @@ -71,8 +78,9 @@ class IRCScraper extends IRCClient /** * Construct. * - * @param bool $silent Run this in silent mode (no text output). - * @param bool $debug Turn on debug? Shows sent/received socket buffer messages. + * @param bool $silent Run this in silent mode (no text output). + * @param bool $debug Turn on debug? Shows sent/received socket buffer messages. + * * @throws \Exception */ public function __construct(&$silent, &$debug) @@ -410,7 +418,7 @@ class IRCScraper extends IRCClient /** * Echo new or update pre to CLI. * - * @param bool $new + * @param bool $new */ protected function _doEcho($new = true) { @@ -466,8 +474,7 @@ class IRCScraper extends IRCClient /** * Get a group id for a group name. * - * @param string $groupName - * + * @param string $groupName * @return mixed */ protected function _getGroupID($groupName) diff --git a/Blacklight/Movie.php b/Blacklight/Movie.php index c66ac6089..804706ddc 100755 --- a/Blacklight/Movie.php +++ b/Blacklight/Movie.php @@ -43,12 +43,14 @@ class Movie /** * Current title being passed through various sites/api's. + * * @var string */ protected $currentTitle = ''; /** * Current year of parsed search name. + * * @var string */ protected $currentYear = ''; @@ -77,6 +79,7 @@ class Movie /** * Language to fetch from IMDB. + * * @var string */ protected $lookuplanguage; @@ -147,7 +150,8 @@ class Movie protected $colorCli; /** - * @param array $options Class instances / Echo to CLI. + * @param array $options Class instances / Echo to CLI. + * * @throws \Exception */ public function __construct(array $options = []) @@ -198,7 +202,6 @@ class Movie /** * @param $imdbId - * * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Model|null|object */ public function getMovieInfo($imdbId) @@ -210,14 +213,13 @@ class Movie * Get movie releases with covers for movie browse page. * * - * @param $page - * @param $cat - * @param $start - * @param $num - * @param $orderBy - * @param int $maxAge - * @param array $excludedCats - * + * @param $page + * @param $cat + * @param $start + * @param $num + * @param $orderBy + * @param int $maxAge + * @param array $excludedCats * @return array|mixed */ public function getMovieRange($page, $cat, $start, $num, $orderBy, $maxAge = -1, array $excludedCats = []) @@ -327,7 +329,6 @@ class Movie * Get the order type the user requested on the movies page. * * @param $orderBy - * * @return array */ protected function getMovieOrder($orderBy): array @@ -389,9 +390,9 @@ class Movie /** * Get trailer using IMDB Id. * - * @param int $imdbID - * + * @param int $imdbID * @return bool|string + * * @throws \Exception */ public function getTrailer($imdbID) @@ -424,8 +425,7 @@ class Movie /** * Parse trakt info, insert into DB. * - * @param array $data - * + * @param array $data * @return mixed */ public function parseTraktTv(&$data) @@ -466,8 +466,7 @@ class Movie /** * Checks if the value is set and not empty, returns it, else empty string. * - * @param mixed $value - * + * @param mixed $value * @return string */ private function checkTraktValue($value): string @@ -501,7 +500,7 @@ class Movie /** * Update movie on movie-edit page. * - * @param array $values Array of keys/values to update. See $validKeys + * @param array $values Array of keys/values to update. See $validKeys * @return bool */ public function update(array $values): bool @@ -538,12 +537,11 @@ class Movie /** * Returns a tmdb, imdb or trakt variable, the one that is set. Empty string if both not set. * - * @param string $variable1 - * @param string $variable2 - * @param string $variable3 - * @param string $variable4 - * @param string $variable5 - * + * @param string $variable1 + * @param string $variable2 + * @param string $variable3 + * @param string $variable4 + * @param string $variable5 * @return array|string */ protected function setVariables($variable1, $variable2, $variable3, $variable4, $variable5) @@ -571,8 +569,8 @@ class Movie * Fetch IMDB/TMDB/TRAKT/OMDB/iTunes info for the movie. * * @param $imdbId - * * @return bool + * * @throws \Exception */ public function updateMovieInfo($imdbId): bool @@ -724,7 +722,6 @@ class Movie * Fetch FanArt.tv backdrop / cover / title. * * @param $imdbId - * * @return array|false */ protected function fetchFanartTVProperties($imdbId) @@ -770,9 +767,8 @@ class Movie * Fetch info for IMDB id from TMDB. * * - * @param $imdbId - * @param bool $text - * + * @param $imdbId + * @param bool $text * @return array|false */ public function fetchTMDBProperties($imdbId, $text = false) @@ -878,7 +874,6 @@ class Movie /** * @param $imdbId - * * @return array|false */ public function fetchIMDBProperties($imdbId) @@ -939,8 +934,8 @@ class Movie * Fetch TraktTV backdrop / cover / title. * * @param $imdbId - * * @return array|false + * * @throws \Exception */ public function fetchTraktTVProperties($imdbId) @@ -991,7 +986,6 @@ class Movie * Fetch OMDb backdrop / cover / title. * * @param $imdbId - * * @return array|false */ public function fetchOmdbAPIProperties($imdbId) @@ -1039,9 +1033,9 @@ class Movie } /** - * @param string $title - * + * @param string $title * @return array|bool + * * @throws \DariusIII\ItunesApi\Exceptions\InvalidProviderException * @throws \Exception */ @@ -1079,12 +1073,12 @@ class Movie /** * Update a release with a IMDB id. * - * @param string $buffer Data to parse a IMDB id/Trakt Id from. - * @param string $service Method that called this method. - * @param int $id id of the release. - * @param int $processImdb To get IMDB info on this IMDB id or not. - * + * @param string $buffer Data to parse a IMDB id/Trakt Id from. + * @param string $service Method that called this method. + * @param int $id id of the release. + * @param int $processImdb To get IMDB info on this IMDB id or not. * @return string + * * @throws \Exception */ public function doMovieUpdate($buffer, $service, $id, $processImdb = 1): string @@ -1127,9 +1121,10 @@ class Movie * Process releases with no IMDB id's. * * - * @param string $groupID - * @param string $guidChar - * @param int $lookupIMDB + * @param string $groupID + * @param string $guidChar + * @param int $lookupIMDB + * * @throws \Exception */ public function processMovieReleases($groupID = '', $guidChar = '', $lookupIMDB = 1): void @@ -1312,8 +1307,7 @@ class Movie /** * Parse a movie name from a release search name. * - * @param string $releaseName - * + * @param string $releaseName * @return bool */ protected function parseMovieSearchName($releaseName): bool diff --git a/Blacklight/Music.php b/Blacklight/Music.php index 795ad5e4c..788b132a6 100755 --- a/Blacklight/Music.php +++ b/Blacklight/Music.php @@ -64,6 +64,7 @@ class Music /** * Store names of failed Amazon lookup items. + * * @var array */ public $failCache; @@ -74,7 +75,8 @@ class Music protected $colorCli; /** - * @param array $options Class instances/ echo to CLI. + * @param array $options Class instances/ echo to CLI. + * * @throws \Exception */ public function __construct(array $options = []) @@ -136,13 +138,13 @@ class Music /** * @param $page - * @param $cat - * @param $start - * @param $num - * @param $orderBy - * @param array $excludedCats - * + * @param $cat + * @param $start + * @param $num + * @param $orderBy + * @param array $excludedCats * @return array + * * @throws \Exception */ public function getMusicRange($page, $cat, $start, $num, $orderBy, array $excludedCats = []) @@ -235,7 +237,6 @@ class Music /** * @param $orderBy - * * @return array */ public function getMusicOrder($orderBy): array @@ -341,11 +342,11 @@ class Music } /** - * @param $title - * @param $year - * @param null $amazdata - * + * @param $title + * @param $year + * @param null $amazdata * @return int|mixed + * * @throws \Exception */ public function updateMusicInfo($title, $year, $amazdata = null) @@ -439,7 +440,8 @@ class Music } /** - * @param bool $local + * @param bool $local + * * @throws \Exception */ public function processMusicReleases($local = false) @@ -518,8 +520,7 @@ class Music } /** - * @param string $releaseName - * + * @param string $releaseName * @return array|false */ public function parseArtist($releaseName) @@ -552,7 +553,6 @@ class Music /** * @param $nodeId - * * @return bool|string */ public function matchBrowseNode($nodeId) @@ -658,9 +658,9 @@ class Music } /** - * @param string $title - * + * @param string $title * @return array|bool + * * @throws \DariusIII\ItunesApi\Exceptions\InvalidProviderException * @throws \Exception */ diff --git a/Blacklight/NNTP.php b/Blacklight/NNTP.php index f3272cea6..6b73d82c3 100755 --- a/Blacklight/NNTP.php +++ b/Blacklight/NNTP.php @@ -55,42 +55,49 @@ class NNTP extends \Net_NNTP_Client /** * Does the server support XFeature GZip header compression? + * * @var bool */ protected $_compressionSupported = true; /** * Is header compression enabled for the session? + * * @var bool */ protected $_compressionEnabled = false; /** * Currently selected group. + * * @var string */ protected $_currentGroup = ''; /** * Port of the current NNTP server. + * * @var int */ protected $_currentPort = 'NNTP_PORT'; /** * Address of the current NNTP server. + * * @var string */ protected $_currentServer = 'NNTP_SERVER'; /** * Are we allowed to post to usenet? + * * @var bool */ protected $_postingAllowed = false; /** * How many times should we try to reconnect to the NNTP server? + * * @var int */ protected $_nntpRetries; @@ -105,7 +112,7 @@ class NNTP extends \Net_NNTP_Client /** * Default constructor. * - * @param array $options Class instances and echo to CLI bool. + * @param array $options Class instances and echo to CLI bool. * * @throws \Exception */ @@ -137,12 +144,12 @@ class NNTP extends \Net_NNTP_Client /** * Connect to a usenet server. * - * @param bool $compression Should we attempt to enable XFeature Gzip compression on this connection? - * @param bool $alternate Use the alternate NNTP connection. + * @param bool $compression Should we attempt to enable XFeature Gzip compression on this connection? + * @param bool $alternate Use the alternate NNTP connection. + * @return mixed On success = (bool) Did we successfully connect to the usenet? * - * @return mixed On success = (bool) Did we successfully connect to the usenet? * @throws \Exception - * On failure = (object) PEAR_Error. + * On failure = (object) PEAR_Error. */ public function doConnect($compression = true, $alternate = false) { @@ -285,8 +292,7 @@ class NNTP extends \Net_NNTP_Client /** * Disconnect from the current NNTP server. * - * @param bool $force Force quit even if not connected? - * + * @param bool $force Force quit even if not connected? * @return mixed On success : (bool) Did we successfully disconnect from usenet? * On Failure : (object) PEAR_Error. */ @@ -334,13 +340,13 @@ class NNTP extends \Net_NNTP_Client } /** - * @param string $group Name of the group to select. - * @param bool $articles (optional) experimental! When true the article numbers is returned in 'articles'. - * @param bool $force Force a refresh to get updated data from the usenet server. - * + * @param string $group Name of the group to select. + * @param bool $articles (optional) experimental! When true the article numbers is returned in 'articles'. + * @param bool $force Force a refresh to get updated data from the usenet server. * @return mixed On success : (array) Group information. + * * @throws \Exception - * On failure : (object) PEAR_Error. + * On failure : (object) PEAR_Error. */ public function selectGroup($group, $articles = false, $force = false) { @@ -362,13 +368,13 @@ class NNTP extends \Net_NNTP_Client /** * Fetch an overview of article(s) in the currently selected group. * - * @param string $range - * @param bool $names - * @param bool $forceNames - * + * @param string $range + * @param bool $names + * @param bool $forceNames * @return mixed On success : (array) Multidimensional array with article headers. + * * @throws \Exception - * On failure : (object) PEAR_Error. + * On failure : (object) PEAR_Error. */ public function getOverview($range = null, $names = true, $forceNames = true) { @@ -401,14 +407,14 @@ class NNTP extends \Net_NNTP_Client * 'Xref' => string(66) "e alt.test:679871775" * } * - * @param string $range Range of articles to get the overview for. Examples follow: - * Single article number: "679871775" - * Range of article numbers: "679871775-679999999" - * All newer than article number: "679871775-" - * All older than article number: "-679871775" - * Message-ID: "" - * + * @param string $range Range of articles to get the overview for. Examples follow: + * Single article number: "679871775" + * Range of article numbers: "679871775-679999999" + * All newer than article number: "679871775-" + * All older than article number: "-679871775" + * Message-ID: "" * @return array|string|\Blacklight\NNTP Multi-dimensional Array of headers on success, PEAR object on failure. + * * @throws \Exception */ public function getXOVER($range) @@ -489,9 +495,9 @@ class NNTP extends \Net_NNTP_Client * * Returns a list of valid groups (that the client is permitted to select) and associated information. * - * @param string $wildMat (optional) http://tools.ietf.org/html/rfc3977#section-4 - * + * @param string $wildMat (optional) http://tools.ietf.org/html/rfc3977#section-4 * @return array|string Pear error on failure, array with groups on success. + * * @throws \Exception */ public function getGroups($wildMat = null) @@ -505,15 +511,15 @@ class NNTP extends \Net_NNTP_Client /** * Download multiple article bodies and string them together. * - * @param string $groupName The name of the group the articles are in. - * @param mixed $identifiers (string) Message-ID. - * (int) Article number. - * (array) Article numbers or Message-ID's (can contain both in the same array) - * @param bool $alternate Use the alternate NNTP provider? - * + * @param string $groupName The name of the group the articles are in. + * @param mixed $identifiers (string) Message-ID. + * (int) Article number. + * (array) Article numbers or Message-ID's (can contain both in the same array) + * @param bool $alternate Use the alternate NNTP provider? * @return mixed On success : (string) The article bodies. + * * @throws \Exception - * On failure : (object) PEAR_Error. + * On failure : (object) PEAR_Error. */ public function getMessages($groupName, $identifiers, $alternate = false) { @@ -618,13 +624,13 @@ class NNTP extends \Net_NNTP_Client * Download a full article, the body and the header, return an array with named keys and their * associated values, optionally decode the body using yEnc. * - * @param string $groupName The name of the group the article is in. - * @param mixed $identifier (string)The message-ID of the article to download. - * (int) The article number. - * @param bool $yEnc Attempt to yEnc decode the body. + * @param string $groupName The name of the group the article is in. + * @param mixed $identifier (string)The message-ID of the article to download. + * (int) The article number. + * @param bool $yEnc Attempt to yEnc decode the body. + * @return mixed On success : (array) The article. + * On failure : (object) PEAR_Error. * - * @return mixed On success : (array) The article. - * On failure : (object) PEAR_Error. * @throws \Exception */ public function get_Article($groupName, $identifier, $yEnc = false) @@ -696,13 +702,13 @@ class NNTP extends \Net_NNTP_Client /** * Download a full article header. * - * @param string $groupName The name of the group the article is in. - * @param mixed $identifier (string) The message-ID of the article to download. - * (int) The article number. - * + * @param string $groupName The name of the group the article is in. + * @param mixed $identifier (string) The message-ID of the article to download. + * (int) The article number. * @return mixed On success : (array) The header. + * * @throws \Exception - * On failure : (object) PEAR_Error. + * On failure : (object) PEAR_Error. */ public function get_Header($groupName, $identifier) { @@ -756,20 +762,19 @@ class NNTP extends \Net_NNTP_Client /** * Post an article to usenet. * - * @param string|array $groups mixed (array) Groups. ie.: $groups = array('alt.test', 'alt.testing', 'free.pt'); - * (string) Group. ie.: $groups = 'alt.test'; - * @param string $subject string The subject. ie.: $subject = 'Test article'; - * @param string|\Exception $body string The message. ie.: $message = 'This is only a test, please disregard.'; - * @param string $from string The poster. ie.: $from = ''; + * @param string|array $groups mixed (array) Groups. ie.: $groups = array('alt.test', 'alt.testing', 'free.pt'); + * (string) Group. ie.: $groups = 'alt.test'; + * @param string $subject string The subject. ie.: $subject = 'Test article'; + * @param string|\Exception $body string The message. ie.: $message = 'This is only a test, please disregard.'; + * @param string $from string The poster. ie.: $from = ''; * @param $extra string Extra, separated by \r\n * ie.: $extra = 'Organization: \r\nNNTP-Posting-Host: <127.0.0.1>'; * @param $yEnc bool Encode the message with yEnc? * @param $compress bool Compress the message with GZip? + * @return mixed On success : (bool) True. + * On failure : (object) PEAR_Error. * * @throws \Exception - * - * @return mixed On success : (bool) True. - * On failure : (object) PEAR_Error. */ public function postArticle($groups, $subject, $body, $from, $yEnc = true, $compress = true, $extra = '') { @@ -825,13 +830,13 @@ class NNTP extends \Net_NNTP_Client * Restart the NNTP connection if an error occurs in the selectGroup * function, if it does not restart display the error. * - * @param NNTP $nntp Instance of class NNTP. - * @param string $group Name of the group. - * @param bool $comp Use compression or not? - * + * @param NNTP $nntp Instance of class NNTP. + * @param string $group Name of the group. + * @param bool $comp Use compression or not? * @return mixed On success : (array) The group summary. + * * @throws \Exception - * On Failure : (object) PEAR_Error. + * On Failure : (object) PEAR_Error. */ public function dataError($nntp, $group, $comp = true) { @@ -858,18 +863,21 @@ class NNTP extends \Net_NNTP_Client /** * If on unix, hide yydecode CLI output. + * * @var string */ protected $_yEncSilence; /** * Path to temp yEnc input storage file. + * * @var string */ protected $_yEncTempInput; /** * Path to temp yEnc output storage file. + * * @var string */ protected $_yEncTempOutput; @@ -878,9 +886,8 @@ class NNTP extends \Net_NNTP_Client * Split a string into lines of 510 chars ending with \r\n. * Usenet limits lines to 512 chars, with \r\n that leaves us 510. * - * @param string $string The string to split. - * @param bool $compress Compress the string with gzip? - * + * @param string $string The string to split. + * @param bool $compress Compress the string with gzip? * @return string The split string. */ protected function _splitLines($string, $compress = false): string @@ -899,10 +906,11 @@ class NNTP extends \Net_NNTP_Client * Try to see if the NNTP server implements XFeature GZip Compression, * change the compression bool object if so. * - * @param bool $secondTry This is only used if enabling compression fails, the function will call itself to retry. + * @param bool $secondTry This is only used if enabling compression fails, the function will call itself to retry. * @return mixed On success : (bool) True: The server understood and compression is enabled. - * (bool) False: The server did not understand, compression is not enabled. + * (bool) False: The server did not understand, compression is not enabled. * On failure : (object) PEAR_Error. + * * @throws \Exception */ protected function _enableCompression($secondTry = false) @@ -949,8 +957,8 @@ class NNTP extends \Net_NNTP_Client * of their _getTextResponse function since it is incompatible at decoding * headers when XFeature GZip compression is enabled server side. * - * @return self|string Our overridden function when compression is enabled. - * parent Parent function when no compression. + * @return self|string Our overridden function when compression is enabled. + * parent Parent function when no compression. */ public function _getTextResponse() { @@ -972,9 +980,10 @@ class NNTP extends \Net_NNTP_Client * * Have we failed to decompress the data, was there a * problem downloading the data, etc.. - * @return array|string On success : (array) The headers. - * On failure : (object) PEAR_Error. - * On decompress failure: (string) error message + * + * @return array|string On success : (array) The headers. + * On failure : (object) PEAR_Error. + * On decompress failure: (string) error message */ protected function &_getXFeatureTextResponse() { @@ -1072,9 +1081,8 @@ class NNTP extends \Net_NNTP_Client /** * Check if the Message-ID has the required opening and closing brackets. * - * @param string $messageID The Message-ID with or without brackets. - * - * @return string Message-ID with brackets. + * @param string $messageID The Message-ID with or without brackets. + * @return string Message-ID with brackets. */ protected function _formatMessageID($messageID): string { @@ -1099,13 +1107,13 @@ class NNTP extends \Net_NNTP_Client /** * Download an article body (an article without the header). * - * @param string $groupName The name of the group the article is in. - * @param mixed $identifier (string) The message-ID of the article to download. - * (int) The article number. - * + * @param string $groupName The name of the group the article is in. + * @param mixed $identifier (string) The message-ID of the article to download. + * (int) The article number. * @return string On success : (string) The article's body. + * * @throws \Exception - * On failure : (object) PEAR_Error. + * On failure : (object) PEAR_Error. */ protected function _getMessage($groupName, $identifier): ?string { @@ -1171,11 +1179,11 @@ class NNTP extends \Net_NNTP_Client /** * Check if we are still connected. Reconnect if not. * - * @param bool $reSelectGroup Select back the group after connecting? - * + * @param bool $reSelectGroup Select back the group after connecting? * @return mixed On success: (bool) True; + * * @throws \Exception - * On failure: (object) PEAR_Error + * On failure: (object) PEAR_Error */ protected function _checkConnection($reSelectGroup = true) { @@ -1215,8 +1223,7 @@ class NNTP extends \Net_NNTP_Client /** * Verify NNTP error code and return PEAR error. * - * @param int $response NET_NNTP Response code - * + * @param int $response NET_NNTP Response code * @return object PEAR error */ protected function _handleErrorResponse($response) @@ -1295,15 +1302,14 @@ class NNTP extends \Net_NNTP_Client /** * Connect to a NNTP server. * - * @param string $host (optional) The address of the NNTP-server to connect to, defaults to 'localhost'. - * @param mixed $encryption (optional) Use TLS/SSL on the connection? - * (string) 'tcp' => Use no encryption. - * 'ssl', 'sslv3', 'tls' => Use encryption. - * (null)|(false) Use no encryption. - * @param int $port (optional) The port number to connect to, defaults to 119. - * @param int $timeout (optional) How many seconds to wait before giving up when connecting. - * @param int $socketTimeout (optional) How many seconds to wait before timing out the (blocked) socket. - * + * @param string $host (optional) The address of the NNTP-server to connect to, defaults to 'localhost'. + * @param mixed $encryption (optional) Use TLS/SSL on the connection? + * (string) 'tcp' => Use no encryption. + * 'ssl', 'sslv3', 'tls' => Use encryption. + * (null)|(false) Use no encryption. + * @param int $port (optional) The port number to connect to, defaults to 119. + * @param int $timeout (optional) How many seconds to wait before giving up when connecting. + * @param int $socketTimeout (optional) How many seconds to wait before timing out the (blocked) socket. * @return mixed (bool) On success: True when posting allowed, otherwise false. * (object) On failure: pear_error */ @@ -1394,8 +1400,7 @@ class NNTP extends \Net_NNTP_Client /** * Test whether we are connected or not. * - * @param bool $feof Check for the end of file pointer. - * + * @param bool $feof Check for the end of file pointer. * @return bool true or false */ public function _isConnected($feof = true): bool diff --git a/Blacklight/NZB.php b/Blacklight/NZB.php index 68914ad68..fe68f9189 100755 --- a/Blacklight/NZB.php +++ b/Blacklight/NZB.php @@ -125,9 +125,9 @@ class NZB * * * - * @param \App\Models\Release $release - * + * @param \App\Models\Release $release * @return bool + * * @throws \Throwable */ public function writeNzbForReleaseId(Release $release): bool @@ -252,10 +252,9 @@ class NZB /** * Build a folder path on the hard drive where the NZB file will be stored. * - * @param string $releaseGuid The guid of the release. - * @param int $levelsToSplit How many sub-paths the folder will be in. - * @param bool $createIfNotExist Create the folder if it doesn't exist. - * + * @param string $releaseGuid The guid of the release. + * @param int $levelsToSplit How many sub-paths the folder will be in. + * @param bool $createIfNotExist Create the folder if it doesn't exist. * @return string $nzbpath The path to store the NZB file. */ public function buildNZBPath($releaseGuid, $levelsToSplit, $createIfNotExist): string @@ -278,10 +277,9 @@ class NZB /** * Retrieve path + filename of the NZB to be stored. * - * @param string $releaseGuid The guid of the release. - * @param int $levelsToSplit How many sub-paths the folder will be in. (optional) - * @param bool $createIfNotExist Create the folder if it doesn't exist. (optional) - * + * @param string $releaseGuid The guid of the release. + * @param int $levelsToSplit How many sub-paths the folder will be in. (optional) + * @param bool $createIfNotExist Create the folder if it doesn't exist. (optional) * @return string Path+filename. */ public function getNZBPath($releaseGuid, $levelsToSplit = 0, $createIfNotExist = false): string @@ -296,10 +294,9 @@ class NZB /** * Determine is an NZB exists, returning the path+filename, if not return false. * - * @param string $releaseGuid The guid of the release. - * + * @param string $releaseGuid The guid of the release. * @return false|string On success: (string) Path+file name of the nzb. - * On failure: false . + * On failure: false . */ public function NZBPath($releaseGuid) { @@ -312,11 +309,10 @@ class NZB * Retrieve various information on a NZB file (the subject, # of pars, * file extensions, file sizes, file completion, group names, # of parts). * - * @param string $nzb The NZB contents in a string. - * @param array $options - * 'no-file-key' => True - use numeric array key; False - Use filename as array key. - * 'strip-count' => True - Strip file/part count from file name to make the array key; False - Leave file name as is. - * + * @param string $nzb The NZB contents in a string. + * @param array $options + * 'no-file-key' => True - use numeric array key; False - Use filename as array key. + * 'strip-count' => True - Strip file/part count from file name to make the array key; False - Leave file name as is. * @return array $result Empty if not an NZB or the contents of the NZB. */ public function nzbFileList($nzb, array $options = []): array diff --git a/Blacklight/NZBContents.php b/Blacklight/NZBContents.php index 137b17721..ba1940a1b 100755 --- a/Blacklight/NZBContents.php +++ b/Blacklight/NZBContents.php @@ -53,15 +53,15 @@ class NZBContents /** * Construct. * - * @param array $options - * array( - * 'Echo' => bool ; To echo to CLI or not. - * 'NNTP' => NNTP ; Class NNTP. - * 'Nfo' => Nfo ; Class Nfo. - * 'NZB' => NZB ; Class NZB. - * 'Settings' => DB ; Class Blacklight\db\DB. - * 'PostProcess' => PostProcess ; Class PostProcess. - * ) + * @param array $options + * array( + * 'Echo' => bool ; To echo to CLI or not. + * 'NNTP' => NNTP ; Class NNTP. + * 'Nfo' => Nfo ; Class Nfo. + * 'NZB' => NZB ; Class NZB. + * 'Settings' => DB ; Class Blacklight\db\DB. + * 'PostProcess' => PostProcess ; Class PostProcess. + * ) * * @throws \Exception */ @@ -99,6 +99,7 @@ class NZBContents * @param $groupID * @param $groupName * @return bool|mixed + * * @throws \Exception */ public function getNfoFromNZB($guid, $relID, $groupID, $groupName) @@ -145,8 +146,9 @@ class NZBContents * @param $guid * @param $relID * @param $groupID - * @param bool $nfoCheck + * @param bool $nfoCheck * @return array|false + * * @throws \Exception */ public function parseNZB($guid, $relID, $groupID, $nfoCheck = false) @@ -249,13 +251,13 @@ class NZBContents /** * Attempts to get the releasename from a par2 file. * - * @param string $guid - * @param int $relID - * @param int $groupID - * @param int $nameStatus - * @param int $show - * + * @param string $guid + * @param int $relID + * @param int $groupID + * @param int $nameStatus + * @param int $show * @return bool + * * @throws \Exception */ public function checkPAR2($guid, $relID, $groupID, $nameStatus, $show): bool diff --git a/Blacklight/NZBExport.php b/Blacklight/NZBExport.php index d9e3db895..e4eb4d406 100755 --- a/Blacklight/NZBExport.php +++ b/Blacklight/NZBExport.php @@ -39,7 +39,7 @@ class NZBExport /** * NZBExport constructor. * - * @param array $options + * @param array $options * * @throws \Exception */ @@ -62,7 +62,6 @@ class NZBExport /** * @param $params - * * @return bool|string */ public function beginExport($params) @@ -214,7 +213,6 @@ class NZBExport /** * @param $date - * * @return bool */ protected function checkDate($date): bool @@ -242,7 +240,6 @@ class NZBExport /** * @param $filename - * * @return string */ protected function safeFilename($filename): string diff --git a/Blacklight/NZBGet.php b/Blacklight/NZBGet.php index f7b9cd705..24941bb77 100755 --- a/Blacklight/NZBGet.php +++ b/Blacklight/NZBGet.php @@ -17,42 +17,49 @@ class NZBGet { /** * NZBGet username. + * * @var string */ public $userName = ''; /** * NZBGet password. + * * @var string */ public $password = ''; /** * NZBGet URL. + * * @var string */ public $url = ''; /** * Full URL (containing password/username/etc). + * * @var string|bool */ protected $fullUrl = ''; /** * User id. + * * @var int */ protected $uid = 0; /** * The users RSS token. + * * @var string */ protected $rsstoken = ''; /** * URL to your NNTmux site. + * * @var string */ protected $serverurl = ''; @@ -77,6 +84,7 @@ class NZBGet * Set up full URL. * * @var \App\Http\Controllers\BasePageController + * * @throws \Exception */ public function __construct(&$page) @@ -141,8 +149,7 @@ class NZBGet /** * Send a NZB URL to NZBGet. * - * @param string $guid Release identifier. - * + * @param string $guid Release identifier. * @return bool|mixed */ public function sendURLToNZBGet($guid) @@ -227,7 +234,7 @@ class NZBGet /** * Pause a single NZB from the queue. * - * @param string $id + * @param string $id */ public function pauseFromQueue($id) { @@ -260,7 +267,7 @@ class NZBGet /** * Resume a single NZB from the queue. * - * @param string $id + * @param string $id */ public function resumeFromQueue($id) { @@ -293,7 +300,7 @@ class NZBGet /** * Delete a single NZB from the queue. * - * @param string $id + * @param string $id */ public function delFromQueue($id) { @@ -326,8 +333,7 @@ class NZBGet /** * Set download speed limit. This method is equivalent for command "nzbget -R ". * - * @param int $limit The speed to limit it to. - * + * @param int $limit The speed to limit it to. * @return void */ public function rate($limit) @@ -380,6 +386,7 @@ class NZBGet * Request for current status (summary) information. Parts of informations returned by this method can be printed by command "nzbget -L". * * @return array|false The status. + * * @throws \RuntimeException */ public function status() @@ -405,8 +412,7 @@ class NZBGet /** * Verify if the NZBGet URL is correct. * - * @param string $url NZBGet URL to verify. - * + * @param string $url NZBGet URL to verify. * @return bool|string */ public function verifyURL($url) diff --git a/Blacklight/NZBImport.php b/Blacklight/NZBImport.php index c96ea9cae..9cd1b145c 100755 --- a/Blacklight/NZBImport.php +++ b/Blacklight/NZBImport.php @@ -41,24 +41,28 @@ class NZBImport /** * List of all the group names/ids in the DB. + * * @var array */ protected $allGroups; /** * Was this run from the browser? + * * @var bool */ protected $browser; /** * Return value for browser. + * * @var string */ protected $retVal; /** * Guid of the current releases. + * * @var string */ protected $relGuid; @@ -86,7 +90,8 @@ class NZBImport /** * Construct. * - * @param array $options Class instances / various options. + * @param array $options Class instances / various options. + * * @throws \Exception */ public function __construct(array $options = []) @@ -116,12 +121,12 @@ class NZBImport } /** - * @param array $filesToProcess List of NZB files to import. - * @param bool|string $useNzbName Use the NZB file name as release name? - * @param bool $delete Delete the NZB when done? - * @param bool $deleteFailed Delete the NZB if failed importing? - * + * @param array $filesToProcess List of NZB files to import. + * @param bool|string $useNzbName Use the NZB file name as release name? + * @param bool $delete Delete the NZB when done? + * @param bool $deleteFailed Delete the NZB if failed importing? * @return string|bool + * * @throws \Exception */ public function beginImport($filesToProcess, $useNzbName = false, $delete = true, $deleteFailed = true) @@ -237,8 +242,9 @@ class NZBImport /** * @param $nzbXML - * @param bool $useNzbName + * @param bool $useNzbName * @return bool + * * @throws \Exception */ protected function scanNZBFile(&$nzbXML, $useNzbName = false): bool @@ -360,8 +366,8 @@ class NZBImport * Insert the NZB details into the database. * * @param $nzbDetails - * * @return bool + * * @throws \Exception */ protected function insertNZB($nzbDetails): bool @@ -460,7 +466,7 @@ class NZBImport /** * Echo message to browser or CLI. * - * @param string $message + * @param string $message */ protected function echoOut($message): void { diff --git a/Blacklight/NZBVortex.php b/Blacklight/NZBVortex.php index 8798cd4bc..32403a1c0 100755 --- a/Blacklight/NZBVortex.php +++ b/Blacklight/NZBVortex.php @@ -23,7 +23,8 @@ final class NZBVortex /** * get text for state. - * @param int $code + * + * @param int $code * @return string */ public function getState($code = 0) @@ -62,6 +63,7 @@ final class NZBVortex /** * get overview of NZB's in queue. + * * @return array */ public function getOverview() @@ -79,8 +81,9 @@ final class NZBVortex /** * add NZB to queue. * - * @param string $nzb + * @param string $nzb * @return void + * * @throws \Exception */ public function addQueue($nzb = '') @@ -104,8 +107,9 @@ final class NZBVortex /** * resume NZB. * - * @param int $id + * @param int $id * @return void + * * @throws \Exception */ public function resume($id = 0): void @@ -120,8 +124,9 @@ final class NZBVortex /** * pause NZB. * - * @param int $id + * @param int $id * @return void + * * @throws \Exception */ public function pause($id = 0) @@ -136,8 +141,9 @@ final class NZBVortex /** * move NZB up in queue. * - * @param int $id + * @param int $id * @return void + * * @throws \Exception */ public function moveUp($id = 0) @@ -152,8 +158,9 @@ final class NZBVortex /** * move NZB down in queue. * - * @param int $id + * @param int $id * @return void + * * @throws \Exception */ public function moveDown($id = 0) @@ -168,8 +175,9 @@ final class NZBVortex /** * move NZB to bottom of queue. * - * @param int $id + * @param int $id * @return void + * * @throws \Exception */ public function moveBottom($id = 0) @@ -184,8 +192,9 @@ final class NZBVortex /** * Remove a (finished/unfinished) NZB from queue and delete files. * - * @param int $id + * @param int $id * @return void + * * @throws \Exception */ public function delete($id = 0) @@ -200,8 +209,9 @@ final class NZBVortex /** * move NZB to top of queue. * - * @param int $id + * @param int $id * @return void + * * @throws \Exception */ public function moveTop($id = 0) @@ -216,8 +226,9 @@ final class NZBVortex /** * get filelist for nzb. * - * @param int $id + * @param int $id * @return array|false + * * @throws \Exception */ public function getFilelist($id = 0) @@ -236,6 +247,7 @@ final class NZBVortex * get /auth/nonce. * * @return void + * * @throws \Exception */ protected function getNonce() @@ -246,6 +258,7 @@ final class NZBVortex /** * @return void + * * @throws \Exception */ protected function login() @@ -274,10 +287,10 @@ final class NZBVortex /** * sendRequest(). * - * @param $path - * @param array $params - * + * @param $path + * @param array $params * @return array + * * @throws \Exception */ protected function sendRequest($path, $params = []) diff --git a/Blacklight/NameFixer.php b/Blacklight/NameFixer.php index f82225a1c..0e8a0776f 100755 --- a/Blacklight/NameFixer.php +++ b/Blacklight/NameFixer.php @@ -148,7 +148,8 @@ class NameFixer private $elasticsearch; /** - * @param array $options Class instances / Echo to cli. + * @param array $options Class instances / Echo to cli. + * * @throws \Exception */ public function __construct(array $options = []) @@ -188,6 +189,7 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show + * * @throws \Exception */ public function fixNamesWithNfo($time, $echo, $cats, $nameStatus, $show): void @@ -273,6 +275,7 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show + * * @throws \Exception */ public function fixNamesWithFiles($time, $echo, $cats, $nameStatus, $show): void @@ -339,6 +342,7 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show + * * @throws \Exception */ public function fixNamesWithCrc($time, $echo, $cats, $nameStatus, $show): void @@ -405,6 +409,7 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show + * * @throws \Exception */ public function fixXXXNamesWithFiles($time, $echo, $cats, $nameStatus, $show): void @@ -468,6 +473,7 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show + * * @throws \Exception */ public function fixNamesWithSrr($time, $echo, $cats, $nameStatus, $show): void @@ -527,12 +533,13 @@ class NameFixer /** * Attempts to fix release names using the Par2 File. * - * @param int $time 1: 24 hours, 2: no time limit - * @param int $echo 1: change the name, anything else: preview of what could have been changed. - * @param int $cats 1: other categories, 2: all categories - * @param $nameStatus - * @param $show - * @param NNTP $nntp + * @param int $time 1: 24 hours, 2: no time limit + * @param int $echo 1: change the name, anything else: preview of what could have been changed. + * @param int $cats 1: other categories, 2: all categories + * @param $nameStatus + * @param $show + * @param NNTP $nntp + * * @throws \Exception */ public function fixNamesWithPar2($time, $echo, $cats, $nameStatus, $show, $nntp): void @@ -604,6 +611,7 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show + * * @throws \Exception */ public function fixNamesWithMedia($time, $echo, $cats, $nameStatus, $show): void @@ -674,6 +682,7 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show + * * @throws \Exception */ public function fixNamesWithMediaMovieName($time, $echo, $cats, $nameStatus, $show): void @@ -742,6 +751,7 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show + * * @throws \Exception */ public function fixNamesWithParHash($time, $echo, $cats, $nameStatus, $show): void @@ -808,11 +818,10 @@ class NameFixer } /** - * @param $time - * @param $cats - * @param $query - * @param string $limit - * + * @param $time + * @param $cats + * @param $query + * @param string $limit * @return array|false */ protected function _getReleases($time, $cats, $query, $limit = '') @@ -839,8 +848,8 @@ class NameFixer /** * Echo the amount of releases that found a new name. * - * @param int|bool $echo 1: change the name, anything else: preview of what could have been changed. - * @param string $type The function type that found the name. + * @param int|bool $echo 1: change the name, anything else: preview of what could have been changed. + * @param string $type The function type that found the name. */ protected function _echoFoundCount($echo, $type): void { @@ -864,8 +873,8 @@ class NameFixer } /** - * @param int $time 1: 24 hours, 2: no time limit - * @param string $type The function type. + * @param int $time 1: 24 hours, 2: no time limit + * @param string $type The function type. */ protected function _echoStartMessage($time, $type): void { @@ -879,7 +888,7 @@ class NameFixer } /** - * @param int $show + * @param int $show */ protected function _echoRenamed($show): void { @@ -901,14 +910,14 @@ class NameFixer * Update the release with the new information. * * - * @param $release - * @param $name - * @param $method - * @param $echo - * @param $type - * @param int $nameStatus - * @param bool $show - * @param int $preId + * @param $release + * @param $name + * @param $method + * @param $echo + * @param $type + * @param int $nameStatus + * @param bool $show + * @param int $preId * * @throws \Exception */ @@ -1080,16 +1089,16 @@ class NameFixer /** * Echo a updated release name to CLI. * - * @param array $data - * array( - * 'new_name' => (string) The new release search name. - * 'old_name' => (string) The old release search name. - * 'new_category' => (string) The new category name or ID for the release. - * 'old_category' => (string) The old category name or ID for the release. - * 'group' => (string) The group name or ID of the release. - * 'release_id' => (int) The ID of the release. - * 'method' => (string) The method used to rename the release. - * ) + * @param array $data + * array( + * 'new_name' => (string) The new release search name. + * 'old_name' => (string) The old release search name. + * 'new_category' => (string) The new category name or ID for the release. + * 'old_category' => (string) The old category name or ID for the release. + * 'group' => (string) The group name or ID of the release. + * 'release_id' => (int) The ID of the release. + * 'method' => (string) The method used to rename the release. + * ) * * @static * @void @@ -1125,8 +1134,8 @@ class NameFixer * @param $echo * @param $nameStatus * @param $show - * * @return int + * * @throws \Exception */ public function matchPredbFT($pre, $echo, $nameStatus, $show): int @@ -1175,7 +1184,6 @@ class NameFixer /** * @param $preTitle - * * @return string */ protected function _preFTsearchQuery($preTitle): string @@ -1196,7 +1204,8 @@ class NameFixer * Retrieves releases and their file names to attempt PreDB matches * Runs in a limited mode based on arguments passed or a full mode broken into chunks of entire DB. * - * @param array $args The CLI script arguments + * @param array $args The CLI script arguments + * * @throws \Exception */ public function getPreFileNames(array $args = []): void @@ -1262,12 +1271,12 @@ class NameFixer /** * Match a release filename to a PreDB filename or title. * - * @param $release - * @param bool $echo - * @param int $nameStatus - * @param bool $show - * + * @param $release + * @param bool $echo + * @param int $nameStatus + * @param bool $show * @return int + * * @throws \Exception */ public function matchPreDbFiles($release, $echo, $nameStatus, $show): int @@ -1358,13 +1367,13 @@ class NameFixer /** * Match a Hash from the predb to a release. * - * @param string $hash - * @param $release - * @param $echo - * @param $nameStatus - * @param $show - * + * @param string $hash + * @param $release + * @param $echo + * @param $nameStatus + * @param $show * @return int + * * @throws \Exception */ public function matchPredbHash($hash, $release, $echo, $nameStatus, $show): int @@ -1412,8 +1421,8 @@ class NameFixer * @param $cats * @param $nameStatus * @param $show - * * @return int + * * @throws \Exception */ public function parseTitles($time, $echo, $cats, $nameStatus, $show): int @@ -1475,14 +1484,14 @@ class NameFixer /** * Check the array using regex for a clean name. * - * @param $release - * @param bool $echo - * @param string $type - * @param int $nameStatus - * @param bool $show - * @param bool $preid - * + * @param $release + * @param bool $echo + * @param string $type + * @param int $nameStatus + * @param bool $show + * @param bool $preid * @return bool + * * @throws \Exception */ public function checkName($release, $echo, $type, $nameStatus, $show, $preid = false): bool @@ -1568,13 +1577,14 @@ class NameFixer return $this->matched; } - /** This function updates a single variable column in releases + /** + * This function updates a single variable column in releases * The first parameter is the column to update, the second is the value * The final parameter is the ID of the release to update. * - * @param string $column - * @param int $status - * @param int $id + * @param string $column + * @param int $status + * @param int $id */ public function _updateSingleColumn($column = '', $status = 0, $id = 0): void { @@ -1586,11 +1596,12 @@ class NameFixer /** * Look for a TV name. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function tvCheck($release, $echo, $type, $nameStatus, $show): void @@ -1619,11 +1630,12 @@ class NameFixer /** * Look for a movie name. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function movieCheck($release, $echo, $type, $nameStatus, $show): void @@ -1664,11 +1676,12 @@ class NameFixer /** * Look for a game name. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function gameCheck($release, $echo, $type, $nameStatus, $show): void @@ -1693,11 +1706,12 @@ class NameFixer /** * Look for a app name. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function appCheck($release, $echo, $type, $nameStatus, $show): void @@ -1716,11 +1730,12 @@ class NameFixer /** * TV. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function nfoCheckTV($release, $echo, $type, $nameStatus, $show): void @@ -1739,11 +1754,12 @@ class NameFixer /** * Movies. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function nfoCheckMov($release, $echo, $type, $nameStatus, $show): void @@ -1762,11 +1778,12 @@ class NameFixer } /** - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function nfoCheckMus($release, $echo, $type, $nameStatus, $show): void @@ -1782,11 +1799,12 @@ class NameFixer /** * Title (year). * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function nfoCheckTY($release, $echo, $type, $nameStatus, $show): void @@ -1958,11 +1976,12 @@ class NameFixer /** * Games. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function nfoCheckG($release, $echo, $type, $nameStatus, $show): void @@ -1987,11 +2006,12 @@ class NameFixer /** * Misc. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show + * * @throws \Exception */ public function nfoCheckMisc($release, $echo, $type, $nameStatus, $show): void @@ -2027,13 +2047,13 @@ class NameFixer /** * Just for filenames. * - * @param $release - * @param bool $echo - * @param string $type - * @param $nameStatus - * @param $show - * + * @param $release + * @param bool $echo + * @param string $type + * @param $nameStatus + * @param $show * @return bool + * * @throws \Exception */ public function fileCheck($release, $echo, $type, $nameStatus, $show): bool @@ -2131,8 +2151,8 @@ class NameFixer * @param $type * @param $nameStatus * @param $show - * * @return bool + * * @throws \Exception */ public function uidCheck($release, $echo, $type, $nameStatus, $show): bool @@ -2184,8 +2204,8 @@ class NameFixer * @param $type * @param $nameStatus * @param $show - * * @return bool + * * @throws \Exception */ public function mediaMovieNameCheck($release, $echo, $type, $nameStatus, $show): bool @@ -2223,8 +2243,8 @@ class NameFixer * @param $type * @param $nameStatus * @param $show - * * @return bool + * * @throws \Exception */ public function xxxNameCheck($release, $echo, $type, $nameStatus, $show): bool @@ -2276,8 +2296,8 @@ class NameFixer * @param $type * @param $nameStatus * @param $show - * * @return bool + * * @throws \Exception */ public function srrNameCheck($release, $echo, $type, $nameStatus, $show): bool @@ -2329,8 +2349,8 @@ class NameFixer * @param $type * @param $nameStatus * @param $show - * * @return bool + * * @throws \Exception */ public function hashCheck($release, $echo, $type, $nameStatus, $show): bool @@ -2380,8 +2400,8 @@ class NameFixer * @param $type * @param $nameStatus * @param $show - * * @return bool + * * @throws \Exception */ public function crcCheck($release, $echo, $type, $nameStatus, $show): bool @@ -2432,8 +2452,7 @@ class NameFixer } /** - * @param string $fileName - * + * @param string $fileName * @return array */ private function preMatch($fileName): array @@ -2445,11 +2464,12 @@ class NameFixer /** * @param $release - * @param bool $echo - * @param string $type - * @param int $nameStatus - * @param bool $show + * @param bool $echo + * @param string $type + * @param int $nameStatus + * @param bool $show * @return bool + * * @throws \Exception */ public function preDbFileCheck($release, bool $echo, string $type, int $nameStatus, bool $show): bool @@ -2483,11 +2503,12 @@ class NameFixer /** * @param $release - * @param bool $echo - * @param string $type - * @param int $nameStatus - * @param bool $show + * @param bool $echo + * @param string $type + * @param int $nameStatus + * @param bool $show * @return bool + * * @throws \Exception */ public function preDbTitleCheck($release, bool $echo, string $type, int $nameStatus, bool $show): bool diff --git a/Blacklight/Nfo.php b/Blacklight/Nfo.php index 955b4b31c..b8cfc0d0d 100755 --- a/Blacklight/Nfo.php +++ b/Blacklight/Nfo.php @@ -82,9 +82,8 @@ class Nfo /** * Look for a TV Show ID in a string. * - * @param string $str The string with a Show ID. - * - * @return array|false Return array with show ID and site source or false on failure. + * @param string $str The string with a Show ID. + * @return array|false Return array with show ID and site source or false on failure. */ public function parseShowId($str) { @@ -120,10 +119,10 @@ class Nfo /** * Confirm this is an NFO file. * - * @param string|bool $possibleNFO The nfo. - * @param string $guid The guid of the release. + * @param string|bool $possibleNFO The nfo. + * @param string $guid The guid of the release. + * @return bool True on success, False on failure. * - * @return bool True on success, False on failure. * @throws \Exception */ public function isNFO(&$possibleNFO, $guid): bool @@ -189,11 +188,11 @@ class Nfo /** * Add an NFO from alternate sources. ex.: PreDB, rar, zip, etc... * - * @param string $nfo The nfo. + * @param string $nfo The nfo. * @param $release - * @param NNTP $nntp Instance of class NNTP. + * @param NNTP $nntp Instance of class NNTP. + * @return bool True on success, False on failure. * - * @return bool True on success, False on failure. * @throws \Exception */ public function addAlternateNfo(&$nfo, $release, $nntp): bool @@ -233,13 +232,13 @@ class Nfo /** * Attempt to find NFO files inside the NZB's of releases. * - * @param $nntp - * @param string $groupID (optional) Group ID. - * @param string $guidChar (optional) First character of the release GUID (used for multi-processing). - * @param int $processImdb (optional) Attempt to find IMDB id's in the NZB? - * @param int $processTv (optional) Attempt to find Tv id's in the NZB? - * + * @param $nntp + * @param string $groupID (optional) Group ID. + * @param string $guidChar (optional) First character of the release GUID (used for multi-processing). + * @param int $processImdb (optional) Attempt to find IMDB id's in the NZB? + * @param int $processTv (optional) Attempt to find Tv id's in the NZB? * @return int How many NFO's were processed? + * * @throws \Exception */ public function processNfoFiles($nntp, $groupID = '', $guidChar = '', $processImdb = 1, $processTv = 1): int @@ -389,6 +388,7 @@ class Nfo * To use in a query. * * @return string + * * @throws \Exception * @static */ diff --git a/Blacklight/Regexes.php b/Blacklight/Regexes.php index 24b571cf9..aff03f739 100755 --- a/Blacklight/Regexes.php +++ b/Blacklight/Regexes.php @@ -37,7 +37,8 @@ class Regexes protected $_categoriesID = Category::OTHER_MISC; /** - * @param array $options + * @param array $options + * * @throws \Exception */ public function __construct(array $options = []) @@ -54,8 +55,7 @@ class Regexes /** * Add a new regex. * - * @param array $data - * + * @param array $data * @return bool */ public function addRegex(array $data): bool @@ -78,8 +78,7 @@ class Regexes /** * Update a regex with new info. * - * @param array $data - * + * @param array $data * @return bool */ public function updateRegex(array $data): bool @@ -104,8 +103,7 @@ class Regexes /** * Get a single regex using its id. * - * @param int $id - * + * @param int $id * @return array */ public function getRegexByID($id): array @@ -114,8 +112,7 @@ class Regexes } /** - * @param string $group_regex - * + * @param string $group_regex * @return mixed */ public function getRegex($group_regex = '') @@ -140,8 +137,7 @@ class Regexes /** * Get the count of regex in the DB. * - * @param string $group_regex Optional, keyword to find a group. - * + * @param string $group_regex Optional, keyword to find a group. * @return int */ public function getCount($group_regex = ''): int @@ -160,7 +156,7 @@ class Regexes /** * Delete a regex using its id. * - * @param int $id + * @param int $id * * @throws \Throwable */ @@ -176,11 +172,11 @@ class Regexes * * Requires table per group to be on. * - * @param string $groupName - * @param string $regex - * @param int $limit - * + * @param string $groupName + * @param string $regex + * @param int $limit * @return array + * * @throws \Exception */ public function testCollectionRegex($groupName, $regex, $limit): array @@ -247,6 +243,7 @@ class Regexes * @param $displayLimit * @param $queryLimit * @return array + * * @throws \Exception */ public function testReleaseNamingRegex($groupName, $regex, $displayLimit, $queryLimit): array @@ -288,10 +285,10 @@ class Regexes /** * This will try to find regex in the DB for a group and a usenet subject, attempt to match them and return the matches. * - * @param string $subject - * @param string $groupName - * + * @param string $subject + * @param string $groupName * @return string + * * @throws \Exception */ public function tryRegex($subject, $groupName): string @@ -324,7 +321,7 @@ class Regexes * Get the regex from the DB, cache them locally for 15 mins. * Cache them also in the cache server, as this script might be terminated. * - * @param string $groupName + * @param string $groupName */ protected function _fetchRegex($groupName): void { @@ -351,10 +348,10 @@ class Regexes * * Requires at least 1 named captured group. * - * @param string $regex - * @param string $subject - * + * @param string $regex + * @param string $subject * @return string + * * @throws \Exception */ protected function _matchRegex($regex, $subject): string @@ -386,8 +383,7 @@ class Regexes /** * Format part of a query. * - * @param string $group_regex - * + * @param string $group_regex * @return string */ protected function _groupQueryString($group_regex): string diff --git a/Blacklight/ReleaseCleaning.php b/Blacklight/ReleaseCleaning.php index fd55fc79f..4e4de4470 100755 --- a/Blacklight/ReleaseCleaning.php +++ b/Blacklight/ReleaseCleaning.php @@ -15,6 +15,7 @@ class ReleaseCleaning { /** * Used for matching endings in article subjects. + * * @const * @string */ @@ -22,6 +23,7 @@ class ReleaseCleaning /** * Used for matching file extension endings in article subjects. + * * @const * @string */ @@ -29,6 +31,7 @@ class ReleaseCleaning /** * Used for matching size strings in article subjects. + * * @example ' - 365.15 KB - ' * @const * @string @@ -90,12 +93,12 @@ class ReleaseCleaning } /** - * @param $subject - * @param $fromName - * @param $groupName - * @param bool $usePre - * + * @param $subject + * @param $fromName + * @param $groupName + * @param bool $usePre * @return array|false|string + * * @throws \Exception */ public function releaseCleaner($subject, $fromName, $groupName, $usePre = false) @@ -424,7 +427,6 @@ class ReleaseCleaning /** * @param $subject - * * @return string */ public function releaseCleanerHelper($subject): string @@ -438,7 +440,6 @@ class ReleaseCleaning * Cleans release name for the namefixer class. * * @param $name - * * @return mixed|string */ public function fixerCleaner($name) diff --git a/Blacklight/ReleaseExtra.php b/Blacklight/ReleaseExtra.php index 15e4eb13e..52a60a49c 100755 --- a/Blacklight/ReleaseExtra.php +++ b/Blacklight/ReleaseExtra.php @@ -24,7 +24,6 @@ class ReleaseExtra /** * @param $id - * * @return \Illuminate\Database\Eloquent\Model|null|static */ public function get($id) @@ -35,7 +34,6 @@ class ReleaseExtra /** * @param $id - * * @return array|false */ public function getVideo($id) @@ -51,7 +49,6 @@ class ReleaseExtra /** * @param $id - * * @return array|false */ public function getAudio($id) @@ -67,7 +64,6 @@ class ReleaseExtra /** * @param $id - * * @return \Illuminate\Database\Eloquent\Model|null|static */ public function getSubs($id) @@ -76,8 +72,7 @@ class ReleaseExtra } /** - * @param string $guid - * + * @param string $guid * @return array */ public function getBriefByGuid($guid): array @@ -98,7 +93,6 @@ class ReleaseExtra /** * @param $guid - * * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Model|\Illuminate\Database\Query\Builder|null|object */ public function getByGuid($guid) @@ -117,8 +111,8 @@ class ReleaseExtra } /** - * @param $releaseID - * @param \Mhor\MediaInfo\Container\MediaInfoContainer $arrXml + * @param $releaseID + * @param \Mhor\MediaInfo\Container\MediaInfoContainer $arrXml */ public function addFromXml($releaseID, MediaInfoContainer $arrXml): void { @@ -369,8 +363,8 @@ class ReleaseExtra } /** - * @param int $releaseID - * @param string $uniqueId + * @param int $releaseID + * @param string $uniqueId */ public function addUID($releaseID, $uniqueId): void { @@ -388,7 +382,6 @@ class ReleaseExtra /** * @param $id - * * @return \Illuminate\Database\Eloquent\Model|null|static */ public function getFull($id) @@ -407,8 +400,8 @@ class ReleaseExtra } /** - * @param $id - * @param \Mhor\MediaInfo\Container\MediaInfoContainer $xmlArray + * @param $id + * @param \Mhor\MediaInfo\Container\MediaInfoContainer $xmlArray */ public function addFull($id, MediaInfoContainer $xmlArray): void { diff --git a/Blacklight/ReleaseImage.php b/Blacklight/ReleaseImage.php index 7be1f565a..fe12a8360 100755 --- a/Blacklight/ReleaseImage.php +++ b/Blacklight/ReleaseImage.php @@ -71,8 +71,7 @@ class ReleaseImage } /** - * @param $imgLoc - * + * @param $imgLoc * @return bool|\Intervention\Image\Image */ protected function fetchImage($imgLoc) @@ -105,14 +104,12 @@ class ReleaseImage /** * Save an image to disk, optionally resizing it. * - * @param string $imgName What to name the new image. - * @param string $imgLoc URL or location on the disk the original image is in. - * @param string $imgSavePath Folder to save the new image in. - * @param string $imgMaxWidth Max width to resize image to. (OPTIONAL) - * @param string $imgMaxHeight Max height to resize image to. (OPTIONAL) - * @param bool $saveThumb Save a thumbnail of this image? (OPTIONAL) - * - * + * @param string $imgName What to name the new image. + * @param string $imgLoc URL or location on the disk the original image is in. + * @param string $imgSavePath Folder to save the new image in. + * @param string $imgMaxWidth Max width to resize image to. (OPTIONAL) + * @param string $imgMaxHeight Max height to resize image to. (OPTIONAL) + * @param bool $saveThumb Save a thumbnail of this image? (OPTIONAL) * @return int 1 on success, 0 on failure Used on site to check if there is an image. */ public function saveImage($imgName, $imgLoc, $imgSavePath, $imgMaxWidth = '', $imgMaxHeight = '', $saveThumb = false): int @@ -157,8 +154,7 @@ class ReleaseImage /** * Delete images for the release. * - * @param string $guid The GUID of the release. - * + * @param string $guid The GUID of the release. * @return void */ public function delete($guid): void diff --git a/Blacklight/ReleaseRemover.php b/Blacklight/ReleaseRemover.php index 308d9d16a..2cd92f8ed 100755 --- a/Blacklight/ReleaseRemover.php +++ b/Blacklight/ReleaseRemover.php @@ -106,7 +106,8 @@ class ReleaseRemover /** * Construct. * - * @param array $options Class instances / various options. + * @param array $options Class instances / various options. + * * @throws \Exception */ public function __construct(array $options = []) @@ -137,13 +138,13 @@ class ReleaseRemover /** * Remove releases using user criteria. * - * @param array $arguments Array of criteria used to delete unwanted releases. - * Criteria must look like this : columnName=modifier="content" - * columnName is a column name from the releases table. - * modifiers are : equals,like,bigger,smaller - * content is what to change the column content to - * + * @param array $arguments Array of criteria used to delete unwanted releases. + * Criteria must look like this : columnName=modifier="content" + * columnName is a column name from the releases table. + * modifiers are : equals,like,bigger,smaller + * content is what to change the column content to * @return string|bool + * * @throws \Exception */ public function removeByCriteria($arguments) @@ -202,13 +203,13 @@ class ReleaseRemover /** * Delete crap releases. * - * @param bool $delete Delete the release or just show the result? - * @param int|string $time Time in hours (to select old releases) or 'full' for no time limit. - * @param string $type Type of query to run [blacklist, executable, gibberish, hashed, installbin, passworded, - * passwordurl, sample, scr, short, size, ''] ('' runs against all types) - * @param string|int $blacklistID - * + * @param bool $delete Delete the release or just show the result? + * @param int|string $time Time in hours (to select old releases) or 'full' for no time limit. + * @param string $type Type of query to run [blacklist, executable, gibberish, hashed, installbin, passworded, + * passwordurl, sample, scr, short, size, ''] ('' runs against all types) + * @param string|int $blacklistID * @return string|bool + * * @throws \Exception */ public function removeCrap($delete, $time, $type = '', $blacklistID = '') @@ -333,6 +334,7 @@ class ReleaseRemover * Remove releases with 15 or more letters or numbers, nothing else. * * @return bool|string + * * @throws \Exception */ protected function removeGibberish() @@ -362,6 +364,7 @@ class ReleaseRemover * Remove releases with 25 or more letters/numbers, probably hashed. * * @return bool|string + * * @throws \Exception */ protected function removeHashed() @@ -392,6 +395,7 @@ class ReleaseRemover * Remove releases with 5 or less letters/numbers. * * @return bool|string + * * @throws \Exception */ protected function removeShort() @@ -421,6 +425,7 @@ class ReleaseRemover * Remove releases with an exe file not in other misc or pc apps/games. * * @return bool|string + * * @throws \Exception */ protected function removeExecutable() @@ -452,6 +457,7 @@ class ReleaseRemover * Remove releases with an install.bin file. * * @return bool|string + * * @throws \Exception */ protected function removeInstallBin() @@ -478,6 +484,7 @@ class ReleaseRemover * Remove releases with an password.url file. * * @return bool|string + * * @throws \Exception */ protected function removePasswordURL() @@ -504,6 +511,7 @@ class ReleaseRemover * Remove releases with password in the search name. * * @return bool|string + * * @throws \Exception */ protected function removePassworded() @@ -553,6 +561,7 @@ class ReleaseRemover * Remove releases smaller than 2MB with 1 part not in MP3/books/misc section. * * @return bool|string + * * @throws \Exception */ protected function removeSize() @@ -589,6 +598,7 @@ class ReleaseRemover * Remove releases bigger than 200MB with just a single file. * * @return bool|string + * * @throws \Exception */ protected function removeHuge() @@ -613,6 +623,7 @@ class ReleaseRemover * Remove releases that are just a single nzb file. * * @return bool|string + * * @throws \Exception */ protected function removeSingleNZB() @@ -639,6 +650,7 @@ class ReleaseRemover * Remove releases with more than 1 part, less than 40MB, sample in name. TV/Movie sections. * * @return bool|string + * * @throws \Exception */ protected function removeSample() @@ -682,6 +694,7 @@ class ReleaseRemover * Remove releases with a scr file in the filename/subject. * * @return bool|string + * * @throws \Exception */ protected function removeSCR() @@ -708,6 +721,7 @@ class ReleaseRemover * Remove releases using the site blacklist regexes. * * @return bool + * * @throws \Exception */ protected function removeBlacklist(): bool @@ -841,6 +855,7 @@ class ReleaseRemover * Remove releases using the site blacklist regexes against file names. * * @return bool + * * @throws \Exception */ protected function removeBlacklistFiles(): bool @@ -936,6 +951,7 @@ class ReleaseRemover * Thanks to dizant from nZEDb forums for the sql query. * * @return string|bool + * * @throws \Exception */ protected function removeWMV() @@ -961,6 +977,7 @@ class ReleaseRemover * Thanks to dizant from nZEDb forums for parts of the sql query. * * @return string|bool + * * @throws \Exception */ protected function removeCodecPoster() @@ -1023,6 +1040,7 @@ class ReleaseRemover * Delete releases from the database. * * @return true + * * @throws \Exception */ protected function deleteReleases(): bool @@ -1070,8 +1088,7 @@ class ReleaseRemover /** * Go through user arguments and format part of the query. * - * @param string $argument User argument. - * + * @param string $argument User argument. * @return string|false */ protected function formatCriteriaQuery($argument) @@ -1273,8 +1290,7 @@ class ReleaseRemover /** * Remove multiple spaces and trim leading spaces. * - * @param string $string - * + * @param string $string * @return string */ protected function cleanSpaces($string): string @@ -1285,9 +1301,8 @@ class ReleaseRemover /** * Format a "like" string. ie: "name LIKE '%test%' AND name LIKE '%123%'. * - * @param string $string The string to format. - * @param string $type The column name. - * + * @param string $string The string to format. + * @param string $type The column name. * @return string */ protected function formatLike($string, $type): string @@ -1320,8 +1335,7 @@ class ReleaseRemover } /** - * @param string $dbRegex - * + * @param string $dbRegex * @return bool|mixed|string */ protected function extractSrchFromRegx($dbRegex = '') diff --git a/Blacklight/Releases.php b/Blacklight/Releases.php index ba57f156d..302d57816 100644 --- a/Blacklight/Releases.php +++ b/Blacklight/Releases.php @@ -38,6 +38,7 @@ class Releases extends Release /** * @var array Class instances. + * * @throws \Exception */ public function __construct() @@ -51,17 +52,16 @@ class Releases extends Release * Used for Browse results. * * - * @param $page - * @param $cat - * @param $start - * @param $num - * @param $orderBy - * @param int $maxAge - * @param array $excludedCats - * @param array $tags - * @param int $groupName - * @param int $minSize - * + * @param $page + * @param $cat + * @param $start + * @param $num + * @param $orderBy + * @param int $maxAge + * @param array $excludedCats + * @param array $tags + * @param int $groupName + * @param int $minSize * @return Collection|mixed */ public function getBrowseRange($page, $cat, $start, $num, $orderBy, $maxAge = -1, array $excludedCats = [], $groupName = -1, $minSize = 0, array $tags = []) @@ -129,13 +129,11 @@ class Releases extends Release /** * Used for pager on browse page. * - * @param array $cat - * @param int $maxAge - * @param array $excludedCats - * @param string|int $groupName - * - * @param array $tags - * + * @param array $cat + * @param int $maxAge + * @param array $excludedCats + * @param string|int $groupName + * @param array $tags * @return int */ public function getBrowseCount($cat, $maxAge = -1, array $excludedCats = [], $groupName = '', array $tags = []): int @@ -181,8 +179,7 @@ class Releases extends Release /** * Use to order releases on site. * - * @param string|array $orderBy - * + * @param string|array $orderBy * @return array */ public function getBrowseOrder($orderBy): array @@ -240,10 +237,9 @@ class Releases extends Release * Get list of releases available for export. * * - * @param string $postFrom - * @param string $postTo - * @param string $groupID - * + * @param string $postFrom + * @param string $postTo + * @param string $groupID * @return Collection|\Illuminate\Support\Collection|static[] */ public function getForExport($postFrom = '', $postTo = '', $groupID = '') @@ -281,6 +277,7 @@ class Releases extends Release * Get date in this format : 01/01/2014 of the oldest release. * * @note Used for exporting NZBs. + * * @return mixed */ public function getEarliestUsenetPostDate() @@ -294,6 +291,7 @@ class Releases extends Release * Get date in this format : 01/01/2014 of the newest release. * * @note Used for exporting NZBs. + * * @return mixed */ public function getLatestUsenetPostDate() @@ -306,9 +304,10 @@ class Releases extends Release /** * Gets all groups for drop down selection on NZB-Export web page. * - * @param bool $blnIncludeAll + * @param bool $blnIncludeAll * * @note Used for exporting NZBs. + * * @return array */ public function getReleasedGroupsForSelect($blnIncludeAll = true): array @@ -338,8 +337,8 @@ class Releases extends Release * @param $offset * @param $limit * @param $orderBy - * @param int $maxAge - * @param array $excludedCats + * @param int $maxAge + * @param array $excludedCats * @return Collection|mixed */ public function getShowsRange($userShows, $offset, $limit, $orderBy, $maxAge = -1, array $excludedCats = []) @@ -383,10 +382,9 @@ class Releases extends Release /** * Get count for my shows page pagination. * - * @param $userShows - * @param int $maxAge - * @param array $excludedCats - * + * @param $userShows + * @param int $maxAge + * @param array $excludedCats * @return int */ public function getShowsCount($userShows, $maxAge = -1, array $excludedCats = []): int @@ -414,7 +412,8 @@ class Releases extends Release /** * Delete multiple releases, or a single by ID. * - * @param array|int|string $list Array of GUID or ID of releases to delete. + * @param array|int|string $list Array of GUID or ID of releases to delete. + * * @throws \Exception */ public function deleteMultiple($list): void @@ -432,10 +431,10 @@ class Releases extends Release /** * Deletes a single release by GUID, and all the corresponding files. * - * @param array $identifiers ['g' => Release GUID(mandatory), 'id => ReleaseID(optional, pass - * false)] - * @param \Blacklight\NZB $nzb - * @param \Blacklight\ReleaseImage $releaseImage + * @param array $identifiers ['g' => Release GUID(mandatory), 'id => ReleaseID(optional, pass + * false)] + * @param \Blacklight\NZB $nzb + * @param \Blacklight\ReleaseImage $releaseImage * * @throws \Exception */ @@ -509,9 +508,8 @@ class Releases extends Release /** * Creates part of a query for some functions. * - * @param array|Collection $userQuery - * @param string $type - * + * @param array|Collection $userQuery + * @param string $type * @return string */ public function uSQL($userQuery, $type): string @@ -538,23 +536,23 @@ class Releases extends Release * Function for searching on the site (by subject, searchname or advanced). * * - * @param array $searchArr - * @param $groupName - * @param $sizeFrom - * @param $sizeTo - * @param $daysNew - * @param $daysOld - * @param int $offset - * @param int $limit - * @param string|array $orderBy - * @param int $maxAge - * @param array $excludedCats - * @param string $type - * @param array $cat - * @param int $minSize - * @param array $tags - * + * @param array $searchArr + * @param $groupName + * @param $sizeFrom + * @param $sizeTo + * @param $daysNew + * @param $daysOld + * @param int $offset + * @param int $limit + * @param string|array $orderBy + * @param int $maxAge + * @param array $excludedCats + * @param string $type + * @param array $cat + * @param int $minSize + * @param array $tags * @return array|Collection|mixed + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -678,17 +676,17 @@ class Releases extends Release * Search function for API. * * - * @param $searchName - * @param $groupName - * @param int $offset - * @param int $limit - * @param int $maxAge - * @param array $excludedCats - * @param array $cat - * @param int $minSize - * @param array $tags - * + * @param $searchName + * @param $groupName + * @param int $offset + * @param int $limit + * @param int $maxAge + * @param array $excludedCats + * @param array $cat + * @param int $minSize + * @param array $tags * @return Collection|mixed + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -771,19 +769,20 @@ class Releases extends Release * Search TV Shows via API. * * - * @param array $siteIdArr - * @param string $series - * @param string $episode - * @param string $airDate - * @param int $offset - * @param int $limit - * @param string $name - * @param array $cat - * @param int $maxAge - * @param int $minSize - * @param array $excludedCategories - * @param array $tags + * @param array $siteIdArr + * @param string $series + * @param string $episode + * @param string $airDate + * @param int $offset + * @param int $limit + * @param string $name + * @param array $cat + * @param int $maxAge + * @param int $minSize + * @param array $excludedCategories + * @param array $tags * @return Collection|mixed + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -920,19 +919,20 @@ class Releases extends Release * Search TV Shows via APIv2. * * - * @param array $siteIdArr - * @param string $series - * @param string $episode - * @param string $airDate - * @param int $offset - * @param int $limit - * @param string $name - * @param array $cat - * @param int $maxAge - * @param int $minSize - * @param array $excludedCategories - * @param array $tags + * @param array $siteIdArr + * @param string $series + * @param string $episode + * @param string $airDate + * @param int $offset + * @param int $limit + * @param string $name + * @param array $cat + * @param int $maxAge + * @param int $minSize + * @param array $excludedCategories + * @param array $tags * @return Collection|mixed + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -1064,13 +1064,14 @@ class Releases extends Release * * * @param $aniDbID - * @param int $offset - * @param int $limit - * @param string $name - * @param array $cat - * @param int $maxAge - * @param array $excludedCategories + * @param int $offset + * @param int $limit + * @param string $name + * @param array $cat + * @param int $maxAge + * @param array $excludedCategories * @return Collection|mixed + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -1142,18 +1143,19 @@ class Releases extends Release * Movies search through API and site. * * - * @param int $imDbId - * @param int $tmDbId - * @param int $traktId - * @param int $offset - * @param int $limit - * @param string $name - * @param array $cat - * @param int $maxAge - * @param int $minSize - * @param array $excludedCategories - * @param array $tags + * @param int $imDbId + * @param int $tmDbId + * @param int $traktId + * @param int $offset + * @param int $limit + * @param string $name + * @param array $cat + * @param int $maxAge + * @param int $minSize + * @param array $excludedCategories + * @param array $tags * @return Collection|mixed + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -1230,8 +1232,9 @@ class Releases extends Release /** * @param $currentID * @param $name - * @param array $excludedCats + * @param array $excludedCats * @return array|bool + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -1265,8 +1268,7 @@ class Releases extends Release * Get count of releases for pager. * * - * @param string $query The query to get the count from. - * + * @param string $query The query to get the count from. * @return int */ private function getPagerCount($query): int diff --git a/Blacklight/SABnzbd.php b/Blacklight/SABnzbd.php index 4758bff6e..deca66b16 100755 --- a/Blacklight/SABnzbd.php +++ b/Blacklight/SABnzbd.php @@ -58,6 +58,7 @@ class SABnzbd /** * Is sab integrated into the site or not. + * * @var bool */ public $integratedBool = false; @@ -72,12 +73,14 @@ class SABnzbd /** * User's nntmux API key to send to SAB when downloading a NZB. + * * @var string */ protected $rsstoken = ''; /** * nZEDb Site URL to send to SAB to download the NZB. + * * @var string */ protected $serverurl = ''; @@ -87,7 +90,7 @@ class SABnzbd /** * SABnzbd constructor. * - * @param \App\Http\Controllers\BasePageController $page + * @param \App\Http\Controllers\BasePageController $page * * @throws \Exception */ @@ -151,6 +154,7 @@ class SABnzbd /** * @param $guid * @return string + * * @throws \RuntimeException */ public function sendToSab($guid): string @@ -174,6 +178,7 @@ class SABnzbd /** * @return string + * * @throws \RuntimeException */ public function getAdvQueue(): string @@ -188,6 +193,7 @@ class SABnzbd /** * @return string + * * @throws \RuntimeException */ public function getHistory(): string @@ -203,6 +209,7 @@ class SABnzbd /** * @param $id * @return string + * * @throws \RuntimeException */ public function delFromQueue($id): string @@ -219,6 +226,7 @@ class SABnzbd /** * @param $id * @return string + * * @throws \RuntimeException */ public function pauseFromQueue($id): string @@ -235,6 +243,7 @@ class SABnzbd /** * @param $id * @return string + * * @throws \RuntimeException */ public function resumeFromQueue($id) @@ -250,6 +259,7 @@ class SABnzbd /** * @return string + * * @throws \RuntimeException */ public function pauseAll(): string @@ -266,6 +276,7 @@ class SABnzbd * Resume all NZB's in the SAB queue. * * @return string + * * @throws \RuntimeException */ public function resumeAll(): string diff --git a/Blacklight/Sharing.php b/Blacklight/Sharing.php index b4b5fced4..e0908abe4 100755 --- a/Blacklight/Sharing.php +++ b/Blacklight/Sharing.php @@ -65,7 +65,8 @@ class Sharing /** * Construct. * - * @param array $options Class instances. + * @param array $options Class instances. + * * @throws \Exception */ public function __construct(array $options = []) @@ -135,8 +136,7 @@ class Sharing * Initialise of reset sharing settings. * * - * @param string $siteGuid Optional hash (must be sha1) we can set the site guid to. - * + * @param string $siteGuid Optional hash (must be sha1) we can set the site guid to. * @return mixed */ public function initSettings(&$siteGuid = '') @@ -503,10 +503,10 @@ class Sharing /** * Fetch a comment and insert it. * - * @param string $messageID Message-ID for the article. - * @param string $siteID id of the site. - * + * @param string $messageID Message-ID for the article. + * @param string $siteID id of the site. * @return bool + * * @throws \Exception */ protected function insertNewComment(&$messageID, &$siteID): bool diff --git a/Blacklight/SphinxSearch.php b/Blacklight/SphinxSearch.php index 9dd1e0efd..777fbb265 100755 --- a/Blacklight/SphinxSearch.php +++ b/Blacklight/SphinxSearch.php @@ -58,7 +58,9 @@ class SphinxSearch /** * Insert release into Sphinx RT table. + * * @param $parameters + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -76,7 +78,9 @@ class SphinxSearch /** * Insert release into Sphinx RT table. + * * @param $parameters + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException @@ -94,7 +98,8 @@ class SphinxSearch /** * Delete release from Sphinx RT tables. - * @param array $identifiers ['g' => Release GUID(mandatory), 'id' => ReleaseID(optional, pass false)] + * + * @param array $identifiers ['g' => Release GUID(mandatory), 'id' => ReleaseID(optional, pass false)] */ public function deleteRelease($identifiers): void { @@ -112,8 +117,7 @@ class SphinxSearch /** * Escapes characters that are treated as special operators by the query language parser. * - * @param string $string unescaped string - * + * @param string $string unescaped string * @return string Escaped string. */ public static function escapeString($string): string @@ -127,7 +131,8 @@ class SphinxSearch /** * Update Sphinx Relases index for given releases_id. * - * @param int $releaseID + * @param int $releaseID + * * @throws \Exception */ public function updateRelease($releaseID): void @@ -147,7 +152,8 @@ class SphinxSearch /** * Update Sphinx Predb index for given predb_id. * - * @param array $parameters + * @param array $parameters + * * @throws \Exception */ public function updatePreDb($parameters): void @@ -160,7 +166,7 @@ class SphinxSearch /** * Truncate the RT index. * - * @param array $indexes + * @param array $indexes * @return bool */ public function truncateRTIndex($indexes = []): bool @@ -194,12 +200,12 @@ class SphinxSearch } /** - * @param string $rt_index (releases_rt or predb_rt) - * @param string $searchString (what are we looking for?) - * @param array $column (one or multiple columns from the columns that exist in indexes) - * @param array $searchArray - * + * @param string $rt_index (releases_rt or predb_rt) + * @param string $searchString (what are we looking for?) + * @param array $column (one or multiple columns from the columns that exist in indexes) + * @param array $searchArray * @return array + * * @throws \Foolz\SphinxQL\Exception\ConnectionException * @throws \Foolz\SphinxQL\Exception\DatabaseException * @throws \Foolz\SphinxQL\Exception\SphinxQLException diff --git a/Blacklight/Steam.php b/Blacklight/Steam.php index 1dbb51685..8903e2e82 100755 --- a/Blacklight/Steam.php +++ b/Blacklight/Steam.php @@ -41,7 +41,8 @@ class Steam /** * Steam constructor. * - * @param array $options + * @param array $options + * * @throws \Exception */ public function __construct(array $options = []) @@ -62,8 +63,7 @@ class Steam /** * Gets all Information for the game. * - * @param int $appID - * + * @param int $appID * @return array|false */ public function getAll($appID) @@ -97,9 +97,9 @@ class Steam /** * Searches Steam Apps table for best title match -- prefers 100% match but returns highest over 90%. * - * @param string $searchTerm The parsed game name from the release searchname - * + * @param string $searchTerm The parsed game name from the release searchname * @return false|int $bestMatch The Best match from the given search term + * * @throws \Exception */ public function search($searchTerm) diff --git a/Blacklight/Tmux.php b/Blacklight/Tmux.php index 32b1b32d0..d2e7ff6eb 100755 --- a/Blacklight/Tmux.php +++ b/Blacklight/Tmux.php @@ -38,7 +38,6 @@ class Tmux /** * @param $constants - * * @return mixed */ public function getConnectionsInfo($constants) @@ -59,7 +58,6 @@ class Tmux /** * @param $which * @param $connections - * * @return mixed */ public function getUSPConnections($which, $connections) @@ -97,7 +95,6 @@ class Tmux /** * @param $constants - * * @return array */ public function getListOfPanes($constants): array @@ -220,7 +217,6 @@ class Tmux /** * @param $setting * @param $value - * * @return int */ public function updateItem($setting, $value) @@ -239,8 +235,7 @@ class Tmux } /** - * @param float $bytes - * + * @param float $bytes * @return string */ public function decodeSize($bytes): string @@ -260,7 +255,6 @@ class Tmux /** * @param $pane - * * @return string */ public function writelog($pane): ?string @@ -279,8 +273,8 @@ class Tmux * @param $colors_start * @param $colors_end * @param $colors_exc - * * @return int + * * @throws \Exception */ public function get_color($colors_start, $colors_end, $colors_exc): int @@ -304,10 +298,10 @@ class Tmux * Returns random bool, weighted by $chance. * * - * @param $loop - * @param int $chance - * + * @param $loop + * @param int $chance * @return bool + * * @throws \Exception */ public function rand_bool($loop, $chance = 60): bool @@ -322,7 +316,6 @@ class Tmux /** * @param $_time - * * @return string */ public function relativeTime($_time): string @@ -334,7 +327,6 @@ class Tmux /** * @param $cmd - * * @return bool */ public function command_exist($cmd): bool @@ -345,13 +337,13 @@ class Tmux } /** - * @param $qry - * @param $bookreqids - * @param string $db_name - * @param string $ppmax - * @param string $ppmin - * + * @param $qry + * @param $bookreqids + * @param string $db_name + * @param string $ppmax + * @param string $ppmin * @return bool|string + * * @throws \Exception */ public function proc_query($qry, $bookreqids, $db_name, $ppmax = '', $ppmin = '') @@ -459,6 +451,7 @@ class Tmux /** * @return bool true if tmux is running, false otherwise. + * * @throws \RuntimeException */ public function isRunning(): bool @@ -473,6 +466,7 @@ class Tmux /** * @return bool + * * @throws \Exception */ public function stopIfRunning(): bool diff --git a/Blacklight/TmuxOutput.php b/Blacklight/TmuxOutput.php index cb3840a55..08e836e39 100755 --- a/Blacklight/TmuxOutput.php +++ b/Blacklight/TmuxOutput.php @@ -41,6 +41,7 @@ class TmuxOutput extends Tmux /** * @param $runVar + * * @throws \Cz\Git\GitException */ public function updateMonitorPane(&$runVar): void @@ -108,7 +109,6 @@ class TmuxOutput extends Tmux /** * @param $compressed - * * @return array */ protected function _getFormatMasks($compressed): array @@ -126,6 +126,7 @@ class TmuxOutput extends Tmux /** * @return string + * * @throws \Cz\Git\GitException */ protected function _getHeader(): string diff --git a/Blacklight/XXX.php b/Blacklight/XXX.php index 7b8e0aafa..b20ad047b 100755 --- a/Blacklight/XXX.php +++ b/Blacklight/XXX.php @@ -70,7 +70,7 @@ class XXX protected $colorCli; /** - * @param array $options Echo to cli / Class instances. + * @param array $options Echo to cli / Class instances. * * @throws \Exception */ @@ -107,13 +107,12 @@ class XXX * Get XXX releases with covers for xxx browse page. * * @param $page - * @param $cat - * @param $start - * @param $num - * @param $orderBy - * @param int $maxAge - * @param array $excludedCats - * + * @param $cat + * @param $start + * @param $num + * @param $orderBy + * @param int $maxAge + * @param array $excludedCats * @return array */ public function getXXXRange($page, $cat, $start, $num, $orderBy, $maxAge = -1, array $excludedCats = []): array @@ -231,7 +230,6 @@ class XXX * Get the order type the user requested on the xxx page. * * @param $orderBy - * * @return array */ protected function getXXXOrder($orderBy): array @@ -286,20 +284,20 @@ class XXX /** * Update XXX Information from getXXXCovers.php in misc/testing/PostProc. * - * @param string $id - * @param string $title - * @param string $tagLine - * @param string $plot - * @param string $genre - * @param string $director - * @param string $actors - * @param string $extras - * @param string $productInfo - * @param string $trailers - * @param string $directUrl - * @param string $classUsed - * @param string $cover - * @param string $backdrop + * @param string $id + * @param string $title + * @param string $tagLine + * @param string $plot + * @param string $genre + * @param string $director + * @param string $actors + * @param string $extras + * @param string $productInfo + * @param string $trailers + * @param string $directUrl + * @param string $classUsed + * @param string $cover + * @param string $backdrop */ public function update( $id = '', @@ -342,7 +340,7 @@ class XXX * Get all genres for search-filter.tpl. * * - * @param bool $activeOnly + * @param bool $activeOnly * @return array */ public function getAllGenres($activeOnly = false): array @@ -362,8 +360,8 @@ class XXX } /** - * @param bool $activeOnly - * @param null $gid + * @param bool $activeOnly + * @param null $gid * @return mixed */ public function getGenres($activeOnly = false, $gid = null) @@ -383,7 +381,6 @@ class XXX * Get Genre id's Of the title. * * @param $arr - Array or String - * * @return string - If array .. 1,2,3,4 if string .. 1 */ protected function getGenreID($arr): string @@ -433,7 +430,6 @@ class XXX * * @param $whichClass * @param $res - * * @return string */ public function insertSwf($whichClass, $res): string @@ -461,8 +457,8 @@ class XXX /** * @param $movie - * * @return false|int|string + * * @throws \Exception */ public function updateXXXInfo($movie) @@ -690,8 +686,7 @@ class XXX /** * Cleans up a searchname to make it easier to scrape. * - * @param string $releaseName - * + * @param string $releaseName * @return bool */ protected function parseXXXSearchName($releaseName): bool diff --git a/Blacklight/build/ComposerScripts.php b/Blacklight/build/ComposerScripts.php index 55bf8a1f9..e143396ad 100644 --- a/Blacklight/build/ComposerScripts.php +++ b/Blacklight/build/ComposerScripts.php @@ -13,6 +13,7 @@ * not, see:. * * @link . + * * @author niel * @copyright 2017 nZEDb */ diff --git a/Blacklight/db/PreDb.php b/Blacklight/db/PreDb.php index 7934c4caa..bef5aa802 100755 --- a/Blacklight/db/PreDb.php +++ b/Blacklight/db/PreDb.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author niel * @copyright 2014 nZEDb */ @@ -83,14 +84,13 @@ class PreDb } /** - * @param array|null $options array of parameter. - * 'enclosedby' - string for enclosed by clause. default: empty string, - * 'fields' - string for FIELDS SEPARATED BY clause. default: '\t', - * 'limit' - string for LIMIT clause. Zero indicate no clause. Default: 0, - * 'lines' - string for LINES TERMINATED BY. Default: '\r\n' (Windows style EOLs to allow \n to be used in text), - * 'path' - path (including filename) to write data to. - * All parameter will be escaped before use. - * + * @param array|null $options array of parameter. + * 'enclosedby' - string for enclosed by clause. default: empty string, + * 'fields' - string for FIELDS SEPARATED BY clause. default: '\t', + * 'limit' - string for LIMIT clause. Zero indicate no clause. Default: 0, + * 'lines' - string for LINES TERMINATED BY. Default: '\r\n' (Windows style EOLs to allow \n to be used in text), + * 'path' - path (including filename) to write data to. + * All parameter will be escaped before use. * @return false|\PDOStatement */ public function executeExport(array $options = null) @@ -141,8 +141,7 @@ SQL_EXPORT; } /** - * @param array|null $options - * + * @param array|null $options * @return null */ public function executeLoadData(array $options = null) @@ -189,8 +188,8 @@ SQL_EXPORT; } /** - * @param $filespec - * @param bool $localDB + * @param $filespec + * @param bool $localDB */ public function import($filespec, $localDB = false) { @@ -212,10 +211,10 @@ SQL_EXPORT; } /** - * @param null $settings - * @param array $options - * + * @param null $settings + * @param array $options * @return mixed|null + * * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException */ public function progress($settings = null, array $options = []) @@ -236,8 +235,8 @@ SQL_EXPORT; } /** - * @param bool $localDB - * @param string $enclosedby + * @param bool $localDB + * @param string $enclosedby */ protected function prepareImportSQL($localDB = false, $enclosedby = '') { @@ -256,7 +255,7 @@ SQL_EXPORT; /** * @param $sql - * @param string $index + * @param string $index */ protected function prepareSQLStatement($sql, $index): void { @@ -305,7 +304,7 @@ SQL_INSERT; } /** - * @param array $options + * @param array $options */ protected function prepareSQLLoadData(array $options = []): void { diff --git a/Blacklight/db/populate/AniDB.php b/Blacklight/db/populate/AniDB.php index 8e32b662f..7b872951d 100755 --- a/Blacklight/db/populate/AniDB.php +++ b/Blacklight/db/populate/AniDB.php @@ -16,36 +16,42 @@ class AniDB /** * Whether or not to echo message output. + * * @var bool */ public $echooutput; /** * The directory to store AniDB covers. + * * @var string */ public $imgSavePath; /** * The name of the nZEDb client for AniDB lookups. + * * @var string */ private $apiKey; /** * Whether or not AniDB thinks our client is banned. + * * @var bool */ private $banned; /** * The last unixtime a full AniDB update was run. + * * @var string */ private $lastUpdate; /** * The number of days between full AniDB updates. + * * @var string */ private $updateInterval; @@ -56,7 +62,7 @@ class AniDB protected $colorCli; /** - * @param array $options Class instances / Echo to cli. + * @param array $options Class instances / Echo to cli. * * @throws \Exception */ @@ -85,8 +91,8 @@ class AniDB /** * Main switch that initiates AniDB table population. * - * @param string $type - * @param int|string $anidbId + * @param string $type + * @param int|string $anidbId * * @throws \Exception */ @@ -104,7 +110,6 @@ class AniDB /** * @param $anidbId - * * @return array|false */ private function getAniDbAPI($anidbId) @@ -182,11 +187,9 @@ class AniDB } /** - * @param \SimpleXMLElement $element - * @param string $property - * - * @param bool $children - * + * @param \SimpleXMLElement $element + * @param string $property + * @param bool $children * @return string */ private function processAPIResponseElement(\SimpleXMLElement $element, $property = null, $children = false): string @@ -238,10 +241,10 @@ class AniDB /** * Inserts new anime info from AniDB to anidb table. * - * @param int $id The AniDB ID to be inserted - * @param string $type The title type - * @param string $lang The title language - * @param string $title The title of the Anime + * @param int $id The AniDB ID to be inserted + * @param string $type The title type + * @param string $lang The title language + * @param string $title The title of the Anime */ private function insertAniDb($id, $type, $lang, $title): void { @@ -257,8 +260,7 @@ class AniDB /** * Inserts new anime info from AniDB to anidb table. * - * @param array $AniDBInfoArray - * + * @param array $AniDBInfoArray * @return string */ private function insertAniDBInfoEps(array $AniDBInfoArray = [], $anidbId): string @@ -291,7 +293,7 @@ class AniDB /** * Inserts new anime info from AniDB to anidb table. * - * @param array $episodeArr + * @param array $episodeArr */ private function insertAniDBEpisodes(array $episodeArr = [], $anidbId): void { @@ -375,7 +377,7 @@ class AniDB /** * Directs flow for populating the AniDB Info/Episodes table. * - * @param string $anidbId + * @param string $anidbId * * @throws \Exception */ @@ -438,8 +440,7 @@ class AniDB /** * Updates existing anime info in anidb info/episodes tables. * - * @param array $AniDBInfoArray - * + * @param array $AniDBInfoArray * @return string */ private function updateAniDBInfoEps(array $AniDBInfoArray = [], $anidbId): string @@ -472,8 +473,8 @@ class AniDB /** * Directs flow for updating child AniDB tables. * - * @param array $AniDBInfoArray - * @param $anidbId + * @param array $AniDBInfoArray + * @param $anidbId */ private function updateAniChildTables(array $AniDBInfoArray = [], $anidbId): void { diff --git a/Blacklight/http/API.php b/Blacklight/http/API.php index fc0338bfd..5bff4f11a 100755 --- a/Blacklight/http/API.php +++ b/Blacklight/http/API.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author ruhllatio * @copyright 2016 nZEDb */ @@ -38,7 +39,8 @@ class API extends Capabilities public $getRequest; /** - * @param array $options + * @param array $options + * * @throws \Exception */ public function __construct(array $options = []) @@ -55,7 +57,8 @@ class API extends Capabilities /** * Add language from media info XML to release search names (Used by API). - * @param array $releases + * + * @param array $releases */ public function addLanguage(&$releases): void { @@ -94,6 +97,7 @@ class API extends Capabilities /** * Verify cat parameter. + * * @return array */ public function categoryID(): array @@ -115,6 +119,7 @@ class API extends Capabilities * Verify groupName parameter. * * @return mixed + * * @throws \Exception */ public function group() @@ -132,6 +137,7 @@ class API extends Capabilities /** * Verify limit parameter. + * * @return int */ public function limit(): int @@ -146,6 +152,7 @@ class API extends Capabilities /** * Verify offset parameter. + * * @return int */ public function offset(): int @@ -160,7 +167,8 @@ class API extends Capabilities /** * Check if a parameter is empty. - * @param string $parameter + * + * @param string $parameter */ public function verifyEmptyParameter($parameter): void { @@ -171,7 +179,7 @@ class API extends Capabilities /** * @param $releases - * @param callable $getCoverURL + * @param callable $getCoverURL */ public function addCoverURL(&$releases, callable $getCoverURL): void { diff --git a/Blacklight/http/Capabilities.php b/Blacklight/http/Capabilities.php index 5adaacd9f..74b44e7de 100755 --- a/Blacklight/http/Capabilities.php +++ b/Blacklight/http/Capabilities.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author ruhllatio * @copyright 2016 nZEDb */ @@ -43,7 +44,8 @@ abstract class Capabilities /** * Construct. * - * @param array $options Class instances. + * @param array $options Class instances. + * * @throws \Exception */ public function __construct(array $options = []) @@ -57,11 +59,11 @@ abstract class Capabilities /** * Print XML or JSON output. * - * @param array|\Illuminate\Database\Eloquent\Collection $data Data to print. - * @param array $params Additional request parameters - * @param bool $xml True: Print as XML False: Print as JSON. - * @param int $offset How much releases to skip - * @param string $type What type of API query to format if XML + * @param array|\Illuminate\Database\Eloquent\Collection $data Data to print. + * @param array $params Additional request parameters + * @param bool $xml True: Print as XML False: Print as JSON. + * @param int $offset How much releases to skip + * @param string $type What type of API query to format if XML * * @throws \Exception */ @@ -114,6 +116,7 @@ abstract class Capabilities * Collect and return various capability information for usage in API. * * @return array + * * @throws \Exception */ public function getForMenu(): array diff --git a/Blacklight/http/RSS.php b/Blacklight/http/RSS.php index 82ac1e9db..62d9857fd 100755 --- a/Blacklight/http/RSS.php +++ b/Blacklight/http/RSS.php @@ -22,7 +22,7 @@ class RSS extends Capabilities public $releases; /** - * @param array $options + * @param array $options * * @throws \Exception */ @@ -42,15 +42,13 @@ class RSS extends Capabilities * Get releases for RSS. * * - * @param $cat - * @param int $offset - * @param $videosId - * @param $aniDbID - * @param int $userID - * @param int $airDate - * - * @param int $limit - * + * @param $cat + * @param int $offset + * @param $videosId + * @param $aniDbID + * @param int $userID + * @param int $airDate + * @param int $limit * @return \Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection|\Illuminate\Database\Query\Builder[]|\Illuminate\Support\Collection|mixed */ public function getRss($cat, $videosId, $aniDbID, $userID = 0, $airDate = -1, int $limit = 100, int $offset = 0) @@ -119,12 +117,12 @@ class RSS extends Capabilities } /** - * @param int $limit - * @param int $userID - * @param array $excludedCats - * @param int $airDate - * + * @param int $limit + * @param int $userID + * @param array $excludedCats + * @param int $airDate * @return \Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection + * * @throws \Exception */ public function getShowsRss($limit, $userID = 0, array $excludedCats = [], $airDate = -1) @@ -182,11 +180,11 @@ class RSS extends Capabilities * Get movies for RSS. * * - * @param int $limit - * @param int $userID - * @param array $excludedCats - * + * @param int $limit + * @param int $userID + * @param array $excludedCats * @return \Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection|mixed + * * @throws \Exception */ public function getMyMoviesRss($limit, $userID = 0, array $excludedCats = []) @@ -243,7 +241,6 @@ class RSS extends Capabilities * @param $column * @param $table * @param $order - * * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Query\Builder|null */ public function getFirstInstance($column, $table, $order) diff --git a/Blacklight/http/XML_Response.php b/Blacklight/http/XML_Response.php index 1f339d9ac..e804d4bc8 100755 --- a/Blacklight/http/XML_Response.php +++ b/Blacklight/http/XML_Response.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author ruhllatio * @copyright 2016 nZEDb */ @@ -92,7 +93,7 @@ class XML_Response /** * XMLReturn constructor. * - * @param array $options + * @param array $options */ public function __construct(array $options = []) { @@ -207,7 +208,7 @@ class XML_Response /** * Starts a new element, loops through the attribute data and ends the element. * - * @param array $element An array with the name of the element and the attribute data + * @param array $element An array with the name of the element and the attribute data */ protected function addNode($element): void { @@ -221,7 +222,7 @@ class XML_Response /** * Starts a new element, loops through the attribute data and ends the element. * - * @param array $element An array with the name of the element and the attribute data + * @param array $element An array with the name of the element and the attribute data */ protected function addNodes($element): void { @@ -515,8 +516,8 @@ class XML_Response /** * Writes individual zed (newznab) type attributes. * - * @param string $name The namespaced attribute name tag - * @param string $value The namespaced attribute value + * @param string $name The namespaced attribute name tag + * @param string $value The namespaced attribute value */ protected function writeZedAttr($name, $value): void { @@ -683,8 +684,7 @@ class XML_Response /** * Accepts an array of values to loop through to build cData from the release info. * - * @param array $columns The columns in the release we need to insert - * + * @param array $columns The columns in the release we need to insert * @return string The HTML format cData */ protected function buildCdata($columns): string diff --git a/Blacklight/libraries/FanartTV.php b/Blacklight/libraries/FanartTV.php index 31e5089b9..5e597139b 100644 --- a/Blacklight/libraries/FanartTV.php +++ b/Blacklight/libraries/FanartTV.php @@ -40,8 +40,7 @@ class FanartTV /** * Getting movie pictures. * - * @param string $id - * + * @param string $id * @return array|false */ public function getMovieFanArt($id) @@ -61,7 +60,7 @@ class FanartTV /** * Getting tv show pictures. * - * @param string $id + * @param string $id * @return array|false */ public function getTVFanart($id) @@ -81,7 +80,7 @@ class FanartTV /** * The function making all the work using curl to call. * - * @param string $path + * @param string $path * @return false|array */ private function _getUrl($path) diff --git a/Blacklight/libraries/Forking.php b/Blacklight/libraries/Forking.php index e94ba3637..8f01c12b8 100755 --- a/Blacklight/libraries/Forking.php +++ b/Blacklight/libraries/Forking.php @@ -138,8 +138,8 @@ class Forking * Setup the class to work on a type of work, then process the work. * Valid work types:. * - * @param string $type The type of multiProcessing to do : backfill, binaries, releases, postprocess - * @param array $options Array containing arguments for the type of work. + * @param string $type The type of multiProcessing to do : backfill, binaries, releases, postprocess + * @param array $options Array containing arguments for the type of work. * * @throws \Exception */ @@ -649,8 +649,8 @@ class Forking * Only 1 exit method is used for post process, since they are all similar. * * - * @param array $releases - * @param int $maxProcess + * @param array $releases + * @param int $maxProcess */ public function postProcess($releases, $maxProcess) { @@ -734,6 +734,7 @@ class Forking * Check if we should process NFO's. * * @return bool + * * @throws \Exception */ private function checkProcessNfo(): bool @@ -774,6 +775,7 @@ class Forking /** * @return bool + * * @throws \Exception */ private function checkProcessMovies(): bool @@ -825,7 +827,9 @@ class Forking /** * Check if we should process TV's. + * * @return bool + * * @throws \Exception */ private function checkProcessTV() @@ -879,7 +883,9 @@ class Forking /** * Process sharing. + * * @return bool + * * @throws \Exception */ private function processSharing() @@ -952,7 +958,7 @@ class Forking /** * Execute a shell command. * - * @param string $command + * @param string $command * @return string */ protected function _executeCommand($command) @@ -971,7 +977,7 @@ class Forking /** * Echo a message to CLI. * - * @param string $message + * @param string $message */ public function logger($message) { @@ -983,7 +989,7 @@ class Forking /** * This method is executed whenever a child is finished doing work. * - * @param string $pid The PID numbers. + * @param string $pid The PID numbers. */ public function exit($pid) { diff --git a/Blacklight/libraries/Geary.php b/Blacklight/libraries/Geary.php index 973cea122..4c271083a 100644 --- a/Blacklight/libraries/Geary.php +++ b/Blacklight/libraries/Geary.php @@ -43,8 +43,8 @@ class Geary private $gateway_secret; /** - * @param string $gateway_id Your API key obtained from https://admin.gear.mycelium.com/gateways - * @param string $gateway_secret Your API secret obtained from https://admin.gear.mycelium.com/gateways + * @param string $gateway_id Your API key obtained from https://admin.gear.mycelium.com/gateways + * @param string $gateway_secret Your API secret obtained from https://admin.gear.mycelium.com/gateways */ public function __construct($gateway_id, $gateway_secret) { @@ -57,11 +57,11 @@ class Geary * * Create a new gateway order * - * @param float $amount Amount determines the amount to be paid for this - * order. The amount should be in the currency you - * have previously set for the gateway. If the - * gateway currency is BTC, then the amount is - * normally in satoshis + * @param float $amount Amount determines the amount to be paid for this + * order. The amount should be in the currency you + * have previously set for the gateway. If the + * gateway currency is BTC, then the amount is + * normally in satoshis * @param $keychain_id * @param $callback_data * @return mixed @@ -89,7 +89,7 @@ class Geary * * Cancel existing gateway order * - * @param int $id Id is an existing order ID or payment ID + * @param int $id Id is an existing order ID or payment ID * @return mixed */ public function cancel_order($id) @@ -110,7 +110,7 @@ class Geary * * Check existing gateway order status * - * @param int $payment_id Id is an existing payment ID + * @param int $payment_id Id is an existing payment ID * @return mixed */ public function check_order($payment_id) @@ -171,7 +171,7 @@ class Geary * * Get an order link for status monitoring via websocket * - * @param int $id Id is an existing order ID + * @param int $id Id is an existing order ID * @return string */ public function order_websocket_link($id): string @@ -224,7 +224,7 @@ class Geary * * Construct an endpoint URL * - * @param string $method + * @param string $method * @return string */ private function endpoint($method): string @@ -237,7 +237,7 @@ class Geary * * Construct URL parameters * - * @param mixed $params + * @param mixed $params * @return string */ private function get_params($params): string @@ -262,7 +262,7 @@ class Geary * * Get single data from header * - * @param string $name + * @param string $name * @return string */ private function get_header($name): string @@ -285,7 +285,7 @@ class Geary * * Add data to header for authentication purpose * - * @param array $data + * @param array $data * @return array */ private function prepare_header($data): array @@ -312,7 +312,7 @@ class Geary * * Send a signed HTTP request * - * @param array $data + * @param array $data * @return mixed */ private function send_signed_request($data) diff --git a/Blacklight/libraries/TraktAPI.php b/Blacklight/libraries/TraktAPI.php index 1b5232946..05438ac85 100755 --- a/Blacklight/libraries/TraktAPI.php +++ b/Blacklight/libraries/TraktAPI.php @@ -23,6 +23,7 @@ class TraktAPI * List of headers to send to Trakt.tv when making a request. * * @see http://docs.trakt.apiary.io/#introduction/required-headers + * * @var array */ private $requestHeaders; @@ -37,6 +38,7 @@ class TraktAPI * * * @param $headers + * * @throws \Exception */ public function __construct($headers) @@ -53,12 +55,12 @@ class TraktAPI /** * Fetches summary from trakt.tv for the TV show using the trakt ID/season/episode. * - * @param int $id - * @param string $season - * @param string $ep - * @param string $type - * + * @param int $id + * @param string $season + * @param string $ep + * @param string $type * @return array|false + * * @see http://docs.trakt.apiary.io/#reference/episodes/summary/get-a-single-episode-for-a-show */ public function episodeSummary($id, $season = '', $ep = '', $type = 'min') @@ -87,6 +89,7 @@ class TraktAPI * Fetches weekend box office data from trakt.tv, updated every monday. * * @return array|false + * * @see http://docs.trakt.apiary.io/#reference/movies/box-office/get-the-weekend-box-office */ public function getBoxOffice() @@ -104,10 +107,10 @@ class TraktAPI /** * Fetches shows calendar from trakt.tv . * - * @param string $start Start date of calendar ie. 2015-09-01.Default value is today. - * @param int $days Number of days to lookup ahead. Default value is 7 days - * + * @param string $start Start date of calendar ie. 2015-09-01.Default value is today. + * @param int $days Number of days to lookup ahead. Default value is 7 days * @return array|false + * * @see http://docs.trakt.apiary.io/#reference/calendars/all-shows/get-shows */ public function getCalendar($start = '', $days = 7) @@ -125,12 +128,11 @@ class TraktAPI /** * Download JSON from Trakt, convert to array. * - * @param string $URI URI to download. - * @param string $extended Extended info from trakt tv. - * Valid values: - * 'min' Returns enough info to match locally. (Default) - * 'full' Complete info for an item - * + * @param string $URI URI to download. + * @param string $extended Extended info from trakt tv. + * Valid values: + * 'min' Returns enough info to match locally. (Default) + * 'full' Complete info for an item * @return array|false */ private function getJsonArray($URI, $extended = 'min') @@ -172,9 +174,9 @@ class TraktAPI * Fetches summary from trakt.tv for the movie. * Accept a title (the-big-lebowski-1998), a IMDB id, or a TMDB id. * - * @param string $movie Title or IMDB id. - * @param string $type imdbid: Return only the IMDB ID (returns string) - * full: Return all extended properties. (returns array) + * @param string $movie Title or IMDB id. + * @param string $type imdbid: Return only the IMDB ID (returns string) + * full: Return all extended properties. (returns array) * * @see http://docs.trakt.apiary.io/#reference/movies/summary/get-a-movie * @@ -202,9 +204,9 @@ class TraktAPI } /** - * @param int|string $id - * @param string $site - * @param int|string $type + * @param int|string $id + * @param string $site + * @param int|string $type * @return array|false|null */ public function searchId($id, $site = 'trakt', $type = 0) @@ -238,8 +240,8 @@ class TraktAPI * Fetches summary from trakt.tv for the show by doing a search. * Accepts a search string. * - * @param string $show title - * @param string $type show + * @param string $show title + * @param string $type show * * @see http://docs.trakt.apiary.io/#reference/search/get-text-query-results * @@ -258,8 +260,8 @@ class TraktAPI * Fetches summary from trakt.tv for the show. * Accepts a trakt slug (game-of-thrones), a IMDB id, or Trakt id. * - * @param string $show Title or IMDB id. - * @param string $type full: Return all extended properties. (returns array) + * @param string $show Title or IMDB id. + * @param string $type full: Return all extended properties. (returns array) * * @see http://docs.trakt.apiary.io/#reference/shows/summary/get-a-single-show * diff --git a/Blacklight/processing/PostProcess.php b/Blacklight/processing/PostProcess.php index ac04c22c8..fe9528811 100755 --- a/Blacklight/processing/PostProcess.php +++ b/Blacklight/processing/PostProcess.php @@ -45,18 +45,21 @@ class PostProcess /** * Use alternate NNTP provider when download fails? + * * @var bool */ private $alternateNNTP; /** * Add par2 info to rar list? + * * @var bool */ private $addpar2; /** * Should we echo to CLI? + * * @var bool */ private $echooutput; @@ -69,7 +72,7 @@ class PostProcess /** * Constructor. * - * @param array $options Pass in class instances. + * @param array $options Pass in class instances. * * @throws \Exception */ @@ -103,8 +106,8 @@ class PostProcess * Go through every type of post proc. * * @param $nntp - * * @return void + * * @throws \Exception */ public function processAll($nntp): void @@ -139,6 +142,7 @@ class PostProcess * Process books using amazon.com. * * @return void + * * @throws \Exception */ public function processBooks(): void @@ -171,12 +175,12 @@ class PostProcess /** * Lookup imdb if enabled. * - * @param string $groupID (Optional) ID of a group to work on. - * @param string $guidChar (Optional) First letter of a release GUID to use to get work. - * @param int|string|null $processMovies (Optional) 0 Don't process, 1 process all releases, - * 2 process renamed releases only, '' check site setting - * + * @param string $groupID (Optional) ID of a group to work on. + * @param string $guidChar (Optional) First letter of a release GUID to use to get work. + * @param int|string|null $processMovies (Optional) 0 Don't process, 1 process all releases, + * 2 process renamed releases only, '' check site setting * @return void + * * @throws \Exception */ public function processMovies($groupID = '', $guidChar = '', $processMovies = ''): void @@ -200,11 +204,11 @@ class PostProcess /** * Process nfo files. * - * @param NNTP $nntp - * @param string $groupID (Optional) ID of a group to work on. - * @param string $guidChar (Optional) First letter of a release GUID to use to get work. - * + * @param NNTP $nntp + * @param string $groupID (Optional) ID of a group to work on. + * @param string $guidChar (Optional) First letter of a release GUID to use to get work. * @return void + * * @throws \Exception */ public function processNfos(&$nntp, $groupID = '', $guidChar = ''): void @@ -217,7 +221,8 @@ class PostProcess /** * Process comments. * - * @param NNTP $nntp + * @param NNTP $nntp + * * @throws \Exception */ public function processSharing(&$nntp): void @@ -228,12 +233,12 @@ class PostProcess /** * Process all TV related releases which will assign their series/episode/rage data. * - * @param string $groupID (Optional) ID of a group to work on. - * @param string $guidChar (Optional) First letter of a release GUID to use to get work. - * @param string|int|null $processTV (Optional) 0 Don't process, 1 process all releases, - * 2 process renamed releases only, '' check site setting - * + * @param string $groupID (Optional) ID of a group to work on. + * @param string $guidChar (Optional) First letter of a release GUID to use to get work. + * @param string|int|null $processTV (Optional) 0 Don't process, 1 process all releases, + * 2 process renamed releases only, '' check site setting * @return void + * * @throws \Exception */ public function processTv($groupID = '', $guidChar = '', $processTV = ''): void @@ -264,11 +269,11 @@ class PostProcess * * @note Called externally by tmux/bin/update_per_group and update/postprocess.php * - * @param NNTP $nntp Class NNTP - * @param int|string $groupID (Optional) ID of a group to work on. - * @param string $guidChar (Optional) First char of release GUID, can be used to select work. - * + * @param NNTP $nntp Class NNTP + * @param int|string $groupID (Optional) ID of a group to work on. + * @param string $guidChar (Optional) First char of release GUID, can be used to select work. * @return void + * * @throws \Exception */ public function processAdditional(&$nntp, $groupID = '', $guidChar = ''): void @@ -281,13 +286,13 @@ class PostProcess * * @note Called from NZBContents.php * - * @param string $messageID MessageID from NZB file. - * @param int $relID ID of the release. - * @param int $groupID Group ID of the release. - * @param NNTP $nntp Class NNTP - * @param int $show Only show result or apply iy. - * + * @param string $messageID MessageID from NZB file. + * @param int $relID ID of the release. + * @param int $groupID Group ID of the release. + * @param NNTP $nntp Class NNTP + * @param int $show Only show result or apply iy. * @return bool + * * @throws \Exception */ public function parsePAR2($messageID, $relID, $groupID, &$nntp, $show): bool diff --git a/Blacklight/processing/ProcessReleases.php b/Blacklight/processing/ProcessReleases.php index f8b44d9b4..c61c02d97 100755 --- a/Blacklight/processing/ProcessReleases.php +++ b/Blacklight/processing/ProcessReleases.php @@ -102,7 +102,7 @@ class ProcessReleases private $collectionTimeout; /** - * @param array $options Class instances / Echo to cli ? + * @param array $options Class instances / Echo to cli ? * * @throws \Exception */ @@ -146,13 +146,13 @@ class ProcessReleases /** * Main method for creating releases/NZB files from collections. * - * @param int $categorize - * @param int $postProcess - * @param string $groupName (optional) - * @param \Blacklight\NNTP $nntp - * @param bool $echooutput - * + * @param int $categorize + * @param int $postProcess + * @param string $groupName (optional) + * @param \Blacklight\NNTP $nntp + * @param bool $echooutput * @return int + * * @throws \Throwable */ public function processReleases($categorize, $postProcess, $groupName, &$nntp, $echooutput): int @@ -208,7 +208,7 @@ class ProcessReleases /** * Return all releases to other->misc category. * - * @param string $where Optional "where" query parameter. + * @param string $where Optional "where" query parameter. * * @void */ @@ -222,9 +222,10 @@ class ProcessReleases /** * Categorizes releases. * - * @param string $type name or searchname | Categorize using the search name or subject. + * @param string $type name or searchname | Categorize using the search name or subject. * @param $groupId * @return int Quantity of categorized releases. + * * @throws \Exception */ public function categorizeRelease($type, $groupId): int @@ -439,9 +440,9 @@ class ProcessReleases } /** - * @param int|string $groupID (optional) - * + * @param int|string $groupID (optional) * @return array + * * @throws \Throwable */ public function createReleases($groupID): array @@ -624,9 +625,9 @@ class ProcessReleases /** * Create NZB files from complete releases. * - * @param int|string $groupID (optional) - * + * @param int|string $groupID (optional) * @return int + * * @throws \Throwable */ public function createNZBs($groupID): int @@ -674,10 +675,11 @@ class ProcessReleases /** * Categorize releases. * - * @param int $categorize - * @param int|string $groupID (optional) + * @param int $categorize + * @param int|string $groupID (optional) * * @void + * * @throws \Exception */ public function categorizeReleases($categorize, $groupID = ''): void @@ -710,10 +712,11 @@ class ProcessReleases /** * Post-process releases. * - * @param int $postProcess - * @param NNTP $nntp + * @param int $postProcess + * @param NNTP $nntp * * @void + * * @throws \Exception */ public function postProcessReleases($postProcess, &$nntp): void @@ -821,9 +824,10 @@ class ProcessReleases * Delete unwanted releases based on admin settings. * This deletes releases based on group. * - * @param int|string $groupID (optional) + * @param int|string $groupID (optional) * * @void + * * @throws \Exception */ public function deletedReleasesByGroup($groupID = ''): void @@ -883,6 +887,7 @@ class ProcessReleases * This deletes releases, regardless of group. * * @void + * * @throws \Exception */ public function deleteReleases(): void @@ -1042,9 +1047,10 @@ class ProcessReleases * This means the the binary table has the same count as the file count in the subject, but * the collection might not be complete yet since we might not have all the articles in the parts table. * - * @param int $groupID + * @param int $groupID * * @void + * * @throws \Throwable */ private function collectionFileCheckStage1($groupID): void @@ -1074,9 +1080,10 @@ class ProcessReleases * at 0 then you would never get a complete collection if it starts with 1 and if it starts, you can end up creating * a incomplete collection, since you assumed it was complete. * - * @param int $groupID + * @param int $groupID * * @void + * * @throws \Throwable */ private function collectionFileCheckStage2($groupID): void @@ -1110,9 +1117,10 @@ class ProcessReleases * Check if the files (binaries table) in a complete collection has all the parts. * If we have all the parts, set binaries table partcheck to FILE_COMPLETE. * - * @param string $where + * @param string $where * * @void + * * @throws \Throwable */ private function collectionFileCheckStage3($where): void @@ -1171,9 +1179,10 @@ class ProcessReleases * Set collections filecheck column to COLLFC_COMPPART. * This means the collection is complete. * - * @param string $where + * @param string $where * * @void + * * @throws \Throwable */ private function collectionFileCheckStage4(&$where): void @@ -1201,9 +1210,10 @@ class ProcessReleases * If not all files (binaries table) had their parts on the previous stage, * reset the collection filecheck column to COLLFC_COMPCOLL so we reprocess them next time. * - * @param int $groupId + * @param int $groupId * * @void + * * @throws \Throwable */ private function collectionFileCheckStage5($groupId): void @@ -1221,9 +1231,10 @@ class ProcessReleases * If a collection did not have the file count (ie: [00/12]) or the collection is incomplete after * $this->collectionDelayTime hours, set the collection to complete to create it into a release/nzb. * - * @param string $where + * @param string $where * * @void + * * @throws \Throwable */ private function collectionFileCheckStage6(&$where): void @@ -1248,9 +1259,10 @@ class ProcessReleases /** * If a collection has been stuck for $this->collectionTimeout hours, delete it, it's bad. * - * @param int $groupID + * @param int $groupID * * @void + * * @throws \Exception * @throws \Throwable */ diff --git a/Blacklight/processing/Videos.php b/Blacklight/processing/Videos.php index b9f734376..b9a60f580 100755 --- a/Blacklight/processing/Videos.php +++ b/Blacklight/processing/Videos.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author niel * @copyright 2015 nZEDb */ @@ -43,7 +44,7 @@ abstract class Videos public $echooutput; /** - * @var array sites The sites that we have an ID columns for in our video table. + * @var array sites The sites that we have an ID columns for in our video table. */ private static $sites = ['imdb', 'tmdb', 'trakt', 'tvdb', 'tvmaze', 'tvrage']; @@ -68,20 +69,19 @@ abstract class Videos * Main processing director function for scrapers * Calls work query function and initiates processing. * - * @param $groupID - * @param $guidChar - * @param $process - * @param bool $local + * @param $groupID + * @param $guidChar + * @param $process + * @param bool $local */ abstract protected function processSite($groupID, $guidChar, $process, $local = false): void; /** * Get video info from a Video ID and column. * - * @param string $siteColumn - * @param int $videoID - * - * @return array|false False if invalid site, or ID not found; Site id value otherwise. + * @param string $siteColumn + * @param int $videoID + * @return array|false False if invalid site, or ID not found; Site id value otherwise. */ protected function getSiteIDFromVideoID($siteColumn, $videoID) { @@ -97,8 +97,7 @@ abstract class Videos /** * Get TV show local timezone from a Video ID. * - * @param int $videoID - * + * @param int $videoID * @return string Empty string if no query return or tz style timezone */ protected function getLocalZoneFromVideoID($videoID): string @@ -129,7 +128,7 @@ abstract class Videos /** * @param $title * @param $type - * @param int $source + * @param int $source * @return $this|array|bool|false|\Illuminate\Database\Eloquent\Model|mixed|null */ public function getByTitle($title, $type, $source = 0) @@ -204,7 +203,7 @@ abstract class Videos /** * @param $title * @param $type - * @param int $source + * @param int $source * @return bool|\Illuminate\Database\Eloquent\Model|null|static */ public function getTitleExact($title, $type, $source = 0) @@ -240,10 +239,9 @@ abstract class Videos /** * Supplementary function for getByTitle that queries for a like match. * - * @param $title - * @param $type - * @param int $source - * + * @param $title + * @param $type + * @param int $source * @return array|false */ public function getTitleLoose($title, $type, $source = 0) @@ -286,7 +284,7 @@ abstract class Videos * * @param $title * @param $type - * @param int $source + * @param int $source * @return bool|\Illuminate\Database\Eloquent\Model|null|static */ public function getAlternativeTitleExact($title, $type, $source = 0) @@ -318,8 +316,8 @@ abstract class Videos /** * Inserts aliases for videos. * - * @param $videoId - * @param array $aliases + * @param $videoId + * @param array $aliases */ public function addAliases($videoId, array $aliases = []): void { @@ -343,8 +341,8 @@ abstract class Videos * Retrieves all aliases for given VideoID or VideoID for a given alias. * * - * @param int $videoId - * @param string $alias + * @param int $videoId + * @param string $alias * @return VideoAlias[]|bool|\Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection|mixed */ public function getAliases(int $videoId, string $alias = '') diff --git a/Blacklight/processing/adult/ADE.php b/Blacklight/processing/adult/ADE.php index f3b2084e6..6ea0c299c 100755 --- a/Blacklight/processing/adult/ADE.php +++ b/Blacklight/processing/adult/ADE.php @@ -9,12 +9,14 @@ class ADE extends AdultMovies { /** * If a direct link is given parse it rather then search. + * * @var string */ protected $directLink = ''; /** * Search keyword. + * * @var string */ protected $searchTerm = ''; @@ -54,6 +56,7 @@ class ADE extends AdultMovies /** * Gets Trailer Movies. + * * @return array - url, streamid, basestreamingurl */ protected function trailers() @@ -85,6 +88,7 @@ class ADE extends AdultMovies /** * Gets cover images for the xxx release. + * * @return array - Boxcover and backcover */ protected function covers() @@ -133,6 +137,7 @@ class ADE extends AdultMovies /** * Gets Genres, if exists return array else return false. + * * @return mixed array - Genres */ protected function genres() @@ -151,7 +156,7 @@ class ADE extends AdultMovies /** * Gets Product Information and/or Features. * - * @param bool $extras + * @param bool $extras * @return array - ProductInfo/Extras = features */ protected function productInfo($extras = false) @@ -188,8 +193,7 @@ class ADE extends AdultMovies /** * Searches xxx name. * - * @param string $movie - * + * @param string $movie * @return bool - True if releases has 90% match, else false */ public function processSite($movie): bool diff --git a/Blacklight/processing/adult/ADM.php b/Blacklight/processing/adult/ADM.php index 1c87cb864..73bf1e50b 100755 --- a/Blacklight/processing/adult/ADM.php +++ b/Blacklight/processing/adult/ADM.php @@ -16,24 +16,28 @@ class ADM extends AdultMovies /** * Define a cookie file location for curl. + * * @var string string */ public $cookie = ''; /** * Direct Link given from outside url doesn't do a search. + * * @var string */ protected $directLink = ''; /** * Set this for what you are searching for. + * * @var string */ protected $searchTerm = ''; /** * Sets the directurl for the return results array. + * * @var string */ protected $_directUrl = ''; @@ -52,6 +56,7 @@ class ADM extends AdultMovies /** * Add this to popurl to get results. + * * @var string */ protected $_trailUrl = ''; @@ -65,6 +70,7 @@ class ADM extends AdultMovies /** * Get Box Cover Images. + * * @return array - boxcover,backcover */ protected function covers() @@ -105,8 +111,7 @@ class ADM extends AdultMovies * Get Product Information and Director. * * - * @param bool $extras - * + * @param bool $extras * @return array */ protected function productInfo($extras = false): array @@ -130,6 +135,7 @@ class ADM extends AdultMovies /** * Gets the cast members. + * * @return array */ protected function cast(): array @@ -154,6 +160,7 @@ class ADM extends AdultMovies /** * Gets categories. + * * @return array */ protected function genres(): array @@ -176,7 +183,6 @@ class ADM extends AdultMovies * Searches for match against searchterm. * * @param $movie - * * @return bool - true if search = 100% */ public function processSite($movie): bool diff --git a/Blacklight/processing/adult/AEBN.php b/Blacklight/processing/adult/AEBN.php index 40804f6da..d1906e87e 100755 --- a/Blacklight/processing/adult/AEBN.php +++ b/Blacklight/processing/adult/AEBN.php @@ -146,8 +146,7 @@ class AEBN extends AdultMovies /** * Gets the product information. * - * @param bool $extras - * + * @param bool $extras * @return array */ protected function productInfo($extras = false): array @@ -196,8 +195,7 @@ class AEBN extends AdultMovies /** * Searches for a XXX name. * - * @param string $movie - * + * @param string $movie * @return bool */ public function processSite($movie): bool diff --git a/Blacklight/processing/adult/AdultMovies.php b/Blacklight/processing/adult/AdultMovies.php index ccefc0cce..e53628b32 100644 --- a/Blacklight/processing/adult/AdultMovies.php +++ b/Blacklight/processing/adult/AdultMovies.php @@ -30,8 +30,7 @@ abstract class AdultMovies } /** - * @param bool $extras - * + * @param bool $extras * @return mixed */ abstract protected function productInfo($extras = false); @@ -57,8 +56,7 @@ abstract class AdultMovies abstract protected function genres(); /** - * @param string $movie - * + * @param string $movie * @return mixed */ abstract public function processSite($movie); diff --git a/Blacklight/processing/adult/Hotmovies.php b/Blacklight/processing/adult/Hotmovies.php index 3076784d4..9555e68df 100755 --- a/Blacklight/processing/adult/Hotmovies.php +++ b/Blacklight/processing/adult/Hotmovies.php @@ -97,8 +97,7 @@ class Hotmovies extends AdultMovies /** * Process ProductInfo. * - * @param bool $extras - * + * @param bool $extras * @return array */ protected function productInfo($extras = false): array @@ -202,8 +201,7 @@ class Hotmovies extends AdultMovies /** * Searches for match against xxx movie name. * - * @param string $movie - * + * @param string $movie * @return bool , true if search >= 90% */ public function processSite($movie): bool diff --git a/Blacklight/processing/adult/Popporn.php b/Blacklight/processing/adult/Popporn.php index 413d7bdab..a6e21daf2 100755 --- a/Blacklight/processing/adult/Popporn.php +++ b/Blacklight/processing/adult/Popporn.php @@ -137,8 +137,7 @@ class Popporn extends AdultMovies } /** - * @param bool $extras - * + * @param bool $extras * @return array|mixed */ protected function productInfo($extras = false) @@ -251,8 +250,7 @@ class Popporn extends AdultMovies /** * Searches for match against searchterm. * - * @param string $movie - * + * @param string $movie * @return bool , true if search >= 90% */ public function processSite($movie): bool diff --git a/Blacklight/processing/post/AniDB.php b/Blacklight/processing/post/AniDB.php index db6fa2cad..07cc5d0ee 100755 --- a/Blacklight/processing/post/AniDB.php +++ b/Blacklight/processing/post/AniDB.php @@ -46,7 +46,8 @@ class AniDB protected $colorCli; /** - * @param array $options Class instances / Echo to cli. + * @param array $options Class instances / Echo to cli. + * * @throws \Exception */ public function __construct(array $options = []) @@ -117,7 +118,7 @@ class AniDB * Selects episode info for a local match. * * @param $anidbId - * @param int $episode + * @param int $episode * @return \Illuminate\Database\Eloquent\Model|null|static */ private function checkAniDBInfo($anidbId, $episode = -1) @@ -151,8 +152,7 @@ class AniDB /** * Extracts anime title and episode info from release searchname. * - * @param string $cleanName - * + * @param string $cleanName * @return array $hits */ private function extractTitleEpisode($cleanName = ''): array @@ -193,8 +193,7 @@ class AniDB * Retrieves AniDB Info using a cleaned name. * * - * @param string $searchName - * + * @param string $searchName * @return mixed */ private function getAnidbByName($searchName = '') @@ -216,8 +215,8 @@ class AniDB * * * @param $release - * * @return bool + * * @throws \Exception */ private function matchAnimeRelease($release): bool @@ -302,7 +301,6 @@ class AniDB * * * @param $anidbId - * * @return mixed */ private function updateTimeCheck($anidbId) diff --git a/Blacklight/processing/post/ProcessAdditional.php b/Blacklight/processing/post/ProcessAdditional.php index 0802ff9b4..6a2524541 100755 --- a/Blacklight/processing/post/ProcessAdditional.php +++ b/Blacklight/processing/post/ProcessAdditional.php @@ -54,6 +54,7 @@ class ProcessAdditional /** * Count of releases to work on. + * * @var int */ protected int $_totalReleases; @@ -67,6 +68,7 @@ class ProcessAdditional /** * List of files with sizes/etc contained in the NZB. + * * @var array */ protected array $_nzbContents; @@ -258,54 +260,63 @@ class ProcessAdditional /** * Have we created a video file for the current release? + * * @var bool */ protected bool $_foundVideo; /** * Have we found MediaInfo data for a Video for the current release? + * * @var bool */ protected bool $_foundMediaInfo; /** * Have we found MediaInfo data for a Audio file for the current release? + * * @var bool */ protected bool $_foundAudioInfo; /** * Have we created a short Audio file sample for the current release? + * * @var bool */ protected bool $_foundAudioSample; /** * Extension of the found audio file (MP3/FLAC/etc). + * * @var string */ protected string $_AudioInfoExtension; /** * Have we downloaded a JPG file for the current release? + * * @var bool */ protected bool $_foundJPGSample; /** * Have we created a Video JPG image sample for the current release? + * * @var bool */ protected bool $_foundSample; /** * Have we found PAR2 info on this release? + * * @var bool */ protected bool $_foundPAR2Info; /** * Message ID's for found content to download. + * * @var array */ protected array $_sampleMessageIDs; @@ -316,30 +327,35 @@ class ProcessAdditional /** * Password status of the current release. + * * @var int */ protected int $_passwordStatus; /** * Does the current release have a password? + * * @var bool */ protected bool $_releaseHasPassword; /** * Does the current release have an NFO file? + * * @var bool */ protected bool $_releaseHasNoNFO; /** * Name of the current release's usenet group. + * * @var string */ protected string $_releaseGroupName; /** * Number of file information added to DB (from rar/zip/par2 contents). + * * @var int */ protected int $_addedFileInfo; @@ -347,24 +363,28 @@ class ProcessAdditional /** * Number of file information we found from RAR/ZIP. * (if some of it was already in DB, this count goes up, while the count above does not). + * * @var int */ protected int $_totalFileInfo; /** * How many compressed (rar/zip) files have we checked. + * * @var int */ protected int $_compressedFilesChecked; /** * Should we download the last rar? + * * @var bool */ protected bool $_fetchLastFiles; /** * Are we downloading the last rar? + * * @var bool */ protected bool $_reverse; @@ -396,7 +416,8 @@ class ProcessAdditional /** * ProcessAdditional constructor. * - * @param array $options + * @param array $options + * * @throws \Exception */ public function __construct(array $options = []) @@ -531,8 +552,8 @@ class ProcessAdditional } /** - * @param string $groupID - * @param string $guidChar + * @param string $groupID + * @param string $guidChar * * @throws \Exception */ @@ -564,7 +585,8 @@ class ProcessAdditional /** * @param $guidChar - * @param string $groupID + * @param string $groupID + * * @throws \RuntimeException * @throws \Exception */ @@ -620,8 +642,8 @@ class ProcessAdditional /** * Get all releases that need to be processed. * - * @param int|string $groupID - * @param string $guidChar + * @param int|string $groupID + * @param string $guidChar * * @void */ @@ -753,8 +775,8 @@ class ProcessAdditional /** * Deletes files and folders recursively. * - * @param string $path Path to a folder or file. - * @param string[] $ignoredFolders array with paths to folders to ignore. + * @param string $path Path to a folder or file. + * @param string[] $ignoredFolders array with paths to folders to ignore. * * @void */ @@ -779,6 +801,7 @@ class ProcessAdditional * * * @return bool + * * @throws \Exception */ protected function _createTempFolder(): bool @@ -800,6 +823,7 @@ class ProcessAdditional * Get list of contents inside a release's NZB file. * * @return bool + * * @throws \Exception */ protected function _getNZBContents(): bool @@ -833,6 +857,7 @@ class ProcessAdditional /** * @return bool + * * @throws \Exception */ protected function _deleteRelease(): bool @@ -844,12 +869,14 @@ class ProcessAdditional /** * Current file we are working on inside a NZB. + * * @var array */ protected $_currentNZBFile; /** * Does the current NZB contain a compressed (RAR/ZIP) file? + * * @var bool */ protected $_NZBHasCompressedFile; @@ -933,12 +960,14 @@ class ProcessAdditional /** * List of message-id's we have tried for rar/zip files. + * * @var array */ protected $_triedCompressedMids = []; /** - * @param bool $reverse + * @param bool $reverse + * * @throws \Exception */ protected function _processNZBCompressedFiles($reverse = false): void @@ -1033,9 +1062,9 @@ class ProcessAdditional /** * Check if the data is a ZIP / RAR file, extract files, get file info. * - * @param string $compressedData - * + * @param string $compressedData * @return bool + * * @throws \Exception */ protected function _processCompressedData(&$compressedData): bool @@ -1136,6 +1165,7 @@ class ProcessAdditional * Get a list of all files in the compressed file, add the file info to the DB. * * @return bool + * * @throws \Exception */ protected function _processCompressedFileList(): bool @@ -1207,6 +1237,7 @@ class ProcessAdditional /** * @param $file + * * @throws \Exception */ protected function _addFileInfo(&$file): void @@ -1388,6 +1419,7 @@ class ProcessAdditional * Download all binaries from usenet and form samples / get media info / etc from them. * * @void + * * @throws \Exception */ protected function _processMessageIDDownloads(): void @@ -1402,6 +1434,7 @@ class ProcessAdditional * Download and process binaries for sample videos. * * @void + * * @throws \Exception */ protected function _processSampleMessageIDs(): void @@ -1448,6 +1481,7 @@ class ProcessAdditional * Download and process binaries for media info from videos. * * @void + * * @throws \Exception */ protected function _processMediaInfoMessageIDs(): void @@ -1500,6 +1534,7 @@ class ProcessAdditional * Download and process binaries for media info from songs. * * @void + * * @throws \Exception */ protected function _processAudioInfoMessageIDs(): void @@ -1535,6 +1570,7 @@ class ProcessAdditional * Download and process binaries for JPG pictures. * * @void + * * @throws \Exception */ protected function _processJPGMessageIDs(): void @@ -1635,9 +1671,8 @@ class ProcessAdditional } /** - * @param string $pattern - * @param string $path - * + * @param string $pattern + * @param string $path * @return bool|string|\Symfony\Component\Finder\SplFileInfo[] */ protected function _getTempDirectoryContents($pattern = '', $path = '') @@ -1674,6 +1709,7 @@ class ProcessAdditional * @param $fileLocation * @param $fileExtension * @return bool + * * @throws \Exception */ protected function _getAudioInfo($fileLocation, $fileExtension): bool @@ -1848,7 +1884,7 @@ class ProcessAdditional /** * Try to get JPG picture, resize it and store it on disk. * - * @param string $fileLocation + * @param string $fileLocation */ protected function _getJPGSample($fileLocation): void { @@ -1870,8 +1906,7 @@ class ProcessAdditional } /** - * @param string $videoLocation - * + * @param string $videoLocation * @return string */ private function getVideoTime($videoLocation): string @@ -1898,8 +1933,9 @@ class ProcessAdditional } /** - * @param string $fileLocation + * @param string $fileLocation * @return bool + * * @throws \Exception */ protected function _getSample(string $fileLocation): bool @@ -1967,8 +2003,9 @@ class ProcessAdditional } /** - * @param string $fileLocation + * @param string $fileLocation * @return bool + * * @throws \Exception */ protected function _getVideo(string $fileLocation): bool @@ -2091,6 +2128,7 @@ class ProcessAdditional /** * @param $fileLocation * @return bool + * * @throws \Exception */ protected function _getMediaInfo($fileLocation): bool @@ -2135,6 +2173,7 @@ class ProcessAdditional /** * @param $fileLocation + * * @throws \Exception */ protected function _siftPAR2Info($fileLocation): void @@ -2207,6 +2246,7 @@ class ProcessAdditional /** * @param $fileLocation + * * @throws \Exception */ protected function _processNfoFile($fileLocation): void @@ -2219,6 +2259,7 @@ class ProcessAdditional /** * @param $fileLocation + * * @throws \Exception */ protected function _processVideoFile($fileLocation): void @@ -2245,9 +2286,8 @@ class ProcessAdditional /** * Comparison function for uSort, for sorting NZB files. * - * @param array|null|string $a - * @param array|null|string $b - * + * @param array|null|string $a + * @param array|null|string $b * @return int */ protected function _sortNZB($a, $b): int @@ -2339,8 +2379,8 @@ class ProcessAdditional /** * Echo a string to CLI. * - * @param string $string String to echo. - * @param string $type Method type. + * @param string $string String to echo. + * @param string $type Method type. * * @void */ @@ -2354,7 +2394,7 @@ class ProcessAdditional /** * Echo a string to CLI. For debugging. * - * @param string $string + * @param string $string * * @void */ diff --git a/Blacklight/processing/tv/TMDB.php b/Blacklight/processing/tv/TMDB.php index fca4f7623..53e1114d6 100644 --- a/Blacklight/processing/tv/TMDB.php +++ b/Blacklight/processing/tv/TMDB.php @@ -42,7 +42,7 @@ class TMDB extends TV /** * Construct. Instantiate TMDB Class. * - * @param array $options Class instances. + * @param array $options Class instances. * * @throws \Exception */ @@ -56,7 +56,6 @@ class TMDB extends TV * * @param $videoId * @param $siteID - * * @return bool */ public function getBanner($videoId, $siteID): bool @@ -68,10 +67,10 @@ class TMDB extends TV * Main processing director function for TMDB * Calls work query function and initiates processing. * - * @param $groupID - * @param $guidChar - * @param $process - * @param bool $local + * @param $groupID + * @param $guidChar + * @param $process + * @param bool $local */ public function processSite($groupID, $guidChar, $process, $local = false): void { @@ -211,7 +210,6 @@ class TMDB extends TV * Returns a formatted array of show data or false if no match. * * @param $cleanName - * * @return array|false */ protected function getShowInfo($cleanName) @@ -234,9 +232,8 @@ class TMDB extends TV } /** - * @param array $shows - * @param string $cleanName - * + * @param array $shows + * @param string $cleanName * @return array|false */ private function matchShowInfo($shows, $cleanName) @@ -290,8 +287,7 @@ class TMDB extends TV /** * Retrieves the poster art for the processed show. * - * @param int $videoId -- the local Video ID - * + * @param int $videoId -- the local Video ID * @return int */ public function getPoster($videoId): int @@ -317,12 +313,11 @@ class TMDB extends TV * Gets the specific episode info for the parsed release after match * Returns a formatted array of episode data or false if no match. * - * @param int $tmdbid - * @param int $season - * @param int $episode - * @param string $airdate - * @param int $videoId - * + * @param int $tmdbid + * @param int $season + * @param int $episode + * @param string $airdate + * @param int $videoId * @return array|false */ protected function getEpisodeInfo($tmdbid, $season, $episode, $airdate = '', $videoId = 0) @@ -350,7 +345,6 @@ class TMDB extends TV * Returns the formatted array. * * @param $show - * * @return array */ protected function formatShowInfo($show): array @@ -385,7 +379,6 @@ class TMDB extends TV * Returns the formatted array. * * @param $episode - * * @return array */ protected function formatEpisodeInfo($episode): array diff --git a/Blacklight/processing/tv/TV.php b/Blacklight/processing/tv/TV.php index 9b23747de..f8eaf24c7 100755 --- a/Blacklight/processing/tv/TV.php +++ b/Blacklight/processing/tv/TV.php @@ -67,7 +67,8 @@ abstract class TV extends Videos /** * TV constructor. * - * @param array $options + * @param array $options + * * @throws \Exception */ public function __construct(array $options = []) @@ -85,7 +86,6 @@ abstract class TV extends Videos * * @param $videoID * @param $siteId - * * @return mixed */ abstract protected function getBanner($videoID, $siteId); @@ -93,19 +93,17 @@ abstract class TV extends Videos /** * Retrieve info of TV episode from site using its API. * - * @param int $siteId - * @param int $series - * @param int $episode - * - * @return array|false False on failure, an array of information fields otherwise. + * @param int $siteId + * @param int $series + * @param int $episode + * @return array|false False on failure, an array of information fields otherwise. */ abstract protected function getEpisodeInfo($siteId, $series, $episode); /** * Retrieve poster image for TV episode from site using its API. * - * @param int $videoId ID from videos table. - * + * @param int $videoId ID from videos table. * @return int */ abstract protected function getPoster($videoId): int; @@ -113,9 +111,8 @@ abstract class TV extends Videos /** * Retrieve info of TV programme from site using it's API. * - * @param string $name Title of programme to look up. Usually a cleaned up version from releases table. - * - * @return array|false False on failure, an array of information fields otherwise. + * @param string $name Title of programme to look up. Usually a cleaned up version from releases table. + * @return array|false False on failure, an array of information fields otherwise. */ abstract protected function getShowInfo($name); @@ -124,7 +121,6 @@ abstract class TV extends Videos * Returns the formatted array. * * @param $show - * * @return array */ abstract protected function formatShowInfo($show): array; @@ -134,7 +130,6 @@ abstract class TV extends Videos * Returns the formatted array. * * @param $episode - * * @return array */ abstract protected function formatEpisodeInfo($episode): array; @@ -143,10 +138,10 @@ abstract class TV extends Videos * Retrieve releases for TV processing. * * - * @param string $groupID - * @param string $guidChar - * @param int $lookupSetting - * @param int $status + * @param string $groupID + * @param string $guidChar + * @param int $lookupSetting + * @param int $status * @return \Illuminate\Database\Eloquent\Collection|int|static[] */ public function getTvReleases($groupID = '', $guidChar = '', $lookupSetting = 1, $status = 0) @@ -179,9 +174,9 @@ abstract class TV extends Videos /** * Updates the release when match for the current scraper is found. * - * @param $videoId - * @param $releaseId - * @param int $episodeId + * @param $videoId + * @param $releaseId + * @param int $episodeId */ public function setVideoIdFound($videoId, $releaseId, $episodeId): void { @@ -207,8 +202,7 @@ abstract class TV extends Videos * Inserts a new video ID into the database for TV shows * If a duplicate is found it is handle by calling update instead. * - * @param array $show - * + * @param array $show * @return int */ public function add(array $show = []): int @@ -272,7 +266,7 @@ abstract class TV extends Videos * Inserts a new TV episode into the tv_episodes table following a match to a Video ID. * * @param $videoId - * @param array $episode + * @param array $episode * @return false|int */ public function addEpisode($videoId, array $episode = []) @@ -300,8 +294,8 @@ abstract class TV extends Videos * Updates the show info with data from the supplied array * Only called when a duplicate show is found during insert. * - * @param int $videoId - * @param array $show + * @param int $videoId + * @param array $show */ public function update($videoId, array $show = []): void { @@ -344,8 +338,8 @@ abstract class TV extends Videos * * * @param $id - * * @return mixed + * * @throws \Throwable */ public function delete($id) @@ -404,11 +398,10 @@ abstract class TV extends Videos * * Returns the Episode ID or false if not found * - * @param $id - * @param $series - * @param $episode - * @param string $airdate - * + * @param $id + * @param $series + * @param $episode + * @param string $airdate * @return int|false */ public function getBySeasonEp($id, $series, $episode, $airdate = '') @@ -456,7 +449,6 @@ abstract class TV extends Videos * Returns an array of show data. * * @param $relname - * * @return array|false */ public function parseInfo($relname) @@ -497,8 +489,7 @@ abstract class TV extends Videos /** * Parses the release searchname and returns a show title. * - * @param string $relname - * + * @param string $relname * @return string */ private function parseName($relname) @@ -532,7 +523,6 @@ abstract class TV extends Videos * Parses the release searchname for the season/episode/airdate information. * * @param $relname - * * @return array */ private function parseSeasonEp($relname) @@ -622,8 +612,7 @@ abstract class TV extends Videos /** * Parses the cleaned release name to determine if it has a country appended. * - * @param string $showName - * + * @param string $showName * @return string */ private function parseCountry($showName): string @@ -655,7 +644,6 @@ abstract class TV extends Videos * Returns the cleaned string. * * @param $str - * * @return string */ public function cleanName($str): string @@ -688,7 +676,6 @@ abstract class TV extends Videos * @param $ourName * @param $scrapeName * @param $probability - * * @return int|float */ public function checkMatch($ourName, $scrapeName, $probability) @@ -710,8 +697,7 @@ abstract class TV extends Videos * This shouldn't ever happen as I've never heard of a date starting with year being followed by day value. * Could this be a mistake? i.e. trying to solve the mm-dd-yyyy/dd-mm-yyyy confusion into a yyyy-mm-dd? * - * @param string|bool|null $date - * + * @param string|bool|null $date * @return string */ public function checkDate($date): string @@ -734,8 +720,7 @@ abstract class TV extends Videos * Returns true or false. * * @param $array - * @param int $type - * + * @param int $type * @return bool */ public function checkRequiredAttr($array, $type): bool diff --git a/Blacklight/processing/tv/TVDB.php b/Blacklight/processing/tv/TVDB.php index 0e1a3e72c..edd0a5c40 100755 --- a/Blacklight/processing/tv/TVDB.php +++ b/Blacklight/processing/tv/TVDB.php @@ -43,7 +43,8 @@ class TVDB extends TV /** * TVDB constructor. * - * @param array $options + * @param array $options + * * @throws \Exception */ public function __construct(array $options = []) @@ -71,10 +72,10 @@ class TVDB extends TV * Main processing director function for scrapers * Calls work query function and initiates processing. * - * @param $groupID - * @param $guidChar - * @param $process - * @param bool $local + * @param $groupID + * @param $guidChar + * @param $process + * @param bool $local */ public function processSite($groupID, $guidChar, $process, $local = false): void { @@ -213,7 +214,6 @@ class TVDB extends TV * * @param $videoID * @param $siteId - * * @return bool */ protected function getBanner($videoID, $siteId): bool @@ -226,9 +226,8 @@ class TVDB extends TV * Returns a formatted array of show data or false if no match. * * - * @param string $cleanName - * @param string $country - * + * @param string $cleanName + * @param string $country * @return array|bool|false */ protected function getShowInfo($cleanName, $country = '') @@ -294,8 +293,7 @@ class TVDB extends TV /** * Retrieves the poster art for the processed show. * - * @param int $videoId -- the local Video ID - * + * @param int $videoId -- the local Video ID * @return int */ public function getPoster($videoId): int @@ -321,12 +319,11 @@ class TVDB extends TV * Gets the specific episode info for the parsed release after match * Returns a formatted array of episode data or false if no match. * - * @param int $tvDbId - * @param int $season - * @param int $episode - * @param string $airDate - * @param int $videoId - * + * @param int $tvDbId + * @param int $season + * @param int $episode + * @param string $airDate + * @param int $videoId * @return array|false */ protected function getEpisodeInfo($tvDbId, $season, $episode, $airDate = '', $videoId = 0) @@ -375,7 +372,6 @@ class TVDB extends TV * Returns the formatted array. * * @param $show - * * @return array */ protected function formatShowInfo($show): array @@ -426,7 +422,6 @@ class TVDB extends TV * Returns the formatted array. * * @param $episode - * * @return array */ protected function formatEpisodeInfo($episode): array diff --git a/Blacklight/processing/tv/TVMaze.php b/Blacklight/processing/tv/TVMaze.php index e8f83b6b2..ee0961bf2 100644 --- a/Blacklight/processing/tv/TVMaze.php +++ b/Blacklight/processing/tv/TVMaze.php @@ -29,7 +29,7 @@ class TVMaze extends TV /** * TVMaze constructor. * - * @param array $options + * @param array $options * * @throws \Exception */ @@ -44,7 +44,6 @@ class TVMaze extends TV * * @param $videoId * @param $siteID - * * @return bool */ public function getBanner($videoId, $siteID): bool @@ -56,10 +55,10 @@ class TVMaze extends TV * Main processing director function for scrapers * Calls work query function and initiates processing. * - * @param $groupID - * @param $guidChar - * @param $process - * @param bool $local + * @param $groupID + * @param $guidChar + * @param $process + * @param bool $local */ public function processSite($groupID, $guidChar, $process, $local = false): void { @@ -201,7 +200,6 @@ class TVMaze extends TV * * @param $site * @param $siteId - * * @return array|false */ protected function getShowInfoBySiteID($site, $siteId) @@ -225,8 +223,7 @@ class TVMaze extends TV * Returns a formatted array of show data or false if no match. * * - * @param string $cleanName - * + * @param string $cleanName * @return array|false */ protected function getShowInfo($cleanName) @@ -263,7 +260,6 @@ class TVMaze extends TV /** * @param $shows * @param $cleanName - * * @return array|false */ private function matchShowInfo(array $shows, $cleanName) @@ -310,8 +306,7 @@ class TVMaze extends TV /** * Retrieves the poster art for the processed show. * - * @param int $videoId -- the local Video ID - * + * @param int $videoId -- the local Video ID * @return int */ public function getPoster($videoId): int @@ -337,12 +332,11 @@ class TVMaze extends TV * Gets the specific episode info for the parsed release after match * Returns a formatted array of episode data or false if no match. * - * @param int $tvMazeId - * @param int $season - * @param int $episode - * @param string $airDate - * @param int $videoId - * + * @param int $tvMazeId + * @param int $season + * @param int $episode + * @param string $airDate + * @param int $videoId * @return array|false */ protected function getEpisodeInfo($tvMazeId, $season, $episode, $airDate = '', $videoId = 0) @@ -387,7 +381,6 @@ class TVMaze extends TV * Returns the formatted array. * * @param $show - * * @return array */ protected function formatShowInfo($show): array @@ -418,7 +411,6 @@ class TVMaze extends TV * Returns the formatted array. * * @param $episode - * * @return array */ protected function formatEpisodeInfo($episode): array diff --git a/Blacklight/processing/tv/TraktTv.php b/Blacklight/processing/tv/TraktTv.php index 0acd8b38e..0aa70fdb5 100755 --- a/Blacklight/processing/tv/TraktTv.php +++ b/Blacklight/processing/tv/TraktTv.php @@ -47,7 +47,8 @@ class TraktTv extends TV /** * Construct. Set up API key. * - * @param array $options Class instances. + * @param array $options Class instances. + * * @throws \Exception */ public function __construct(array $options = []) @@ -67,10 +68,10 @@ class TraktTv extends TV * Main processing director function for scrapers * Calls work query function and initiates processing. * - * @param $groupID - * @param $guidChar - * @param $process - * @param bool $local + * @param $groupID + * @param $guidChar + * @param $process + * @param bool $local */ public function processSite($groupID, $guidChar, $process, $local = false): void { @@ -196,7 +197,6 @@ class TraktTv extends TV * * @param $videoId * @param $siteID - * * @return bool */ public function getBanner($videoId, $siteID): bool @@ -207,10 +207,9 @@ class TraktTv extends TV /** * Retrieve info of TV episode from site using its API. * - * @param int $siteId - * @param int $series - * @param int $episode - * + * @param int $siteId + * @param int $series + * @param int $episode * @return array|false False on failure, an array of information fields otherwise. */ public function getEpisodeInfo($siteId, $series, $episode) @@ -237,8 +236,7 @@ class TraktTv extends TV /** * Retrieve poster image for TV episode from site using its API. * - * @param int $videoId ID from videos table. - * + * @param int $videoId ID from videos table. * @return int */ public function getPoster($videoId): int @@ -267,9 +265,8 @@ class TraktTv extends TV /** * Retrieve info of TV programme from site using it's API. * - * @param string|null|array $name Title of programme to look up. Usually a cleaned up version from releases table. - * - * @return array|false False on failure, an array of information fields otherwise. + * @param string|null|array $name Title of programme to look up. Usually a cleaned up version from releases table. + * @return array|false False on failure, an array of information fields otherwise. */ public function getShowInfo($name) { @@ -321,7 +318,6 @@ class TraktTv extends TV * Returns the formatted array. * * @param $show - * * @return array */ public function formatShowInfo($show): array @@ -355,7 +351,6 @@ class TraktTv extends TV * Returns the formatted array. * * @param $episode - * * @return array */ public function formatEpisodeInfo($episode): array diff --git a/Blacklight/utility/Country.php b/Blacklight/utility/Country.php index af3f42666..b750c7a31 100755 --- a/Blacklight/utility/Country.php +++ b/Blacklight/utility/Country.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author ruhllatio * @copyright 2015 nZEDb */ @@ -31,9 +32,7 @@ class Country /** * Get a country code for a country name. * - * @param string $country - * - * + * @param string $country * @return mixed */ public static function countryCode($country) diff --git a/Blacklight/utility/Git.php b/Blacklight/utility/Git.php index 4910a25a9..2dc576b1a 100755 --- a/Blacklight/utility/Git.php +++ b/Blacklight/utility/Git.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author niel * @copyright 2014 nZEDb */ @@ -41,7 +42,8 @@ class Git extends GitRepository /** * Git constructor. * - * @param array $options + * @param array $options + * * @throws \Cz\Git\GitException */ public function __construct(array $options = []) @@ -76,8 +78,9 @@ class Git extends GitRepository } /** - * @param null $options + * @param null $options * @return \Cz\Git\GitRepository + * * @throws \Cz\Git\GitException */ public function describe($options = null): GitRepository @@ -95,7 +98,6 @@ class Git extends GitRepository /** * @param $gitObject - * * @return false|bool */ public function isCommited($gitObject): bool @@ -117,8 +119,9 @@ class Git extends GitRepository } /** - * @param null $options + * @param null $options * @return \Cz\Git\GitRepository + * * @throws \Cz\Git\GitException */ public function log($options = null): GitRepository @@ -135,8 +138,9 @@ class Git extends GitRepository } /** - * @param null $options + * @param null $options * @return \Cz\Git\GitRepository + * * @throws \Cz\Git\GitException */ public function tag($options = null): GitRepository @@ -146,6 +150,7 @@ class Git extends GitRepository /** * @return \Cz\Git\GitRepository + * * @throws \Cz\Git\GitException */ public function tagLatest(): GitRepository diff --git a/Blacklight/utility/Time.php b/Blacklight/utility/Time.php index 7ce19b5c0..e1fad7ef1 100755 --- a/Blacklight/utility/Time.php +++ b/Blacklight/utility/Time.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author ruhllatio * @copyright 2015 nZEDb */ @@ -32,9 +33,8 @@ class Time * For a given timestamp, calculate the localized show/episode airdate * via the provided local airing timezone. * - * @param string $time - * @param string $zone - * + * @param string $time + * @param string $zone * @return string */ public static function localizeAirdate($time = '', $zone = ''): string diff --git a/Blacklight/utility/Utility.php b/Blacklight/utility/Utility.php index 69e02e822..9c95f5fca 100755 --- a/Blacklight/utility/Utility.php +++ b/Blacklight/utility/Utility.php @@ -24,8 +24,8 @@ class Utility * Checks all levels of the supplied path are readable and executable by current user. * * @todo Make this recursive with a switch to only check end point. - * @param $path *nix path to directory or file * + * @param $path *nix path to directory or file * @return bool|string True is successful, otherwise the part of the path that failed testing. */ public static function canExecuteRead($path) @@ -56,13 +56,12 @@ class Utility * relative to the last occurrence of the specified character. * The character selected may be retained or discarded. * - * @param string $character the character to search for. - * @param string $string the string to search through. - * @param string $side determines whether text to the left or the right of the character is returned. - * Options are: left, or right. - * @param bool $keep_character determines whether or not to keep the character. - * Options are: true, or false. - * + * @param string $character the character to search for. + * @param string $string the string to search through. + * @param string $side determines whether text to the left or the right of the character is returned. + * Options are: left, or right. + * @param bool $keep_character determines whether or not to keep the character. + * Options are: true, or false. * @return string */ public static function cutStringUsingLast($character, $string, $side, $keep_character = true): string @@ -88,8 +87,7 @@ class Utility } /** - * @param array|null $options - * + * @param array|null $options * @return array|null */ public static function getDirFiles(array $options = null): ?array @@ -158,7 +156,6 @@ class Utility * * * @param $cmd - * * @return bool */ public static function hasCommand($cmd): bool @@ -180,7 +177,6 @@ class Utility /** * @param $filename - * * @return bool|null|string */ public static function isGZipped($filename) @@ -205,9 +201,8 @@ class Utility * Operates directly on the text string, but also returns the result for situations requiring a * return value (use in ternary, etc.)/ * - * @param string $text String variable to strip. - * - * @return string The stripped variable. + * @param string $text String variable to strip. + * @return string The stripped variable. */ public static function stripNonPrintingChars(&$text): string { @@ -219,8 +214,7 @@ class Utility /** * Unzip a gzip file, return the output. Return false on error / empty. * - * @param string $filePath - * + * @param string $filePath * @return bool|string */ public static function unzipGzipFile($filePath) @@ -268,8 +262,7 @@ class Utility * Creates an array to be used with stream_context_create() to verify openssl certificates * when connecting to a tls or ssl connection when using stream functions (fopen/file_get_contents/etc). * - * @param bool $forceIgnore Force ignoring of verification. - * + * @param bool $forceIgnore Force ignoring of verification. * @return array * @static */ @@ -303,10 +296,9 @@ class Utility /** * Set curl context options for verifying SSL certificates. * - * @param bool $verify false = Ignore config.php and do not verify the openssl cert. - * true = Check config.php and verify based on those settings. - * If you know the certificate will be self-signed, pass false. - * + * @param bool $verify false = Ignore config.php and do not verify the openssl cert. + * true = Check config.php and verify based on those settings. + * If you know the certificate will be self-signed, pass false. * @return array * @static */ @@ -335,8 +327,7 @@ class Utility } /** - * @param array $options - * + * @param array $options * @return string */ public static function getCoverURL(array $options = []): string @@ -366,12 +357,12 @@ class Utility /** * Converts XML to an associative array with namespace preservation -- use if intending to JSON encode. + * * @author Tamlyn from Outlandish.com * - * @param \SimpleXMLElement $xml The SimpleXML parsed XML string data - * @param array $options - * - * @return array The associate array of the XML namespaced file + * @param \SimpleXMLElement $xml The SimpleXML parsed XML string data + * @param array $options + * @return array The associate array of the XML namespaced file */ public static function xmlToArray(\SimpleXMLElement $xml, array $options = []): array { @@ -460,9 +451,9 @@ class Utility * Return file type/info using magic numbers. * Try using `file` program where available, fallback to using PHP's finfo class. * - * @param string $path Path to the file / folder to check. - * + * @param string $path Path to the file / folder to check. * @return string File info. Empty string on failure. + * * @throws \Exception */ public static function fileInfo($path): string @@ -486,7 +477,6 @@ class Utility /** * @param $code - * * @return bool */ public function checkStatus($code): bool @@ -497,8 +487,7 @@ class Utility /** * Convert Code page 437 chars to UTF. * - * @param string $string - * + * @param string $string * @return string */ public static function cp437toUTF($string): string @@ -510,7 +499,6 @@ class Utility * Fetches an embeddable video to a IMDB trailer from http://www.traileraddict.com. * * @param $imdbID - * * @return string */ public static function imdb_trailers($imdbID): string @@ -526,9 +514,8 @@ class Utility /** * Convert obj to array. * - * @param $arrObjData - * @param array $arrSkipIndices - * + * @param $arrObjData + * @param array $arrSkipIndices * @return array */ public static function objectsIntoArray($arrObjData, array $arrSkipIndices = []): array @@ -559,8 +546,7 @@ class Utility /** * Remove unsafe chars from a filename. * - * @param string $filename - * + * @param string $filename * @return string */ public static function safeFilename($filename): string @@ -570,7 +556,6 @@ class Utility /** * @param $input - * * @return \SimpleXMLElement */ public static function responseXmlToObject($input): \SimpleXMLElement @@ -582,8 +567,9 @@ class Utility /** * Display error/error code. - * @param int $errorCode - * @param string $errorText + * + * @param int $errorCode + * @param string $errorText */ public static function showApiError($errorCode = 900, $errorText = ''): void { @@ -676,7 +662,6 @@ class Utility * Simple function to reduce duplication in html string formatting. * * @param $string - * * @return string */ public static function htmlfmt($string): string @@ -686,7 +671,6 @@ class Utility /** * @param $tableName - * * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator */ public static function getRange($tableName): LengthAwarePaginator @@ -701,7 +685,6 @@ class Utility /** * @param $tableName - * * @return int */ public static function getCount($tableName): int diff --git a/app/Console/Commands/InstallNntmux.php b/app/Console/Commands/InstallNntmux.php index 0b9e18aa2..150c92a98 100644 --- a/app/Console/Commands/InstallNntmux.php +++ b/app/Console/Commands/InstallNntmux.php @@ -101,6 +101,7 @@ class InstallNntmux extends Command /** * @return array|bool + * * @throws \Exception * @throws \RuntimeException */ diff --git a/app/Console/Commands/NntmuxRemoveBadReleases.php b/app/Console/Commands/NntmuxRemoveBadReleases.php index a78e46588..b9de2d14c 100644 --- a/app/Console/Commands/NntmuxRemoveBadReleases.php +++ b/app/Console/Commands/NntmuxRemoveBadReleases.php @@ -36,6 +36,7 @@ class NntmuxRemoveBadReleases extends Command * Execute the console command. * * @return mixed + * * @throws \Exception */ public function handle() diff --git a/app/Console/Commands/UpdateNNTmuxComposer.php b/app/Console/Commands/UpdateNNTmuxComposer.php index c6288649f..fd0cfb3f5 100644 --- a/app/Console/Commands/UpdateNNTmuxComposer.php +++ b/app/Console/Commands/UpdateNNTmuxComposer.php @@ -52,6 +52,7 @@ class UpdateNNTmuxComposer extends Command * option is added to the command to prevent development packages being also downloaded. * * @return string + * * @throws \Cz\Git\GitException */ protected function composer() diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php index 20a0f4836..da40261e1 100644 --- a/app/Exceptions/Handler.php +++ b/app/Exceptions/Handler.php @@ -30,9 +30,9 @@ class Handler extends ExceptionHandler * Report or log an exception. * * - * @param \Exception $exception - * + * @param \Exception $exception * @return void + * * @throws \Throwable */ public function report(\Throwable $exception) @@ -41,9 +41,10 @@ class Handler extends ExceptionHandler } /** - * @param \Illuminate\Http\Request $request - * @param \Throwable $exception + * @param \Illuminate\Http\Request $request + * @param \Throwable $exception * @return \Illuminate\Http\RedirectResponse|\Symfony\Component\HttpFoundation\Response + * * @throws \Throwable */ public function render($request, \Throwable $exception) diff --git a/app/Extensions/helper/helpers.php b/app/Extensions/helper/helpers.php index 7256171af..4797e8c04 100644 --- a/app/Extensions/helper/helpers.php +++ b/app/Extensions/helper/helpers.php @@ -17,9 +17,8 @@ use Symfony\Component\Process\Process; if (! function_exists('getRawHtml')) { /** - * @param $url - * @param bool $cookie - * + * @param $url + * @param bool $cookie * @return bool|mixed|string */ function getRawHtml($url, $cookie = false) @@ -58,8 +57,8 @@ if (! function_exists('makeFieldLinks')) { * @param $data * @param $field * @param $type - * * @return string + * * @throws \Exception */ function makeFieldLinks($data, $field, $type) @@ -88,8 +87,7 @@ if (! function_exists('makeFieldLinks')) { if (! function_exists('getUserBrowseOrder')) { /** - * @param string $orderBy - * + * @param string $orderBy * @return array */ function getUserBrowseOrder($orderBy): array @@ -171,6 +169,7 @@ if (! function_exists('getUserBrowseOrdering')) { if (! function_exists('createGUID')) { /** * @return string + * * @throws \Exception */ function createGUID(): string @@ -185,8 +184,7 @@ if (! function_exists('createGUID')) { if (! function_exists('getSimilarName')) { /** - * @param string $name - * + * @param string $name * @return string */ function getSimilarName($name): string @@ -197,8 +195,7 @@ if (! function_exists('getSimilarName')) { if (! function_exists('color')) { /** - * @param string $string - * + * @param string $string * @return \Colors\Color */ function color($string = ''): Color @@ -210,9 +207,8 @@ if (! function_exists('color')) { if (! function_exists('human_filesize')) { /** - * @param $bytes - * @param int $decimals - * + * @param $bytes + * @param int $decimals * @return string */ function human_filesize($bytes, $decimals = 0): string @@ -228,7 +224,6 @@ if (! function_exists('bcdechex')) { /** * @param $dec - * * @return string */ function bcdechex($dec) @@ -249,9 +244,8 @@ if (! function_exists('runCmd')) { * Run CLI command. * * - * @param string $command - * @param bool $debug - * + * @param string $command + * @param bool $debug * @return string */ function runCmd($command, $debug = false) @@ -277,7 +271,6 @@ if (! function_exists('escapeString')) { /** * @param $string - * * @return string */ function escapeString($string) @@ -290,7 +283,6 @@ if (! function_exists('realDuration')) { /** * @param $milliseconds - * * @return string */ function realDuration($milliseconds) @@ -304,7 +296,7 @@ if (! function_exists('realDuration')) { if (! function_exists('is_it_json')) { /** - * @param array|string $isIt + * @param array|string $isIt * @return bool */ function is_it_json($isIt) @@ -321,9 +313,9 @@ if (! function_exists('is_it_json')) { if (! function_exists('getZipped')) { /** - * @param array $guids - * + * @param array $guids * @return string + * * @throws \Exception */ function getZipped(array $guids = []): string @@ -359,9 +351,8 @@ if (! function_exists('getZipped')) { if (! function_exists('release_flag')) { // Function inspired by c0r3@newznabforums adds country flags on the browse page. /** - * @param string $text Text to match against. - * @param string $page Type of page. browse or search. - * + * @param string $text Text to match against. + * @param string $page Type of page. browse or search. * @return bool|string */ function release_flag($text, $page) diff --git a/app/Extensions/util/Git.php b/app/Extensions/util/Git.php index 29e8164ac..30f47d566 100644 --- a/app/Extensions/util/Git.php +++ b/app/Extensions/util/Git.php @@ -13,6 +13,7 @@ * not, see:. * * @link . + * * @author niel * @copyright 2016 nZEDb */ @@ -47,7 +48,8 @@ class Git /** * Git constructor. * - * @param array $config + * @param array $config + * * @throws \CzProject\GitPhp\GitException */ public function __construct(array $config = []) @@ -76,8 +78,8 @@ class Git /** * @param $options - * * @return string[] + * * @throws \CzProject\GitPhp\GitException */ public function describe($options) @@ -123,6 +125,7 @@ class Git /** * @return \CzProject\GitPhp\CommitId + * * @throws \CzProject\GitPhp\GitException */ public function getHeadHash() @@ -134,8 +137,8 @@ class Git * Determine if the supplied object is commited to the repository or not. * * @param $gitObject - * * @return bool + * * @throws \Exception */ public function isCommited($gitObject) @@ -161,7 +164,6 @@ class Git /** * @param $branch - * * @return bool */ public function isStable($branch) @@ -180,9 +182,9 @@ class Git /** * Run the log command. * - * @param null $options - * + * @param null $options * @return string + * * @throws \Symfony\Component\Process\Exception\LogicException * @throws \Symfony\Component\Process\Exception\RuntimeException */ @@ -195,9 +197,9 @@ class Git } /** - * @param array $options - * + * @param array $options * @return string[] + * * @throws \CzProject\GitPhp\GitException */ public function gitPull(array $options = []) @@ -216,9 +218,9 @@ class Git * Accepts a git command to run. * * - * @param string $command Command to run - * + * @param string $command Command to run * @return string|string[] + * * @throws \CzProject\GitPhp\GitException */ public function gitRun($command) @@ -229,9 +231,9 @@ class Git /** * Run the tag command. * - * @param string $options - * + * @param string $options * @return string + * * @throws \Symfony\Component\Process\Exception\RuntimeException * @throws \Symfony\Component\Process\Exception\LogicException */ @@ -244,9 +246,9 @@ class Git } /** - * @param bool $cached - * + * @param bool $cached * @return string + * * @throws \CzProject\GitPhp\GitException */ public function tagLatest($cached = true) diff --git a/app/Extensions/util/PhpYenc.php b/app/Extensions/util/PhpYenc.php index ca2f4496b..c3a137354 100644 --- a/app/Extensions/util/PhpYenc.php +++ b/app/Extensions/util/PhpYenc.php @@ -13,6 +13,7 @@ * not, see:. * * @link . + * * @author niel * @copyright 2016 nZEDb */ @@ -25,9 +26,8 @@ namespace App\Extensions\util; class PhpYenc { /** - * @param $text - * @param bool $ignore - * + * @param $text + * @param bool $ignore * @return bool|string */ public static function decode(&$text, $ignore = false) @@ -88,8 +88,7 @@ class PhpYenc /** * Decode a string of text encoded with yEnc. Ignores all errors. * - * @param string $text The encoded text to decode. - * + * @param string $text The encoded text to decode. * @return string The decoded yEnc string, or the input string, if it's not yEnc. */ public static function decodeIgnore(&$text): string @@ -137,11 +136,10 @@ class PhpYenc } /** - * @param $data - * @param $filename - * @param int $lineLength - * @param bool $crc32 - * + * @param $data + * @param $filename + * @param int $lineLength + * @param bool $crc32 * @return string */ public static function encode($data, $filename, $lineLength = 128, $crc32 = true): string diff --git a/app/Http/Controllers/Admin/AdminAjaxController.php b/app/Http/Controllers/Admin/AdminAjaxController.php index f322a6097..887101e26 100644 --- a/app/Http/Controllers/Admin/AdminAjaxController.php +++ b/app/Http/Controllers/Admin/AdminAjaxController.php @@ -14,7 +14,7 @@ use Illuminate\Http\Request; class AdminAjaxController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Throwable */ diff --git a/app/Http/Controllers/Admin/AdminAnidbController.php b/app/Http/Controllers/Admin/AdminAnidbController.php index 19624e950..db7ceb28e 100644 --- a/app/Http/Controllers/Admin/AdminAnidbController.php +++ b/app/Http/Controllers/Admin/AdminAnidbController.php @@ -37,8 +37,8 @@ class AdminAnidbController extends BasePageController /** * @param $id - * * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit($id) @@ -94,7 +94,7 @@ class AdminAnidbController extends BasePageController /** * Remove the specified resource from storage. * - * @param int $id + * @param int $id * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminBlacklistController.php b/app/Http/Controllers/Admin/AdminBlacklistController.php index 9d33eed26..6499c2b33 100644 --- a/app/Http/Controllers/Admin/AdminBlacklistController.php +++ b/app/Http/Controllers/Admin/AdminBlacklistController.php @@ -28,9 +28,9 @@ class AdminBlacklistController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) diff --git a/app/Http/Controllers/Admin/AdminBookController.php b/app/Http/Controllers/Admin/AdminBookController.php index 0963e1727..c208dde75 100644 --- a/app/Http/Controllers/Admin/AdminBookController.php +++ b/app/Http/Controllers/Admin/AdminBookController.php @@ -31,9 +31,9 @@ class AdminBookController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) diff --git a/app/Http/Controllers/Admin/AdminCategoryController.php b/app/Http/Controllers/Admin/AdminCategoryController.php index c1dc5f715..b99c879fa 100644 --- a/app/Http/Controllers/Admin/AdminCategoryController.php +++ b/app/Http/Controllers/Admin/AdminCategoryController.php @@ -27,9 +27,9 @@ class AdminCategoryController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) diff --git a/app/Http/Controllers/Admin/AdminCategoryRegexesController.php b/app/Http/Controllers/Admin/AdminCategoryRegexesController.php index 1ac44fb67..939c9e448 100644 --- a/app/Http/Controllers/Admin/AdminCategoryRegexesController.php +++ b/app/Http/Controllers/Admin/AdminCategoryRegexesController.php @@ -10,7 +10,7 @@ use Illuminate\Http\Request; class AdminCategoryRegexesController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -39,7 +39,7 @@ class AdminCategoryRegexesController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminCollectionRegexesController.php b/app/Http/Controllers/Admin/AdminCollectionRegexesController.php index b4d1ecb87..74e01dc09 100644 --- a/app/Http/Controllers/Admin/AdminCollectionRegexesController.php +++ b/app/Http/Controllers/Admin/AdminCollectionRegexesController.php @@ -10,7 +10,7 @@ use Illuminate\Http\Request; class AdminCollectionRegexesController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -33,9 +33,9 @@ class AdminCollectionRegexesController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) @@ -100,7 +100,7 @@ class AdminCollectionRegexesController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminConsoleController.php b/app/Http/Controllers/Admin/AdminConsoleController.php index edaf857ec..a460405b6 100644 --- a/app/Http/Controllers/Admin/AdminConsoleController.php +++ b/app/Http/Controllers/Admin/AdminConsoleController.php @@ -31,9 +31,9 @@ class AdminConsoleController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) diff --git a/app/Http/Controllers/Admin/AdminContentController.php b/app/Http/Controllers/Admin/AdminContentController.php index 1b2c284b5..a13a7fbf9 100644 --- a/app/Http/Controllers/Admin/AdminContentController.php +++ b/app/Http/Controllers/Admin/AdminContentController.php @@ -28,8 +28,9 @@ class AdminContentController extends BasePageController } /** - * @param Request $request + * @param Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function create(Request $request) @@ -109,8 +110,7 @@ class AdminContentController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector */ public function destroy(Request $request) diff --git a/app/Http/Controllers/Admin/AdminGameController.php b/app/Http/Controllers/Admin/AdminGameController.php index ec7acd607..a0d3b30f4 100644 --- a/app/Http/Controllers/Admin/AdminGameController.php +++ b/app/Http/Controllers/Admin/AdminGameController.php @@ -32,9 +32,9 @@ class AdminGameController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) diff --git a/app/Http/Controllers/Admin/AdminGroupController.php b/app/Http/Controllers/Admin/AdminGroupController.php index cd894ebc5..7f88196f8 100644 --- a/app/Http/Controllers/Admin/AdminGroupController.php +++ b/app/Http/Controllers/Admin/AdminGroupController.php @@ -9,7 +9,7 @@ use Illuminate\Http\Request; class AdminGroupController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -35,7 +35,7 @@ class AdminGroupController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -67,9 +67,9 @@ class AdminGroupController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) @@ -134,7 +134,7 @@ class AdminGroupController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -164,7 +164,7 @@ class AdminGroupController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminMovieController.php b/app/Http/Controllers/Admin/AdminMovieController.php index 60d0b80b8..e3baa6aa3 100644 --- a/app/Http/Controllers/Admin/AdminMovieController.php +++ b/app/Http/Controllers/Admin/AdminMovieController.php @@ -31,9 +31,9 @@ class AdminMovieController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function create(Request $request) @@ -79,9 +79,9 @@ class AdminMovieController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) diff --git a/app/Http/Controllers/Admin/AdminMusicController.php b/app/Http/Controllers/Admin/AdminMusicController.php index 7d82be87a..3bf2e0284 100644 --- a/app/Http/Controllers/Admin/AdminMusicController.php +++ b/app/Http/Controllers/Admin/AdminMusicController.php @@ -29,9 +29,9 @@ class AdminMusicController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) diff --git a/app/Http/Controllers/Admin/AdminNzbController.php b/app/Http/Controllers/Admin/AdminNzbController.php index cbc6b6a3b..6f85c8cb3 100644 --- a/app/Http/Controllers/Admin/AdminNzbController.php +++ b/app/Http/Controllers/Admin/AdminNzbController.php @@ -12,7 +12,7 @@ use Illuminate\Http\Request; class AdminNzbController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -70,7 +70,7 @@ class AdminNzbController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminPredbController.php b/app/Http/Controllers/Admin/AdminPredbController.php index b2127da10..84b29990d 100644 --- a/app/Http/Controllers/Admin/AdminPredbController.php +++ b/app/Http/Controllers/Admin/AdminPredbController.php @@ -9,7 +9,7 @@ use Illuminate\Http\Request; class AdminPredbController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminReleaseNamingRegexesController.php b/app/Http/Controllers/Admin/AdminReleaseNamingRegexesController.php index 81386c8e5..8f40c7a1c 100644 --- a/app/Http/Controllers/Admin/AdminReleaseNamingRegexesController.php +++ b/app/Http/Controllers/Admin/AdminReleaseNamingRegexesController.php @@ -10,7 +10,7 @@ use Illuminate\Http\Request; class AdminReleaseNamingRegexesController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -34,9 +34,9 @@ class AdminReleaseNamingRegexesController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) @@ -102,7 +102,7 @@ class AdminReleaseNamingRegexesController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminReleasesController.php b/app/Http/Controllers/Admin/AdminReleasesController.php index 164c8ef3d..a438bf87d 100644 --- a/app/Http/Controllers/Admin/AdminReleasesController.php +++ b/app/Http/Controllers/Admin/AdminReleasesController.php @@ -30,9 +30,9 @@ class AdminReleasesController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) @@ -91,6 +91,7 @@ class AdminReleasesController extends BasePageController /** * @param $id * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function destroy($id) diff --git a/app/Http/Controllers/Admin/AdminRoleController.php b/app/Http/Controllers/Admin/AdminRoleController.php index 6e2085e3a..32df8269e 100644 --- a/app/Http/Controllers/Admin/AdminRoleController.php +++ b/app/Http/Controllers/Admin/AdminRoleController.php @@ -30,7 +30,7 @@ class AdminRoleController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -115,7 +115,7 @@ class AdminRoleController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -238,8 +238,7 @@ class AdminRoleController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector */ public function destroy(Request $request) diff --git a/app/Http/Controllers/Admin/AdminSharingController.php b/app/Http/Controllers/Admin/AdminSharingController.php index 417a270e9..f83083ade 100644 --- a/app/Http/Controllers/Admin/AdminSharingController.php +++ b/app/Http/Controllers/Admin/AdminSharingController.php @@ -10,7 +10,7 @@ use Illuminate\Http\Request; class AdminSharingController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminShowsController.php b/app/Http/Controllers/Admin/AdminShowsController.php index 47e35c667..471c6b28c 100644 --- a/app/Http/Controllers/Admin/AdminShowsController.php +++ b/app/Http/Controllers/Admin/AdminShowsController.php @@ -10,7 +10,8 @@ use Illuminate\Http\Request; class AdminShowsController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request + * * @throws \Exception */ public function index(Request $request) @@ -34,7 +35,8 @@ class AdminShowsController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request + * * @throws \Exception */ public function edit(Request $request) diff --git a/app/Http/Controllers/Admin/AdminSiteController.php b/app/Http/Controllers/Admin/AdminSiteController.php index a1d155a04..df2533f78 100644 --- a/app/Http/Controllers/Admin/AdminSiteController.php +++ b/app/Http/Controllers/Admin/AdminSiteController.php @@ -15,7 +15,7 @@ use Spatie\Permission\Models\Role; class AdminSiteController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminTmuxController.php b/app/Http/Controllers/Admin/AdminTmuxController.php index 27abc393c..5b0d4f05d 100644 --- a/app/Http/Controllers/Admin/AdminTmuxController.php +++ b/app/Http/Controllers/Admin/AdminTmuxController.php @@ -9,7 +9,7 @@ use Illuminate\Http\Request; class AdminTmuxController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Admin/AdminUserController.php b/app/Http/Controllers/Admin/AdminUserController.php index 306e0389a..0fb5c031e 100644 --- a/app/Http/Controllers/Admin/AdminUserController.php +++ b/app/Http/Controllers/Admin/AdminUserController.php @@ -13,7 +13,7 @@ use Spatie\Permission\Models\Role; class AdminUserController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Throwable */ @@ -77,8 +77,9 @@ class AdminUserController extends BasePageController } /** - * @param Request $request + * @param Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function edit(Request $request) @@ -214,9 +215,9 @@ class AdminUserController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function destroy(Request $request) @@ -237,8 +238,9 @@ class AdminUserController extends BasePageController } /** - * @param Request $request + * @param Request $request * @return \Illuminate\Http\RedirectResponse + * * @throws \Jrean\UserVerification\Exceptions\ModelNotCompliantException */ public function resendVerification(Request $request) diff --git a/app/Http/Controllers/AdultController.php b/app/Http/Controllers/AdultController.php index bab1d67c3..26a1b2d89 100644 --- a/app/Http/Controllers/AdultController.php +++ b/app/Http/Controllers/AdultController.php @@ -10,8 +10,8 @@ use Illuminate\Support\Arr; class AdultController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * @param string $id + * @param \Illuminate\Http\Request $request + * @param string $id * * @throws \Exception */ diff --git a/app/Http/Controllers/AjaxController.php b/app/Http/Controllers/AjaxController.php index 9d6e50ec7..ccc71f614 100644 --- a/app/Http/Controllers/AjaxController.php +++ b/app/Http/Controllers/AjaxController.php @@ -8,7 +8,8 @@ use Illuminate\Http\Request; class AjaxController extends BasePageController { /** - * @param Request $request + * @param Request $request + * * @throws \Exception */ public function profile(Request $request) diff --git a/app/Http/Controllers/AnimeController.php b/app/Http/Controllers/AnimeController.php index 630ae6c42..b54841631 100644 --- a/app/Http/Controllers/AnimeController.php +++ b/app/Http/Controllers/AnimeController.php @@ -32,7 +32,7 @@ class AnimeController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -83,7 +83,7 @@ class AnimeController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Api/ApiController.php b/app/Http/Controllers/Api/ApiController.php index 82989757b..311f9b75b 100644 --- a/app/Http/Controllers/Api/ApiController.php +++ b/app/Http/Controllers/Api/ApiController.php @@ -18,8 +18,9 @@ use Illuminate\Support\Carbon; class ApiController extends BasePageController { /** - * @param Request $request + * @param Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|\Symfony\Component\HttpFoundation\StreamedResponse + * * @throws \Throwable */ public function api(Request $request) diff --git a/app/Http/Controllers/Api/ApiInformController.php b/app/Http/Controllers/Api/ApiInformController.php index 8a2d2680d..317c40653 100644 --- a/app/Http/Controllers/Api/ApiInformController.php +++ b/app/Http/Controllers/Api/ApiInformController.php @@ -14,8 +14,9 @@ class ApiInformController extends Controller /** * http://sitename/api/inform/release?api_token=xxxxx&relo=xxx&relp=xxx. * - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\JsonResponse + * * @throws \Exception */ public function release(Request $request) diff --git a/app/Http/Controllers/Api/ApiV2Controller.php b/app/Http/Controllers/Api/ApiV2Controller.php index 8c41a889a..70f12d79c 100644 --- a/app/Http/Controllers/Api/ApiV2Controller.php +++ b/app/Http/Controllers/Api/ApiV2Controller.php @@ -56,8 +56,9 @@ class ApiV2Controller extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\JsonResponse + * * @throws \Exception */ public function movie(Request $request): \Illuminate\Http\JsonResponse @@ -110,9 +111,9 @@ class ApiV2Controller extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\JsonResponse + * * @throws \Exception * @throws \Throwable */ @@ -179,9 +180,9 @@ class ApiV2Controller extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\JsonResponse + * * @throws \Exception * @throws \Throwable */ @@ -261,8 +262,7 @@ class ApiV2Controller extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector */ public function getNzb(Request $request) @@ -279,8 +279,7 @@ class ApiV2Controller extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\JsonResponse */ public function details(Request $request): \Illuminate\Http\JsonResponse diff --git a/app/Http/Controllers/Auth/ForgotPasswordController.php b/app/Http/Controllers/Auth/ForgotPasswordController.php index 5e01ca6c8..fcce26fa0 100644 --- a/app/Http/Controllers/Auth/ForgotPasswordController.php +++ b/app/Http/Controllers/Auth/ForgotPasswordController.php @@ -36,7 +36,7 @@ class ForgotPasswordController extends Controller } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/Auth/LoginController.php b/app/Http/Controllers/Auth/LoginController.php index aca183b89..bc833592d 100644 --- a/app/Http/Controllers/Auth/LoginController.php +++ b/app/Http/Controllers/Auth/LoginController.php @@ -49,8 +49,9 @@ class LoginController extends Controller } /** - * @param Request $request + * @param Request $request * @return \Illuminate\Http\RedirectResponse|void + * * @throws \Illuminate\Validation\ValidationException */ public function login(Request $request) @@ -133,8 +134,7 @@ class LoginController extends Controller } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector */ public function logout(Request $request) diff --git a/app/Http/Controllers/Auth/RegisterController.php b/app/Http/Controllers/Auth/RegisterController.php index b24d0cc19..54fd48dd8 100644 --- a/app/Http/Controllers/Auth/RegisterController.php +++ b/app/Http/Controllers/Auth/RegisterController.php @@ -60,7 +60,7 @@ class RegisterController extends Controller } /** - * @param array $data + * @param array $data * @return \App\Models\User */ protected function create(array $data): User @@ -118,9 +118,9 @@ class RegisterController extends Controller } /** - * @param Request $request - * + * @param Request $request * @return RedirectResponse|Redirector|void + * * @throws ValidationException */ public function register(Request $request) @@ -211,9 +211,9 @@ class RegisterController extends Controller } /** - * @param Request $request - * @param string $error - * @param int $showRegister + * @param Request $request + * @param string $error + * @param int $showRegister */ public function showRegistrationForm(Request $request, $error = '', $showRegister = 0) { diff --git a/app/Http/Controllers/Auth/ResetPasswordController.php b/app/Http/Controllers/Auth/ResetPasswordController.php index a7960b69b..cc3584972 100644 --- a/app/Http/Controllers/Auth/ResetPasswordController.php +++ b/app/Http/Controllers/Auth/ResetPasswordController.php @@ -42,7 +42,7 @@ class ResetPasswordController extends Controller } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/BasePageController.php b/app/Http/Controllers/BasePageController.php index 46f398680..db1fa3551 100644 --- a/app/Http/Controllers/BasePageController.php +++ b/app/Http/Controllers/BasePageController.php @@ -101,7 +101,6 @@ class BasePageController extends Controller * @param $page * @param $path * @param $reqQuery - * * @return \Illuminate\Pagination\LengthAwarePaginator */ public function paginate($query, $totalCount, $items, $page, $path, $reqQuery): LengthAwarePaginator @@ -158,7 +157,6 @@ class BasePageController extends Controller * Show 404 page. * * @param $message - * * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View */ public function show404($message = null) @@ -211,7 +209,7 @@ class BasePageController extends Controller } /** - * @param string $retry + * @param string $retry */ public function show429($retry = '') { diff --git a/app/Http/Controllers/BooksController.php b/app/Http/Controllers/BooksController.php index 4216f1e58..f503360c1 100644 --- a/app/Http/Controllers/BooksController.php +++ b/app/Http/Controllers/BooksController.php @@ -10,9 +10,8 @@ use Illuminate\Support\Arr; class BooksController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * - * @param string $id + * @param \Illuminate\Http\Request $request + * @param string $id * * @throws \Exception */ diff --git a/app/Http/Controllers/BrowseController.php b/app/Http/Controllers/BrowseController.php index ed9640a54..4438eed2f 100644 --- a/app/Http/Controllers/BrowseController.php +++ b/app/Http/Controllers/BrowseController.php @@ -57,8 +57,9 @@ class BrowseController extends BasePageController } /** - * @param string $parentCategory - * @param string $id + * @param string $parentCategory + * @param string $id + * * @throws \Exception */ public function show(string $parentCategory, string $id = 'All') @@ -153,7 +154,8 @@ class BrowseController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request + * * @throws \Exception */ public function group(Request $request) @@ -193,7 +195,8 @@ class BrowseController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request + * * @throws \Exception */ public function tags(Request $request) diff --git a/app/Http/Controllers/BtcPaymentController.php b/app/Http/Controllers/BtcPaymentController.php index fc6d24312..9a080a1b2 100644 --- a/app/Http/Controllers/BtcPaymentController.php +++ b/app/Http/Controllers/BtcPaymentController.php @@ -10,8 +10,9 @@ use Spatie\Permission\Models\Role; class BtcPaymentController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function show(Request $request) diff --git a/app/Http/Controllers/CartController.php b/app/Http/Controllers/CartController.php index 44a8693eb..c0bcd52eb 100644 --- a/app/Http/Controllers/CartController.php +++ b/app/Http/Controllers/CartController.php @@ -28,9 +28,9 @@ class CartController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function store(Request $request) @@ -55,9 +55,9 @@ class CartController extends BasePageController } /** - * @param string|array $id - * + * @param string|array $id * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function destroy($id) diff --git a/app/Http/Controllers/ConsoleController.php b/app/Http/Controllers/ConsoleController.php index 6f836f9a0..997322dad 100644 --- a/app/Http/Controllers/ConsoleController.php +++ b/app/Http/Controllers/ConsoleController.php @@ -11,10 +11,10 @@ use Illuminate\Support\Arr; class ConsoleController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * @param string $id - * + * @param \Illuminate\Http\Request $request + * @param string $id * @return \Illuminate\Http\JsonResponse + * * @throws \Exception */ public function show(Request $request, $id = '') diff --git a/app/Http/Controllers/ContactUsController.php b/app/Http/Controllers/ContactUsController.php index 2af60a52a..ec4ab951b 100644 --- a/app/Http/Controllers/ContactUsController.php +++ b/app/Http/Controllers/ContactUsController.php @@ -8,9 +8,9 @@ use Illuminate\Http\Request; class ContactUsController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function contact(Request $request) @@ -50,7 +50,7 @@ class ContactUsController extends BasePageController } /** - * @param string $msg + * @param string $msg * * @throws \Exception */ diff --git a/app/Http/Controllers/ContentController.php b/app/Http/Controllers/ContentController.php index d7d35b6a4..3d98cd5ab 100644 --- a/app/Http/Controllers/ContentController.php +++ b/app/Http/Controllers/ContentController.php @@ -8,9 +8,9 @@ use Illuminate\Http\Request; class ContentController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\JsonResponse + * * @throws \Exception */ public function show(Request $request) diff --git a/app/Http/Controllers/DetailsController.php b/app/Http/Controllers/DetailsController.php index 15a0541fa..5d9318371 100644 --- a/app/Http/Controllers/DetailsController.php +++ b/app/Http/Controllers/DetailsController.php @@ -28,8 +28,8 @@ class DetailsController extends BasePageController { /** * @param $guid - * * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function show($guid) diff --git a/app/Http/Controllers/FailedReleasesController.php b/app/Http/Controllers/FailedReleasesController.php index a8619332d..4aa985250 100644 --- a/app/Http/Controllers/FailedReleasesController.php +++ b/app/Http/Controllers/FailedReleasesController.php @@ -9,9 +9,9 @@ use Illuminate\Http\Request; class FailedReleasesController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return mixed + * * @throws \Exception */ public function failed(Request $request) diff --git a/app/Http/Controllers/FileListController.php b/app/Http/Controllers/FileListController.php index c1018136c..b2ebb76a0 100644 --- a/app/Http/Controllers/FileListController.php +++ b/app/Http/Controllers/FileListController.php @@ -9,6 +9,7 @@ class FileListController extends BasePageController { /** * @param $guid + * * @throws \Exception */ public function show($guid) diff --git a/app/Http/Controllers/ForumController.php b/app/Http/Controllers/ForumController.php index 6eb81fac2..37c3d26ea 100644 --- a/app/Http/Controllers/ForumController.php +++ b/app/Http/Controllers/ForumController.php @@ -10,8 +10,9 @@ use Illuminate\Support\Facades\Auth; class ForumController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function forum(Request $request) @@ -65,8 +66,9 @@ class ForumController extends BasePageController /** * @param $id - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function getPosts($id, Request $request) @@ -105,7 +107,7 @@ class ForumController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector */ public function deleteTopic(Request $request) @@ -122,7 +124,8 @@ class ForumController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request + * * @throws \Exception */ public function edit(Request $request) @@ -156,8 +159,8 @@ class ForumController extends BasePageController /** * @param $id - * * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function destroy($id) diff --git a/app/Http/Controllers/GamesController.php b/app/Http/Controllers/GamesController.php index a607a1c20..b92774ea7 100644 --- a/app/Http/Controllers/GamesController.php +++ b/app/Http/Controllers/GamesController.php @@ -10,7 +10,7 @@ use Illuminate\Http\Request; class GamesController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/GetNzbController.php b/app/Http/Controllers/GetNzbController.php index 60ef5394e..e0251454a 100644 --- a/app/Http/Controllers/GetNzbController.php +++ b/app/Http/Controllers/GetNzbController.php @@ -18,9 +18,9 @@ use Symfony\Component\HttpFoundation\StreamedResponse; class GetNzbController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return StreamedResponse|BinaryFileResponse|JsonResponse + * * @throws \Exception */ public function getNzb(Request $request) diff --git a/app/Http/Controllers/MovieController.php b/app/Http/Controllers/MovieController.php index 82e7ccc27..8bee3cbbe 100644 --- a/app/Http/Controllers/MovieController.php +++ b/app/Http/Controllers/MovieController.php @@ -10,9 +10,9 @@ use Illuminate\Support\Arr; class MovieController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\JsonResponse + * * @throws \Exception */ public function showMovie(Request $request) @@ -51,8 +51,8 @@ class MovieController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * @param string $id + * @param \Illuminate\Http\Request $request + * @param string $id * * @throws \Exception */ @@ -169,9 +169,9 @@ class MovieController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\JsonResponse + * * @throws \Exception */ public function showTrailer(Request $request) diff --git a/app/Http/Controllers/MusicController.php b/app/Http/Controllers/MusicController.php index 8253a13e5..29f3c8dd9 100644 --- a/app/Http/Controllers/MusicController.php +++ b/app/Http/Controllers/MusicController.php @@ -11,8 +11,8 @@ use Illuminate\Support\Arr; class MusicController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * @param string $id + * @param \Illuminate\Http\Request $request + * @param string $id * * @throws \Exception */ diff --git a/app/Http/Controllers/MyMoviesController.php b/app/Http/Controllers/MyMoviesController.php index 20bd76de6..bf3559f01 100644 --- a/app/Http/Controllers/MyMoviesController.php +++ b/app/Http/Controllers/MyMoviesController.php @@ -12,9 +12,9 @@ use Illuminate\Http\Request; class MyMoviesController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function show(Request $request) diff --git a/app/Http/Controllers/MyShowsController.php b/app/Http/Controllers/MyShowsController.php index 12bf10bc6..5f5bf9232 100644 --- a/app/Http/Controllers/MyShowsController.php +++ b/app/Http/Controllers/MyShowsController.php @@ -12,8 +12,9 @@ use Illuminate\Http\Request; class MyShowsController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \Exception */ public function show(Request $request) @@ -163,7 +164,7 @@ class MyShowsController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/NfoController.php b/app/Http/Controllers/NfoController.php index 2fb3723d8..e249255df 100644 --- a/app/Http/Controllers/NfoController.php +++ b/app/Http/Controllers/NfoController.php @@ -10,8 +10,8 @@ use Illuminate\Http\Request; class NfoController extends BasePageController { /** - * @param string $id - * @param \Illuminate\Http\Request $request + * @param string $id + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/PasswordSecurityController.php b/app/Http/Controllers/PasswordSecurityController.php index 6974c4116..7d3e924f3 100644 --- a/app/Http/Controllers/PasswordSecurityController.php +++ b/app/Http/Controllers/PasswordSecurityController.php @@ -10,7 +10,7 @@ use Illuminate\Support\Facades\Hash; class PasswordSecurityController extends Controller { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Contracts\Foundation\Application|\Illuminate\Contracts\View\Factory|\Illuminate\Contracts\View\View */ public function show2faForm(Request $request) @@ -34,8 +34,9 @@ class PasswordSecurityController extends Controller } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Contracts\Foundation\Application|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \PragmaRX\Google2FA\Exceptions\IncompatibleWithGoogleAuthenticatorException * @throws \PragmaRX\Google2FA\Exceptions\InvalidCharactersException * @throws \PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException @@ -57,8 +58,9 @@ class PasswordSecurityController extends Controller } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Contracts\Foundation\Application|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector + * * @throws \PragmaRX\Google2FA\Exceptions\IncompatibleWithGoogleAuthenticatorException * @throws \PragmaRX\Google2FA\Exceptions\InvalidCharactersException * @throws \PragmaRX\Google2FA\Exceptions\SecretKeyTooShortException @@ -79,7 +81,7 @@ class PasswordSecurityController extends Controller } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return \Illuminate\Contracts\Foundation\Application|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector */ public function disable2fa(Request $request) diff --git a/app/Http/Controllers/ProfileController.php b/app/Http/Controllers/ProfileController.php index 4274cace4..de9e1f1be 100644 --- a/app/Http/Controllers/ProfileController.php +++ b/app/Http/Controllers/ProfileController.php @@ -21,7 +21,7 @@ use Jrean\UserVerification\Facades\UserVerification; class ProfileController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Throwable */ @@ -120,9 +120,9 @@ class ProfileController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|void + * * @throws \Exception */ public function edit(Request $request) @@ -352,8 +352,9 @@ class ProfileController extends BasePageController } /** - * @param Request $request + * @param Request $request * @return \Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|\Illuminate\View\View + * * @throws \Exception */ public function destroy(Request $request) diff --git a/app/Http/Controllers/QueueController.php b/app/Http/Controllers/QueueController.php index 49deccc90..d955c0801 100644 --- a/app/Http/Controllers/QueueController.php +++ b/app/Http/Controllers/QueueController.php @@ -11,7 +11,7 @@ use Illuminate\Http\Request; class QueueController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/RssController.php b/app/Http/Controllers/RssController.php index eb5123e45..8f742f23b 100644 --- a/app/Http/Controllers/RssController.php +++ b/app/Http/Controllers/RssController.php @@ -14,9 +14,9 @@ use Illuminate\Support\Carbon; class RssController extends BasePageController { /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return array|\Illuminate\Http\JsonResponse + * * @throws \Throwable */ public function myMoviesRss(Request $request) @@ -40,9 +40,9 @@ class RssController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return array|\Illuminate\Http\JsonResponse + * * @throws \Throwable */ public function myShowsRss(Request $request) @@ -62,9 +62,9 @@ class RssController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return array|\Illuminate\Http\JsonResponse + * * @throws \Throwable */ public function fullFeedRss(Request $request) @@ -134,9 +134,9 @@ class RssController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return array|\Illuminate\Http\JsonResponse + * * @throws \Throwable */ public function cartRss(Request $request) @@ -164,9 +164,9 @@ class RssController extends BasePageController } /** - * @param \Illuminate\Http\Request $request - * + * @param \Illuminate\Http\Request $request * @return array|\Illuminate\Http\JsonResponse + * * @throws \Throwable */ public function categoryFeedRss(Request $request) @@ -198,8 +198,9 @@ class RssController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return array|\Illuminate\Http\JsonResponse + * * @throws \Throwable */ private function userCheck(Request $request) diff --git a/app/Http/Controllers/SearchController.php b/app/Http/Controllers/SearchController.php index f15af8f9d..5dd88069c 100644 --- a/app/Http/Controllers/SearchController.php +++ b/app/Http/Controllers/SearchController.php @@ -10,7 +10,7 @@ use Illuminate\Http\Request; class SearchController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/SendReleaseController.php b/app/Http/Controllers/SendReleaseController.php index 1c843019b..27c911428 100644 --- a/app/Http/Controllers/SendReleaseController.php +++ b/app/Http/Controllers/SendReleaseController.php @@ -12,7 +12,7 @@ use Illuminate\Support\Facades\Auth; class SendReleaseController extends BasePageController { /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -37,7 +37,7 @@ class SendReleaseController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -64,7 +64,7 @@ class SendReleaseController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ @@ -95,7 +95,7 @@ class SendReleaseController extends BasePageController } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Controllers/SeriesController.php b/app/Http/Controllers/SeriesController.php index bd68a2664..a97acecfa 100644 --- a/app/Http/Controllers/SeriesController.php +++ b/app/Http/Controllers/SeriesController.php @@ -11,8 +11,8 @@ use Illuminate\Support\Arr; class SeriesController extends BasePageController { /** - * @param string $id - * @param \Illuminate\Http\Request $request + * @param string $id + * @param \Illuminate\Http\Request $request * * @throws \Exception */ diff --git a/app/Http/Middleware/ClearanceMiddleware.php b/app/Http/Middleware/ClearanceMiddleware.php index 7b2b7ae96..be09d2336 100644 --- a/app/Http/Middleware/ClearanceMiddleware.php +++ b/app/Http/Middleware/ClearanceMiddleware.php @@ -10,9 +10,10 @@ class ClearanceMiddleware /** * Handle an incoming request. * - * @param \Illuminate\Http\Request $request - * @param \Closure $next + * @param \Illuminate\Http\Request $request + * @param \Closure $next * @return mixed + * * @throws \Exception */ public function handle($request, Closure $next) diff --git a/app/Jobs/SendAccountChangedEmail.php b/app/Jobs/SendAccountChangedEmail.php index c5ae75601..8e29d55db 100644 --- a/app/Jobs/SendAccountChangedEmail.php +++ b/app/Jobs/SendAccountChangedEmail.php @@ -22,7 +22,7 @@ class SendAccountChangedEmail implements ShouldQueue /** * Create a new job instance. * - * @param \App\Models\User $user + * @param \App\Models\User $user */ public function __construct($user) { diff --git a/app/Jobs/SendAccountDeletedEmail.php b/app/Jobs/SendAccountDeletedEmail.php index f89bcfc91..cec9824d2 100644 --- a/app/Jobs/SendAccountDeletedEmail.php +++ b/app/Jobs/SendAccountDeletedEmail.php @@ -22,7 +22,7 @@ class SendAccountDeletedEmail implements ShouldQueue /** * Create a new job instance. * - * @param \App\Models\User $user + * @param \App\Models\User $user */ public function __construct($user) { diff --git a/app/Jobs/SendAccountExpiredEmail.php b/app/Jobs/SendAccountExpiredEmail.php index 1262d6834..c92d41035 100644 --- a/app/Jobs/SendAccountExpiredEmail.php +++ b/app/Jobs/SendAccountExpiredEmail.php @@ -22,7 +22,7 @@ class SendAccountExpiredEmail implements ShouldQueue /** * Create a new job instance. * - * @param \App\Models\User $user + * @param \App\Models\User $user */ public function __construct($user) { diff --git a/app/Jobs/SendNewRegisteredAccountMail.php b/app/Jobs/SendNewRegisteredAccountMail.php index dcd071996..8c9730d2c 100644 --- a/app/Jobs/SendNewRegisteredAccountMail.php +++ b/app/Jobs/SendNewRegisteredAccountMail.php @@ -22,7 +22,7 @@ class SendNewRegisteredAccountMail implements ShouldQueue /** * Create a new job instance. * - * @param \App\Models\User $user + * @param \App\Models\User $user */ public function __construct($user) { diff --git a/app/Jobs/SendPasswordForgottenEmail.php b/app/Jobs/SendPasswordForgottenEmail.php index d3533c740..fa2b76459 100644 --- a/app/Jobs/SendPasswordForgottenEmail.php +++ b/app/Jobs/SendPasswordForgottenEmail.php @@ -24,7 +24,7 @@ class SendPasswordForgottenEmail implements ShouldQueue /** * Create a new job instance. * - * @param \App\Models\User $user + * @param \App\Models\User $user * @param $resetLink */ public function __construct($user, $resetLink) diff --git a/app/Jobs/SendPasswordResetEmail.php b/app/Jobs/SendPasswordResetEmail.php index ffcf98a7b..d24b73c2c 100644 --- a/app/Jobs/SendPasswordResetEmail.php +++ b/app/Jobs/SendPasswordResetEmail.php @@ -27,8 +27,8 @@ class SendPasswordResetEmail implements ShouldQueue /** * Create a new job instance. * - * @param \App\Models\User $user - * @param string $newPass + * @param \App\Models\User $user + * @param string $newPass */ public function __construct($user, $newPass) { diff --git a/app/Jobs/SendWelcomeEmail.php b/app/Jobs/SendWelcomeEmail.php index abf9e24ba..965359419 100644 --- a/app/Jobs/SendWelcomeEmail.php +++ b/app/Jobs/SendWelcomeEmail.php @@ -22,7 +22,7 @@ class SendWelcomeEmail implements ShouldQueue /** * Create a new job instance. * - * @param \App\Models\User $user + * @param \App\Models\User $user */ public function __construct($user) { diff --git a/app/Mail/AccountChange.php b/app/Mail/AccountChange.php index b8f21d224..6600f5d52 100644 --- a/app/Mail/AccountChange.php +++ b/app/Mail/AccountChange.php @@ -28,7 +28,7 @@ class AccountChange extends Mailable /** * AccountChange constructor. * - * @param \App\Models\User $user + * @param \App\Models\User $user */ public function __construct($user) { @@ -41,6 +41,7 @@ class AccountChange extends Mailable * Build the message. * * @return $this + * * @throws \Exception */ public function build() diff --git a/app/Mail/AccountDeleted.php b/app/Mail/AccountDeleted.php index fffc3a966..7e5b44cc1 100644 --- a/app/Mail/AccountDeleted.php +++ b/app/Mail/AccountDeleted.php @@ -39,6 +39,7 @@ class AccountDeleted extends Mailable /** * @return $this + * * @throws \Exception */ public function build() diff --git a/app/Mail/AccountExpired.php b/app/Mail/AccountExpired.php index b42aa8ee2..6b16713f1 100644 --- a/app/Mail/AccountExpired.php +++ b/app/Mail/AccountExpired.php @@ -30,6 +30,7 @@ class AccountExpired extends Mailable * Build the message. * * @return $this + * * @throws \Exception */ public function build() diff --git a/app/Mail/ContactUs.php b/app/Mail/ContactUs.php index 1087a9d14..74cddbb7c 100644 --- a/app/Mail/ContactUs.php +++ b/app/Mail/ContactUs.php @@ -30,6 +30,7 @@ class ContactUs extends Mailable * Build the message. * * @return $this + * * @throws \Exception */ public function build() diff --git a/app/Mail/ForgottenPassword.php b/app/Mail/ForgottenPassword.php index 64a65b694..bed1166e3 100644 --- a/app/Mail/ForgottenPassword.php +++ b/app/Mail/ForgottenPassword.php @@ -40,6 +40,7 @@ class ForgottenPassword extends Mailable * Build the message. * * @return $this + * * @throws \Exception */ public function build() diff --git a/app/Mail/PasswordReset.php b/app/Mail/PasswordReset.php index 96d52aece..99f3c09ec 100644 --- a/app/Mail/PasswordReset.php +++ b/app/Mail/PasswordReset.php @@ -33,8 +33,8 @@ class PasswordReset extends Mailable /** * PasswordReset constructor. * - * @param \App\Models\User $user - * @param $newPass + * @param \App\Models\User $user + * @param $newPass */ public function __construct($user, $newPass) { @@ -48,6 +48,7 @@ class PasswordReset extends Mailable * Build the message. * * @return $this + * * @throws \Exception */ public function build() diff --git a/app/Mail/SendInvite.php b/app/Mail/SendInvite.php index 1b05e4260..5a123552c 100644 --- a/app/Mail/SendInvite.php +++ b/app/Mail/SendInvite.php @@ -33,8 +33,8 @@ class SendInvite extends Mailable /** * SendInvite constructor. * - * @param \App\Models\User $user - * @param $invite + * @param \App\Models\User $user + * @param $invite */ public function __construct($user, $invite) { @@ -48,6 +48,7 @@ class SendInvite extends Mailable * Build the message. * * @return $this + * * @throws \Exception */ public function build() diff --git a/app/Mail/WelcomeEmail.php b/app/Mail/WelcomeEmail.php index 19b8c7874..c835b154d 100644 --- a/app/Mail/WelcomeEmail.php +++ b/app/Mail/WelcomeEmail.php @@ -28,7 +28,7 @@ class WelcomeEmail extends Mailable /** * Create a new message instance. * - * @param \App\Models\User $user + * @param \App\Models\User $user */ public function __construct($user) { diff --git a/app/Models/AnidbEpisode.php b/app/Models/AnidbEpisode.php index 2cdc5de1c..6755dd1b6 100644 --- a/app/Models/AnidbEpisode.php +++ b/app/Models/AnidbEpisode.php @@ -14,12 +14,14 @@ use Illuminate\Database\Eloquent\Model; * @property string $airdate * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\AnidbInfo[] $info * @property-read \App\Models\AnidbTitle $title + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbEpisode whereAirdate($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbEpisode whereAnidbid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbEpisode whereEpisodeNo($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbEpisode whereEpisodeTitle($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbEpisode whereEpisodeid($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbEpisode newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbEpisode newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbEpisode query() diff --git a/app/Models/AnidbInfo.php b/app/Models/AnidbInfo.php index 709103305..53727be14 100644 --- a/app/Models/AnidbInfo.php +++ b/app/Models/AnidbInfo.php @@ -10,6 +10,7 @@ use Illuminate\Database\Eloquent\Model; * @property-read \App\Models\AnidbEpisode $episode * @property-read \App\Models\AnidbTitle $title * @mixin \Eloquent + * * @property int $anidbid ID of title from AniDB * @property string|null $type * @property string|null $startdate @@ -23,6 +24,7 @@ use Illuminate\Database\Eloquent\Model; * @property string|null $picture * @property string|null $categories * @property string|null $characters + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbInfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbInfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbInfo query() diff --git a/app/Models/AnidbTitle.php b/app/Models/AnidbTitle.php index d62a34970..7acb35377 100644 --- a/app/Models/AnidbTitle.php +++ b/app/Models/AnidbTitle.php @@ -13,11 +13,13 @@ use Illuminate\Database\Eloquent\Model; * @property string $title * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\AnidbEpisode[] $episode * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\AnidbInfo[] $info + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbTitle whereAnidbid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbTitle whereLang($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbTitle whereTitle($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbTitle whereType($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbTitle newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbTitle newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AnidbTitle query() diff --git a/app/Models/AudioData.php b/app/Models/AudioData.php index fe05964b2..cec494e45 100644 --- a/app/Models/AudioData.php +++ b/app/Models/AudioData.php @@ -19,6 +19,7 @@ use Illuminate\Database\Eloquent\Model; * @property string|null $audiolibrary * @property string|null $audiolanguage * @property string|null $audiotitle + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AudioData whereAudiobitrate($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AudioData whereAudiobitratemode($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AudioData whereAudiochannels($value) @@ -32,6 +33,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AudioData whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AudioData whereReleasesId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AudioData newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AudioData newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\AudioData query() diff --git a/app/Models/Binary.php b/app/Models/Binary.php index e6b9b38a3..6473814b5 100644 --- a/app/Models/Binary.php +++ b/app/Models/Binary.php @@ -16,6 +16,7 @@ use Illuminate\Database\Eloquent\Model; * @property bool $partcheck * @property int $partsize * @property mixed $binaryhash + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Binary whereBinaryhash($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Binary whereCollectionsId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Binary whereCurrentparts($value) @@ -26,6 +27,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Binary wherePartsize($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Binary whereTotalparts($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Binary newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Binary newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Binary query() diff --git a/app/Models/BinaryBlacklist.php b/app/Models/BinaryBlacklist.php index 9997b5156..06f791c9c 100644 --- a/app/Models/BinaryBlacklist.php +++ b/app/Models/BinaryBlacklist.php @@ -15,6 +15,7 @@ use Illuminate\Database\Eloquent\Model; * @property int $status * @property string|null $description * @property string|null $last_activity + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BinaryBlacklist whereDescription($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BinaryBlacklist whereGroupname($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BinaryBlacklist whereId($value) @@ -24,6 +25,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BinaryBlacklist whereRegex($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BinaryBlacklist whereStatus($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BinaryBlacklist newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BinaryBlacklist newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BinaryBlacklist query() diff --git a/app/Models/BookInfo.php b/app/Models/BookInfo.php index f2fe0f125..15cc9f258 100644 --- a/app/Models/BookInfo.php +++ b/app/Models/BookInfo.php @@ -24,6 +24,7 @@ use Laravel\Scout\Searchable; * @property bool $cover * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BookInfo whereAsin($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BookInfo whereAuthor($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BookInfo whereCover($value) @@ -41,6 +42,7 @@ use Laravel\Scout\Searchable; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BookInfo whereUpdatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BookInfo whereUrl($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BookInfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BookInfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\BookInfo query() diff --git a/app/Models/Category.php b/app/Models/Category.php index 3db19bc71..35552ebe6 100644 --- a/app/Models/Category.php +++ b/app/Models/Category.php @@ -20,6 +20,7 @@ use Illuminate\Support\Facades\DB; * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Category[] $children * @property-read \App\Models\Category|null $parent * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Release[] $releases + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Category whereDescription($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Category whereDisablepreview($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Category whereId($value) @@ -29,7 +30,9 @@ use Illuminate\Support\Facades\DB; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Category whereStatus($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Category whereTitle($value) * @mixin \Eloquent + * * @property int|null $root_categories_id + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Category newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Category newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Category query() @@ -297,8 +300,7 @@ class Category extends Model } /** - * @param array $cat - * + * @param array $cat * @return string */ public static function getCategorySearch(array $cat = []) @@ -358,7 +360,6 @@ class Category extends Model /** * @param $category - * * @return mixed */ public static function getCategoryValue($category) @@ -370,7 +371,6 @@ class Category extends Model * Check if category is parent. * * @param $cid - * * @return bool */ public static function isParent($cid): bool @@ -436,7 +436,6 @@ class Category extends Model * Get multiple categories. * * @param $ids - * * @return bool|\Illuminate\Database\Eloquent\Collection|static[] */ public static function getByIds($ids) @@ -462,7 +461,6 @@ class Category extends Model * * * @param $categoryId - * * @return string */ public static function getNameByID($categoryId): string @@ -510,8 +508,7 @@ class Category extends Model } /** - * @param array $excludedCats - * + * @param array $excludedCats * @return array */ public static function getForMenu(array $excludedCats = []): array @@ -554,8 +551,7 @@ class Category extends Model /** * Return a list of categories for use in a dropdown. * - * @param bool $blnIncludeNoneSelected - * + * @param bool $blnIncludeNoneSelected * @return array */ public static function getForSelect($blnIncludeNoneSelected = true): array @@ -574,8 +570,8 @@ class Category extends Model } /** - * @param bool $activeOnly - * @param array $excludedCats + * @param bool $activeOnly + * @param array $excludedCats * @return array */ public static function getCategories($activeOnly = false, array $excludedCats = []) diff --git a/app/Models/CategoryRegex.php b/app/Models/CategoryRegex.php index 6e3c3a592..f2828c476 100644 --- a/app/Models/CategoryRegex.php +++ b/app/Models/CategoryRegex.php @@ -14,6 +14,7 @@ use Illuminate\Database\Eloquent\Model; * @property string $description Optional extra details on this regex * @property int $ordinal Order to run the regex in * @property int $categories_id Which categories id to put the release in + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CategoryRegex whereCategoriesId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CategoryRegex whereDescription($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CategoryRegex whereGroupRegex($value) @@ -22,6 +23,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CategoryRegex whereRegex($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CategoryRegex whereStatus($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CategoryRegex newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CategoryRegex newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CategoryRegex query() diff --git a/app/Models/Collection.php b/app/Models/Collection.php index 463c7c27b..2e8ad559e 100644 --- a/app/Models/Collection.php +++ b/app/Models/Collection.php @@ -22,6 +22,7 @@ use Illuminate\Database\Eloquent\Model; * @property int $filesize * @property int|null $releases_id * @property string $noise + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Collection whereAdded($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Collection whereCollectionRegexesId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Collection whereCollectionhash($value) @@ -38,6 +39,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Collection whereTotalfiles($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Collection whereXref($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Collection newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Collection newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Collection query() diff --git a/app/Models/CollectionRegex.php b/app/Models/CollectionRegex.php index 492d2317f..b933d758c 100644 --- a/app/Models/CollectionRegex.php +++ b/app/Models/CollectionRegex.php @@ -13,6 +13,7 @@ use Illuminate\Database\Eloquent\Model; * @property bool $status 1=ON 0=OFF * @property string $description Optional extra details on this regex * @property int $ordinal Order to run the regex in + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CollectionRegex whereDescription($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CollectionRegex whereGroupRegex($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CollectionRegex whereId($value) @@ -20,6 +21,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CollectionRegex whereRegex($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CollectionRegex whereStatus($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CollectionRegex newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CollectionRegex newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\CollectionRegex query() diff --git a/app/Models/ConsoleInfo.php b/app/Models/ConsoleInfo.php index 3344a91be..2c8ed192a 100644 --- a/app/Models/ConsoleInfo.php +++ b/app/Models/ConsoleInfo.php @@ -22,6 +22,7 @@ use Laravel\Scout\Searchable; * @property bool $cover * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ConsoleInfo whereAsin($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ConsoleInfo whereCover($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ConsoleInfo whereCreatedAt($value) @@ -37,6 +38,7 @@ use Laravel\Scout\Searchable; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ConsoleInfo whereUpdatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ConsoleInfo whereUrl($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ConsoleInfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ConsoleInfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ConsoleInfo query() diff --git a/app/Models/Content.php b/app/Models/Content.php index 84f8084f1..e6668e27a 100644 --- a/app/Models/Content.php +++ b/app/Models/Content.php @@ -18,6 +18,7 @@ use Illuminate\Database\Eloquent\Model; * @property int $status * @property int|null $ordinal * @property int $role + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Content whereBody($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Content whereContenttype($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Content whereId($value) @@ -30,6 +31,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Content whereTitle($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Content whereUrl($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Content newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Content newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Content query() diff --git a/app/Models/Country.php b/app/Models/Country.php index 4a80becf2..727c9c1f6 100644 --- a/app/Models/Country.php +++ b/app/Models/Country.php @@ -25,6 +25,7 @@ use Illuminate\Database\Eloquent\Model; * @property bool $eea * @property string|null $calling_code * @property string|null $flag + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Country whereCallingCode($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Country whereCapital($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Country whereCitizenship($value) @@ -44,6 +45,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Country whereRegionCode($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Country whereSubRegionCode($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Country newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Country newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Country query() diff --git a/app/Models/DnzbFailure.php b/app/Models/DnzbFailure.php index 7f7eff7b8..0a7ba9e46 100644 --- a/app/Models/DnzbFailure.php +++ b/app/Models/DnzbFailure.php @@ -12,10 +12,12 @@ use Illuminate\Database\Eloquent\Model; * @property int $failed * @property-read \App\Models\Release $release * @property-read \App\Models\User $user + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\DnzbFailure whereFailed($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\DnzbFailure whereReleaseId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\DnzbFailure whereUsersId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\DnzbFailure newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\DnzbFailure newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\DnzbFailure query() @@ -62,7 +64,6 @@ class DnzbFailure extends Model * * * @param $relId - * * @return bool|mixed */ public static function getFailedCount($relId) diff --git a/app/Models/Forumpost.php b/app/Models/Forumpost.php index 6eb3fe577..047f5710f 100644 --- a/app/Models/Forumpost.php +++ b/app/Models/Forumpost.php @@ -18,6 +18,7 @@ use Illuminate\Database\Eloquent\Model; * @property int $replies * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forumpost whereCreatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forumpost whereForumid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forumpost whereId($value) @@ -30,6 +31,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forumpost whereUpdatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forumpost whereUsersId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forumpost newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forumpost newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Forumpost query() @@ -56,9 +58,9 @@ class Forumpost extends Model * @param $userid * @param $subject * @param $message - * @param int $locked - * @param int $sticky - * @param int $replies + * @param int $locked + * @param int $sticky + * @param int $replies * @return int */ public static function add($parentId, $userid, $subject, $message, $locked = 0, $sticky = 0, $replies = 0): int @@ -143,7 +145,6 @@ class Forumpost extends Model * * * @param $start - * * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator */ public static function getBrowseRange() diff --git a/app/Models/GamesInfo.php b/app/Models/GamesInfo.php index b2de028fa..9062b2adb 100644 --- a/app/Models/GamesInfo.php +++ b/app/Models/GamesInfo.php @@ -23,6 +23,7 @@ use Laravel\Scout\Searchable; * @property string $classused * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\GamesInfo whereAsin($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\GamesInfo whereBackdrop($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\GamesInfo whereClassused($value) @@ -39,6 +40,7 @@ use Laravel\Scout\Searchable; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\GamesInfo whereUpdatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\GamesInfo whereUrl($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\GamesInfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\GamesInfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\GamesInfo query() diff --git a/app/Models/Genre.php b/app/Models/Genre.php index 3d5182765..96316858f 100644 --- a/app/Models/Genre.php +++ b/app/Models/Genre.php @@ -12,11 +12,13 @@ use Illuminate\Database\Eloquent\Model; * @property int|null $type * @property bool $disabled * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\MusicInfo[] $music + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Genre whereDisabled($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Genre whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Genre whereTitle($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Genre whereType($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Genre newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Genre newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Genre query() diff --git a/app/Models/Invitation.php b/app/Models/Invitation.php index 560e7a872..1cc6e33f0 100644 --- a/app/Models/Invitation.php +++ b/app/Models/Invitation.php @@ -13,12 +13,14 @@ use Illuminate\Database\Eloquent\Model; * @property string|null $created_at * @property string|null $updated_at * @property-read \App\Models\User $user + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Invitation whereCreatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Invitation whereGuid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Invitation whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Invitation whereUpdatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Invitation whereUsersId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Invitation newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Invitation newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Invitation query() @@ -49,8 +51,8 @@ class Invitation extends Model } /** - * @param int $uid - * @param string $inviteToken + * @param int $uid + * @param string $inviteToken */ public static function addInvite(int $uid, string $inviteToken) { diff --git a/app/Models/MissedPart.php b/app/Models/MissedPart.php index 2b4197bbb..39771968d 100644 --- a/app/Models/MissedPart.php +++ b/app/Models/MissedPart.php @@ -11,11 +11,13 @@ use Illuminate\Database\Eloquent\Model; * @property int $numberid * @property int $groups_id FK to groups.id * @property bool $attempts + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MissedPart whereAttempts($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MissedPart whereGroupsId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MissedPart whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MissedPart whereNumberid($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MissedPart newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MissedPart newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MissedPart query() diff --git a/app/Models/MovieInfo.php b/app/Models/MovieInfo.php index 73ff940b4..51053a4a7 100644 --- a/app/Models/MovieInfo.php +++ b/app/Models/MovieInfo.php @@ -26,6 +26,7 @@ use Illuminate\Database\Eloquent\Model; * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at * @property string $trailer + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MovieInfo whereActors($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MovieInfo whereBackdrop($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MovieInfo whereCover($value) @@ -46,7 +47,9 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MovieInfo whereUpdatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MovieInfo whereYear($value) * @mixin \Eloquent + * * @property int $traktid + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MovieInfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MovieInfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MovieInfo query() diff --git a/app/Models/MusicInfo.php b/app/Models/MusicInfo.php index 5cf558423..77d3a4b22 100644 --- a/app/Models/MusicInfo.php +++ b/app/Models/MusicInfo.php @@ -24,6 +24,7 @@ use Laravel\Scout\Searchable; * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at * @property-read \App\Models\Genre|null $genre + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MusicInfo whereArtist($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MusicInfo whereAsin($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MusicInfo whereCover($value) @@ -40,6 +41,7 @@ use Laravel\Scout\Searchable; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MusicInfo whereUrl($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MusicInfo whereYear($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MusicInfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MusicInfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\MusicInfo query() diff --git a/app/Models/ParHash.php b/app/Models/ParHash.php index 15d8db841..9ad8387ea 100644 --- a/app/Models/ParHash.php +++ b/app/Models/ParHash.php @@ -9,9 +9,11 @@ use Illuminate\Database\Eloquent\Model; * * @property int $releases_id FK to releases.id * @property string $hash hash_16k block of par2 + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ParHash whereHash($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ParHash whereReleasesId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ParHash newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ParHash newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ParHash query() diff --git a/app/Models/Part.php b/app/Models/Part.php index 1978de724..ee23fea68 100644 --- a/app/Models/Part.php +++ b/app/Models/Part.php @@ -12,12 +12,14 @@ use Illuminate\Database\Eloquent\Model; * @property int $number * @property int $partnumber * @property int $size + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Part whereBinariesId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Part whereMessageid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Part whereNumber($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Part wherePartnumber($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Part whereSize($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Part newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Part newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Part query() diff --git a/app/Models/Predb.php b/app/Models/Predb.php index 7ed20f6be..022cb4320 100644 --- a/app/Models/Predb.php +++ b/app/Models/Predb.php @@ -30,6 +30,7 @@ use Laravel\Scout\Searchable; * @property string|null $files How many files does this pre have ? * @property string $filename * @property bool $searched + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Predb whereCategory($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Predb whereFilename($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Predb whereFiles($value) @@ -45,6 +46,7 @@ use Laravel\Scout\Searchable; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Predb whereSource($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Predb whereTitle($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Predb newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Predb newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Predb query() @@ -94,7 +96,8 @@ class Predb extends Model /** * Attempts to match PreDB titles to releases. * - * @param string|int|bool $dateLimit + * @param string|int|bool $dateLimit + * * @throws \RuntimeException */ public static function checkPre($dateLimit = false): void @@ -144,8 +147,7 @@ class Predb extends Model /** * Try to match a single release to a PreDB title when the release is created. * - * @param string $cleanerName - * + * @param string $cleanerName * @return array|false Array with title/id from PreDB if found, false if not found. */ public static function matchPre($cleanerName) @@ -177,9 +179,9 @@ class Predb extends Model } /** - * @param string $search - * + * @param string $search * @return mixed + * * @throws \Exception */ public static function getAll($search = '') diff --git a/app/Models/PredbHash.php b/app/Models/PredbHash.php index b2f11ee90..69bbc0caf 100644 --- a/app/Models/PredbHash.php +++ b/app/Models/PredbHash.php @@ -10,9 +10,11 @@ use Illuminate\Database\Eloquent\Model; * @property int $predb_id id, of the predb entry, this hash belongs to * @property mixed $hash * @property-read \App\Models\Predb $predb + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbHash whereHash($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbHash wherePredbId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbHash newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbHash newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbHash query() diff --git a/app/Models/PredbImport.php b/app/Models/PredbImport.php index ff7ffd73c..99b22bc10 100644 --- a/app/Models/PredbImport.php +++ b/app/Models/PredbImport.php @@ -21,6 +21,7 @@ use Illuminate\Database\Eloquent\Model; * @property string $filename * @property bool $searched * @property string|null $groupname + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbImport whereCategory($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbImport whereFilename($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbImport whereFiles($value) @@ -36,6 +37,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbImport whereSource($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbImport whereTitle($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbImport newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbImport newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\PredbImport query() diff --git a/app/Models/Release.php b/app/Models/Release.php index 4f0446d18..b8ebf579c 100644 --- a/app/Models/Release.php +++ b/app/Models/Release.php @@ -61,9 +61,9 @@ use Illuminate\Support\Facades\DB; * @property bool $proc_files * @property bool $proc_uid * @property bool $proc_srr Has the release been srr - * processed + * processed * @property bool $proc_hash16k Has the release been hash16k - * processed + * processed * @property mixed|null $nzb_guid * @property-read \App\Models\Category $category * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\ReleaseComment[] $comment @@ -78,6 +78,7 @@ use Illuminate\Support\Facades\DB; * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\ReleasesGroups[] $releaseGroup * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\UsersRelease[] $userRelease * @property-read \App\Models\Video $video + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Release whereAdddate($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Release whereAnidbid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Release whereAudiostatus($value) @@ -128,11 +129,13 @@ use Illuminate\Support\Facades\DB; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Release whereVideostatus($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Release whereXxxinfoId($value) * @mixin \Eloquent + * * @property int|null $movieinfo_id FK to movieinfo.id * @property int $proc_crc32 Has the release been crc32 processed * @property mixed $tag_names * @property-read \Illuminate\Database\Eloquent\Collection|\Tagged[] $tags * @property-read \Illuminate\Database\Eloquent\Collection|\Conner\Tagging\Model\Tagged[] $tagged + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Release newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Release newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Release query() @@ -266,9 +269,9 @@ class Release extends Model /** * Insert a single release returning the ID on success or false on failure. * - * @param array $parameters Insert parameters, must be escaped if string. - * + * @param array $parameters Insert parameters, must be escaped if string. * @return bool|int + * * @throws \Exception */ public static function insertRelease(array $parameters = []) @@ -310,21 +313,22 @@ class Release extends Model /** * Used for release edit page on site. * - * @param int $id - * @param string $name - * @param string $searchName - * @param string $fromName - * @param int $categoryId - * @param int $parts - * @param int $grabs - * @param int $size - * @param string $postedDate - * @param string $addedDate - * @param $videoId - * @param $episodeId - * @param int $imDbId - * @param int $aniDbId - * @param string $tags + * @param int $id + * @param string $name + * @param string $searchName + * @param string $fromName + * @param int $categoryId + * @param int $parts + * @param int $grabs + * @param int $size + * @param string $postedDate + * @param string $addedDate + * @param $videoId + * @param $episodeId + * @param int $imDbId + * @param int $aniDbId + * @param string $tags + * * @throws \Exception */ public static function updateRelease($id, $name, $searchName, $fromName, $categoryId, $parts, $grabs, $size, $postedDate, $addedDate, $videoId, $episodeId, $imDbId, $aniDbId, string $tags = ''): void @@ -364,7 +368,8 @@ class Release extends Model } /** - * @param string $guid + * @param string $guid + * * @throws \Exception */ public static function updateGrab($guid): void @@ -590,8 +595,8 @@ class Release extends Model * Retrieve alternate release with same or similar searchname. * * - * @param string $guid - * @param int $userid + * @param string $guid + * @param int $userid * @return bool|\Illuminate\Database\Eloquent\Model|null|static */ public static function getAlternate($guid, $userid) diff --git a/app/Models/ReleaseComment.php b/app/Models/ReleaseComment.php index 2d8ac0c5f..fb593c2f9 100644 --- a/app/Models/ReleaseComment.php +++ b/app/Models/ReleaseComment.php @@ -27,6 +27,7 @@ use Illuminate\Database\Eloquent\Model; * @property mixed $nzb_guid * @property-read \App\Models\Release $release * @property-read \App\Models\User $user + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseComment whereCid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseComment whereCreatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseComment whereGid($value) @@ -46,6 +47,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseComment whereUsername($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseComment whereUsersId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseComment newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseComment newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseComment query() @@ -131,6 +133,7 @@ class ReleaseComment extends Model * @param $userid * @param $host * @return int + * * @throws \Exception */ public static function addComment($id, $gid, $text, $userid, $host): int diff --git a/app/Models/ReleaseExtraFull.php b/app/Models/ReleaseExtraFull.php index 23547f402..642349ccb 100644 --- a/app/Models/ReleaseExtraFull.php +++ b/app/Models/ReleaseExtraFull.php @@ -10,9 +10,11 @@ use Illuminate\Database\Eloquent\Model; * @property int $releases_id FK to releases.id * @property string|null $mediainfo * @property-read \App\Models\Release $release + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseExtraFull whereMediainfo($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseExtraFull whereReleasesId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseExtraFull newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseExtraFull newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseExtraFull query() diff --git a/app/Models/ReleaseFile.php b/app/Models/ReleaseFile.php index 91d7aac60..b37e47459 100644 --- a/app/Models/ReleaseFile.php +++ b/app/Models/ReleaseFile.php @@ -19,6 +19,7 @@ use Illuminate\Support\Facades\Log; * @property \Carbon\Carbon|null $updated_at * @property bool $passworded * @property-read \App\Models\Release $release + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseFile whereCreatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseFile whereIshashed($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseFile whereName($value) @@ -27,7 +28,9 @@ use Illuminate\Support\Facades\Log; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseFile whereSize($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseFile whereUpdatedAt($value) * @mixin \Eloquent + * * @property string $crc32 + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseFile newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseFile newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseFile query() @@ -86,15 +89,15 @@ class ReleaseFile extends Model * Add new files for a release ID. * * - * @param $id - * @param $name - * @param $size - * @param $createdTime - * @param $hasPassword - * - * @param string $hash - * @param string $crc + * @param $id + * @param $name + * @param $size + * @param $createdTime + * @param $hasPassword + * @param string $hash + * @param string $crc * @return int + * * @throws \Exception */ public static function addReleaseFiles($id, $name, $size, $createdTime, $hasPassword, $hash = '', $crc = ''): int diff --git a/app/Models/ReleaseNamingRegex.php b/app/Models/ReleaseNamingRegex.php index d7d115b2c..0c56d1fe3 100644 --- a/app/Models/ReleaseNamingRegex.php +++ b/app/Models/ReleaseNamingRegex.php @@ -13,6 +13,7 @@ use Illuminate\Database\Eloquent\Model; * @property bool $status 1=ON 0=OFF * @property string $description Optional extra details on this regex * @property int $ordinal Order to run the regex in + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNamingRegex whereDescription($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNamingRegex whereGroupRegex($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNamingRegex whereId($value) @@ -20,6 +21,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNamingRegex whereRegex($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNamingRegex whereStatus($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNamingRegex newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNamingRegex newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNamingRegex query() diff --git a/app/Models/ReleaseNfo.php b/app/Models/ReleaseNfo.php index c66f1c30f..9c7c43c02 100644 --- a/app/Models/ReleaseNfo.php +++ b/app/Models/ReleaseNfo.php @@ -10,9 +10,11 @@ use Illuminate\Database\Eloquent\Model; * @property int $releases_id FK to releases.id * @property mixed|null $nfo * @property-read \App\Models\Release $release + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNfo whereNfo($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNfo whereReleasesId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseNfo query() @@ -43,7 +45,7 @@ class ReleaseNfo extends Model /** * @param $id - * @param bool $getNfoString + * @param bool $getNfoString * @return \Illuminate\Database\Eloquent\Model|null|static */ public static function getReleaseNfo($id, $getNfoString = true) diff --git a/app/Models/ReleaseRegex.php b/app/Models/ReleaseRegex.php index f38cf564d..be9f38b1e 100644 --- a/app/Models/ReleaseRegex.php +++ b/app/Models/ReleaseRegex.php @@ -10,10 +10,12 @@ use Illuminate\Database\Eloquent\Model; * @property int $releases_id * @property int $collection_regex_id * @property int $naming_regex_id + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseRegex whereCollectionRegexId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseRegex whereNamingRegexId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseRegex whereReleasesId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseRegex newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseRegex newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseRegex query() diff --git a/app/Models/ReleaseSearchData.php b/app/Models/ReleaseSearchData.php index 6aa9ab271..883221423 100644 --- a/app/Models/ReleaseSearchData.php +++ b/app/Models/ReleaseSearchData.php @@ -8,6 +8,7 @@ use Illuminate\Database\Eloquent\Model; * App\Models\ReleaseSearchData. * * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSearchData newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSearchData newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSearchData query() diff --git a/app/Models/ReleaseSubtitle.php b/app/Models/ReleaseSubtitle.php index 78a222203..bf866a632 100644 --- a/app/Models/ReleaseSubtitle.php +++ b/app/Models/ReleaseSubtitle.php @@ -11,11 +11,13 @@ use Illuminate\Database\Eloquent\Model; * @property int $releases_id FK to releases.id * @property int $subsid * @property string $subslanguage + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSubtitle whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSubtitle whereReleasesId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSubtitle whereSubsid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSubtitle whereSubslanguage($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSubtitle newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSubtitle newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseSubtitle query() diff --git a/app/Models/ReleaseUnique.php b/app/Models/ReleaseUnique.php index 174924458..0f4f7186d 100644 --- a/app/Models/ReleaseUnique.php +++ b/app/Models/ReleaseUnique.php @@ -9,9 +9,11 @@ use Illuminate\Database\Eloquent\Model; * * @property int $releases_id FK to releases.id. * @property mixed $uniqueid Unique_ID from mediainfo. + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseUnique whereReleasesId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseUnique whereUniqueid($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseUnique newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseUnique newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleaseUnique query() diff --git a/app/Models/ReleasesGroup.php b/app/Models/ReleasesGroup.php index 1d5a58bbe..565186ebc 100644 --- a/app/Models/ReleasesGroup.php +++ b/app/Models/ReleasesGroup.php @@ -9,9 +9,11 @@ use Illuminate\Database\Eloquent\Model; * * @property int $releases_id FK to releases.id * @property int $groups_id FK to groups.id + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroup whereGroupsId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroup whereReleasesId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroup newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroup newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroup query() diff --git a/app/Models/ReleasesGroups.php b/app/Models/ReleasesGroups.php index 9db9c5300..6c2150f45 100644 --- a/app/Models/ReleasesGroups.php +++ b/app/Models/ReleasesGroups.php @@ -13,6 +13,7 @@ * not, see:. * * @link . + * * @author niel * @copyright 2016 nZEDb */ @@ -27,9 +28,11 @@ use Illuminate\Database\Eloquent\Model; * @property int $releases_id FK to releases.id * @property int $groups_id FK to groups.id * @property-read \App\Models\Release $release + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroups whereGroupsId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroups whereReleasesId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroups newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroups newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ReleasesGroups query() diff --git a/app/Models/RoleExpirationEmail.php b/app/Models/RoleExpirationEmail.php index c00f19025..fc1f7544b 100644 --- a/app/Models/RoleExpirationEmail.php +++ b/app/Models/RoleExpirationEmail.php @@ -15,6 +15,7 @@ use Illuminate\Database\Eloquent\Model; * @property int $week * @property int $month * @property-read \App\Models\User $user + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\RoleExpirationEmail newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\RoleExpirationEmail newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\RoleExpirationEmail query() diff --git a/app/Models/RootCategory.php b/app/Models/RootCategory.php index 2e78997a2..7dbc9d47d 100644 --- a/app/Models/RootCategory.php +++ b/app/Models/RootCategory.php @@ -14,6 +14,7 @@ use Illuminate\Database\Eloquent\Model; * @property \Illuminate\Support\Carbon|null $created_at * @property \Illuminate\Support\Carbon|null $updated_at * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Category[] $categories + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\RootCategory newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\RootCategory newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\RootCategory query() diff --git a/app/Models/Settings.php b/app/Models/Settings.php index 7f0156bf3..c6300da64 100644 --- a/app/Models/Settings.php +++ b/app/Models/Settings.php @@ -13,6 +13,7 @@ * not, see:. * * @link . + * * @author niel * @author DariusIII * @copyright 2016 nZEDb, 2017 NNTmux @@ -33,6 +34,7 @@ use Illuminate\Support\Facades\DB; * @property string $value * @property string $hint * @property string $setting + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereHint($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereName($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereSection($value) @@ -40,6 +42,7 @@ use Illuminate\Support\Facades\DB; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereSubsection($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereValue($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings query() @@ -115,7 +118,7 @@ class Settings extends Model /** * Adapted from https://laravel.io/forum/01-15-2016-overriding-eloquent-attributes. * - * @param string $key + * @param string $key * @return mixed */ public function __get($key) @@ -135,9 +138,10 @@ class Settings extends Model /** * Return a tree-like array of all or selected settings. * - * @param bool $excludeUnsectioned If rows with empty 'section' field should be excluded. - * Note this doesn't prevent empty 'subsection' fields. + * @param bool $excludeUnsectioned If rows with empty 'section' field should be excluded. + * Note this doesn't prevent empty 'subsection' fields. * @return array + * * @throws \RuntimeException */ public static function toTree($excludeUnsectioned = true): array @@ -163,7 +167,6 @@ class Settings extends Model /** * @param $setting - * * @return mixed */ public static function settingValue($setting) @@ -191,10 +194,9 @@ class Settings extends Model } /** - * @param string $requiredVersion The minimum version to compare against - * - * @return bool|null TRUE if Db version is greater than or eaqual to $requiredVersion, - * false if not, and null if the version isn't available to check against. + * @param string $requiredVersion The minimum version to compare against + * @return bool|null TRUE if Db version is greater than or eaqual to $requiredVersion, + * false if not, and null if the version isn't available to check against. */ public function isDbVersionAtLeast($requiredVersion): ?bool { @@ -220,7 +222,7 @@ class Settings extends Model } /** - * @param array $data + * @param array $data */ public static function settingsUpdate(array $data = []) { diff --git a/app/Models/Sharing.php b/app/Models/Sharing.php index f493b85ea..a4defe2c9 100644 --- a/app/Models/Sharing.php +++ b/app/Models/Sharing.php @@ -20,6 +20,7 @@ use Illuminate\Database\Eloquent\Model; * @property int $max_push * @property int $max_download * @property int $max_pull + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Sharing whereAutoEnable($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Sharing whereEnabled($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Sharing whereFetching($value) @@ -34,6 +35,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Sharing whereStartPosition($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Sharing whereUsername($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Sharing newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Sharing newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Sharing query() diff --git a/app/Models/SharingSite.php b/app/Models/SharingSite.php index 1617eda1d..7ce60bd02 100644 --- a/app/Models/SharingSite.php +++ b/app/Models/SharingSite.php @@ -14,6 +14,7 @@ use Illuminate\Database\Eloquent\Model; * @property string|null $first_time * @property bool $enabled * @property int $comments + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SharingSite whereComments($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SharingSite whereEnabled($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SharingSite whereFirstTime($value) @@ -22,6 +23,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SharingSite whereSiteGuid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SharingSite whereSiteName($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SharingSite newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SharingSite newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SharingSite query() diff --git a/app/Models/ShortGroup.php b/app/Models/ShortGroup.php index fb601cc1b..7c812f604 100644 --- a/app/Models/ShortGroup.php +++ b/app/Models/ShortGroup.php @@ -12,12 +12,14 @@ use Illuminate\Database\Eloquent\Model; * @property int $first_record * @property int $last_record * @property string|null $updated + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ShortGroup whereFirstRecord($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ShortGroup whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ShortGroup whereLastRecord($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ShortGroup whereName($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ShortGroup whereUpdated($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ShortGroup newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ShortGroup newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\ShortGroup query() diff --git a/app/Models/SteamApp.php b/app/Models/SteamApp.php index d79aba8be..bdc42d209 100644 --- a/app/Models/SteamApp.php +++ b/app/Models/SteamApp.php @@ -10,9 +10,11 @@ use Laravel\Scout\Searchable; * * @property string $name Steam application name * @property int $appid Steam application id + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SteamApp whereAppid($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SteamApp whereName($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SteamApp newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SteamApp newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\SteamApp query() diff --git a/app/Models/TvEpisode.php b/app/Models/TvEpisode.php index 9633e3cab..537fa0936 100644 --- a/app/Models/TvEpisode.php +++ b/app/Models/TvEpisode.php @@ -17,6 +17,7 @@ use Illuminate\Database\Eloquent\Model; * @property string $summary Description/summary of the episode. * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Release[] $release * @property-read \App\Models\Video $video + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvEpisode whereEpisode($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvEpisode whereFirstaired($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvEpisode whereId($value) @@ -26,6 +27,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvEpisode whereTitle($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvEpisode whereVideosId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvEpisode newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvEpisode newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvEpisode query() diff --git a/app/Models/TvInfo.php b/app/Models/TvInfo.php index 17e0f2419..be2239451 100644 --- a/app/Models/TvInfo.php +++ b/app/Models/TvInfo.php @@ -12,12 +12,14 @@ use Illuminate\Database\Eloquent\Model; * @property string $publisher The channel/network of production/release (ABC, BBC, Showtime, etc.). * @property string $localzone The linux tz style identifier * @property bool $image Does the video have a cover image? + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvInfo whereImage($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvInfo whereLocalzone($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvInfo wherePublisher($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvInfo whereSummary($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvInfo whereVideosId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvInfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvInfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\TvInfo query() diff --git a/app/Models/UsenetGroup.php b/app/Models/UsenetGroup.php index 830a4c34a..16578af4f 100644 --- a/app/Models/UsenetGroup.php +++ b/app/Models/UsenetGroup.php @@ -27,6 +27,7 @@ use Illuminate\Support\Facades\DB; * @property bool $backfill * @property string|null $description * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Release[] $release + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsenetGroup whereActive($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsenetGroup whereBackfill($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsenetGroup whereBackfillTarget($value) @@ -41,6 +42,7 @@ use Illuminate\Support\Facades\DB; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsenetGroup whereMinsizetoformrelease($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsenetGroup whereName($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsenetGroup newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsenetGroup newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsenetGroup query() @@ -184,8 +186,7 @@ class UsenetGroup extends Model /** * Get a group name using its ID. * - * @param int|string $id The group ID. - * + * @param int|string $id The group ID. * @return string Empty string on failure, groupName on success. */ public static function getNameByID($id): string @@ -198,8 +199,7 @@ class UsenetGroup extends Model /** * Get a group ID using its name. * - * @param string $name The group name. - * + * @param string $name The group name. * @return false|int false on failure, groups_id on success. */ public static function getIDByName($name) @@ -212,9 +212,8 @@ class UsenetGroup extends Model /** * Gets a count of all groups in the table limited by parameters. * - * @param string $groupname Constrain query to specific group name - * @param int $active Constrain query to active status - * + * @param string $groupname Constrain query to specific group name + * @param int $active Constrain query to active status * @return mixed */ public static function getGroupsCount($groupname = '', $active = -1) @@ -233,9 +232,8 @@ class UsenetGroup extends Model } /** - * @param string $groupname - * @param null $active - * + * @param string $groupname + * @param null $active * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator */ public static function getGroupsRange($groupname = '', $active = null) @@ -260,7 +258,6 @@ class UsenetGroup extends Model * * * @param $group - * * @return int */ public static function updateGroup($group) @@ -284,8 +281,7 @@ class UsenetGroup extends Model /** * Checks group name is standard and replaces any shorthand prefixes. * - * @param string $groupName The full name of the usenet group being evaluated - * + * @param string $groupName The full name of the usenet group being evaluated * @return string|bool The name of the group replacing shorthand prefix or false if groupname was malformed */ public static function isValidGroup($groupName) @@ -327,9 +323,9 @@ class UsenetGroup extends Model /** * Delete a group. * - * @param int|string $id ID of the group. - * + * @param int|string $id ID of the group. * @return bool + * * @throws \Exception */ public static function deleteGroup($id): bool @@ -342,9 +338,9 @@ class UsenetGroup extends Model /** * Reset a group. * - * @param string|int $id The group ID. - * + * @param string|int $id The group ID. * @return bool + * * @throws \Exception */ public static function reset($id): bool @@ -395,7 +391,8 @@ class UsenetGroup extends Model /** * Purge a single group or all groups. * - * @param int|string|bool $id The group ID. If false, purge all groups. + * @param int|string|bool $id The group ID. If false, purge all groups. + * * @throws \Exception */ public static function purge($id = false) @@ -432,11 +429,11 @@ class UsenetGroup extends Model /** * Adds new newsgroups based on a regular expression match against USP available. * - * @param string $groupList - * @param int $active - * @param int $backfill - * + * @param string $groupList + * @param int $active + * @param int $backfill * @return array|string + * * @throws \Exception */ public static function addBulk($groupList, $active = 1, $backfill = 1) @@ -487,10 +484,9 @@ class UsenetGroup extends Model /** * Updates the group active/backfill status. * - * @param int $id Which group ID - * @param string $column Which column active/backfill - * @param int $status Which status we are setting - * + * @param int $id Which group ID + * @param string $column Which column active/backfill + * @param int $status Which status we are setting * @return string */ public static function updateGroupStatus($id, $column, $status = 0): string @@ -507,7 +503,7 @@ class UsenetGroup extends Model /** * Disable group that does not exist on USP server. * - * @param int $id The Group ID to disable + * @param int $id The Group ID to disable */ public static function disableIfNotExist($id): void { diff --git a/app/Models/User.php b/app/Models/User.php index c1aecd116..b6fdbfe45 100644 --- a/app/Models/User.php +++ b/app/Models/User.php @@ -75,6 +75,7 @@ use Spatie\Permission\Traits\HasRoles; * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\UsersRelease[] $release * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\UserRequest[] $request * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\UserSerie[] $series + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\User whereApiaccess($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\User whereBookview($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\User whereConsoleview($value) @@ -118,6 +119,7 @@ use Spatie\Permission\Traits\HasRoles; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\User whereVerified($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\User whereApiToken($value) * @mixin \Eloquent + * * @property int $roles_id FK to roles.id * @property string $api_token * @property int $rate_limit @@ -130,6 +132,7 @@ use Spatie\Permission\Traits\HasRoles; * @property-read \Illuminate\Database\Eloquent\Collection|\Spatie\Permission\Models\Permission[] $permissions * @property-read \Spatie\Permission\Models\Role $role * @property-read \Illuminate\Database\Eloquent\Collection|\Spatie\Permission\Models\Role[] $roles + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\User newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\User newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\User permission($permissions) @@ -251,6 +254,7 @@ class User extends Authenticatable /** * @param $id + * * @throws \Exception */ public static function deleteUser($id): void @@ -259,10 +263,10 @@ class User extends Authenticatable } /** - * @param string $role - * @param string $username - * @param string $host - * @param string $email + * @param string $role + * @param string $username + * @param string $host + * @param string $email * @return int */ public static function getCount($role = '', $username = '', $host = '', $email = ''): int @@ -289,34 +293,34 @@ class User extends Authenticatable } /** - * @param int $id - * @param string $userName - * @param string $email - * @param int $grabs - * @param int $role - * @param string $notes - * @param int $invites - * @param int $movieview - * @param int $musicview - * @param int $gameview - * @param int $xxxview - * @param int $consoleview - * @param int $bookview - * @param string $queueType - * @param string $nzbgetURL - * @param string $nzbgetUsername - * @param string $nzbgetPassword - * @param string $saburl - * @param string $sabapikey - * @param string $sabpriority - * @param string $sabapikeytype - * @param bool $nzbvortexServerUrl - * @param bool $nzbvortexApiKey - * @param bool $cp_url - * @param bool $cp_api - * @param string $style - * + * @param int $id + * @param string $userName + * @param string $email + * @param int $grabs + * @param int $role + * @param string $notes + * @param int $invites + * @param int $movieview + * @param int $musicview + * @param int $gameview + * @param int $xxxview + * @param int $consoleview + * @param int $bookview + * @param string $queueType + * @param string $nzbgetURL + * @param string $nzbgetUsername + * @param string $nzbgetPassword + * @param string $saburl + * @param string $sabapikey + * @param string $sabpriority + * @param string $sabapikeytype + * @param bool $nzbvortexServerUrl + * @param bool $nzbvortexApiKey + * @param bool $cp_url + * @param bool $cp_api + * @param string $style * @return int + * * @throws \Illuminate\Database\Eloquent\ModelNotFoundException */ public static function updateUser($id, $userName, $email, $grabs, $role, $notes, $invites, $movieview, $musicview, $gameview, $xxxview, $consoleview, $bookview, $queueType = '', $nzbgetURL = '', $nzbgetUsername = '', $nzbgetPassword = '', $saburl = '', $sabapikey = '', $sabpriority = '', $sabapikeytype = '', $nzbvortexServerUrl = false, $nzbvortexApiKey = false, $cp_url = false, $cp_api = false, $style = 'None'): int @@ -366,7 +370,7 @@ class User extends Authenticatable } /** - * @param string $userName + * @param string $userName * @return \Illuminate\Database\Eloquent\Model|null|static */ public static function getByUsername(string $userName) @@ -375,9 +379,9 @@ class User extends Authenticatable } /** - * @param string $email - * + * @param string $email * @return \Illuminate\Database\Eloquent\Model|static + * * @throws \Illuminate\Database\Eloquent\ModelNotFoundException */ public static function getByEmail(string $email) @@ -386,9 +390,8 @@ class User extends Authenticatable } /** - * @param int $uid - * @param int $role - * + * @param int $uid + * @param int $role * @return bool */ public static function updateUserRole(int $uid, int $role) @@ -403,9 +406,9 @@ class User extends Authenticatable } /** - * @param int $uid + * @param int $uid * @param $date - * @param int $addYear + * @param int $addYear */ public static function updateUserRoleChangeDate($uid, $date = '', $addYear = 0): void { @@ -443,16 +446,16 @@ class User extends Authenticatable } /** - * @param $start - * @param $offset - * @param $orderBy - * @param string $userName - * @param string $email - * @param string $host - * @param string $role - * @param bool $apiRequests - * + * @param $start + * @param $offset + * @param $orderBy + * @param string $userName + * @param string $email + * @param string $host + * @param string $role + * @param bool $apiRequests * @return \Illuminate\Database\Eloquent\Collection + * * @throws \Throwable */ public static function getRange($start, $offset, $orderBy, $userName = '', $email = '', $host = '', $role = '', $apiRequests = false) @@ -496,7 +499,6 @@ class User extends Authenticatable * Get sort types for sorting users on the web page user list. * * @param $orderBy - * * @return string[] */ public static function getBrowseOrder($orderBy): array @@ -545,10 +547,9 @@ class User extends Authenticatable * * Automatically update the hash if it needs to be. * - * @param string $password Password to check against hash. - * @param string|bool $hash Hash to check against password. - * @param int $userID ID of the user. - * + * @param string $password Password to check against hash. + * @param string|bool $hash Hash to check against password. + * @param int $userID ID of the user. * @return bool */ public static function checkPassword($password, $hash, $userID = -1): bool @@ -571,7 +572,6 @@ class User extends Authenticatable /** * @param $uid - * * @return int */ public static function updateRssKey($uid): int @@ -584,7 +584,6 @@ class User extends Authenticatable /** * @param $id * @param $guid - * * @return int */ public static function updatePassResetGuid($id, $guid): int @@ -595,9 +594,8 @@ class User extends Authenticatable } /** - * @param int $id - * @param string $password - * + * @param int $id + * @param string $password * @return int */ public static function updatePassword(int $id, string $password): int @@ -618,8 +616,8 @@ class User extends Authenticatable /** * @param $guid - * * @return \Illuminate\Database\Eloquent\Model|static + * * @throws \Illuminate\Database\Eloquent\ModelNotFoundException */ public static function getByPassResetGuid(string $guid) @@ -628,8 +626,8 @@ class User extends Authenticatable } /** - * @param $id - * @param int $num + * @param $id + * @param int $num */ public static function incrementGrabs(int $id, $num = 1): void { @@ -642,7 +640,6 @@ class User extends Authenticatable * * @param $userID * @param $rssToken - * * @return bool|\Illuminate\Database\Eloquent\Model|null|static */ public static function getByIdAndRssToken($userID, $rssToken) @@ -656,7 +653,7 @@ class User extends Authenticatable } /** - * @param string $rssToken + * @param string $rssToken * @return \Illuminate\Database\Eloquent\Model|null|static */ public static function getByRssToken(string $rssToken) @@ -666,7 +663,6 @@ class User extends Authenticatable /** * @param $url - * * @return bool */ public static function isValidUrl($url): bool @@ -686,9 +682,9 @@ class User extends Authenticatable } /** - * @param int $length - * + * @param int $length * @return string + * * @throws \Exception */ public static function generatePassword($length = 15): string @@ -699,18 +695,18 @@ class User extends Authenticatable /** * Register a new user. * - * @param $userName - * @param $password - * @param $email - * @param $host - * @param $notes - * @param int $invites - * @param string $inviteCode - * @param bool $forceInviteMode - * - * @param int $role - * @param bool $validate + * @param $userName + * @param $password + * @param $email + * @param $host + * @param $notes + * @param int $invites + * @param string $inviteCode + * @param bool $forceInviteMode + * @param int $role + * @param bool $validate * @return bool|int|string + * * @throws \Exception */ public static function signUp($userName, $password, $email, $host, $notes, $invites = Invitation::DEFAULT_INVITES, $inviteCode = '', $forceInviteMode = false, $role = self::ROLE_USER, $validate = true) @@ -754,8 +750,7 @@ class User extends Authenticatable /** * If a invite is used, decrement the person who invited's invite count. * - * @param string $inviteCode - * + * @param string $inviteCode * @return int */ public static function checkAndUseInvite(string $inviteCode): int @@ -774,16 +769,16 @@ class User extends Authenticatable /** * Add a new user. * - * @param string $userName - * @param string $password - * @param string $email - * @param int $role - * @param string $notes - * @param string $host - * @param int $invites - * @param int $invitedBy - * + * @param string $userName + * @param string $password + * @param string $email + * @param int $role + * @param string $notes + * @param string $host + * @param int $invites + * @param int $invitedBy * @return bool|int + * * @throws \Exception */ public static function add($userName, $password, $email, $role, $notes = '', $host = '', $invites = Invitation::DEFAULT_INVITES, $invitedBy = 0) @@ -814,9 +809,9 @@ class User extends Authenticatable /** * Get the list of categories the user has excluded. * - * @param int $userID ID of the user. - * + * @param int $userID ID of the user. * @return array + * * @throws \Exception */ public static function getCategoryExclusionById($userID): array @@ -871,8 +866,9 @@ class User extends Authenticatable } /** - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @return array + * * @throws \Exception */ public static function getCategoryExclusionForApi(Request $request): array @@ -903,8 +899,8 @@ class User extends Authenticatable * @param $serverUrl * @param $uid * @param $emailTo - * * @return string + * * @throws \Exception */ public static function sendInvite($serverUrl, $uid, $emailTo): string @@ -925,7 +921,8 @@ class User extends Authenticatable * the download/request rows must remain for at least one day to allow the role based * limits to apply. * - * @param int $days + * @param int $days + * * @throws \Exception */ public static function pruneRequestHistory($days = 0): void diff --git a/app/Models/UserDownload.php b/app/Models/UserDownload.php index 232254a2c..32113761a 100644 --- a/app/Models/UserDownload.php +++ b/app/Models/UserDownload.php @@ -14,12 +14,14 @@ use Illuminate\Database\Eloquent\Model; * @property int $releases_id FK to releases.id * @property-read \App\Models\Release $release * @property-read \App\Models\User $user + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserDownload whereHosthash($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserDownload whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserDownload whereReleasesId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserDownload whereTimestamp($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserDownload whereUsersId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserDownload newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserDownload newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserDownload query() @@ -60,9 +62,9 @@ class UserDownload extends Model /** * Get the COUNT of how many NZB's the user has downloaded in the past day. * - * @param int $userID - * + * @param int $userID * @return int + * * @throws \Exception */ public static function getDownloadRequests($userID): int @@ -89,7 +91,6 @@ class UserDownload extends Model * * @param $userID * @param $releaseID - * * @return int|\Illuminate\Database\Eloquent\Builder */ public static function addDownloadRequest($userID, $releaseID) @@ -105,8 +106,9 @@ class UserDownload extends Model } /** - * @param int $releaseID + * @param int $releaseID * @return mixed + * * @throws \Exception */ public static function delDownloadRequestsForRelease(int $releaseID) @@ -116,6 +118,7 @@ class UserDownload extends Model /** * @param $userID + * * @throws \Exception */ public static function delDownloadRequests($userID): void diff --git a/app/Models/UserMovie.php b/app/Models/UserMovie.php index 9c6dcc634..028801a41 100644 --- a/app/Models/UserMovie.php +++ b/app/Models/UserMovie.php @@ -13,6 +13,7 @@ use Illuminate\Database\Eloquent\Model; * @property string|null $categories List of categories for user movies * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserMovie whereCategories($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserMovie whereCreatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserMovie whereId($value) @@ -20,6 +21,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserMovie whereUpdatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserMovie whereUsersId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserMovie newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserMovie newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserMovie query() @@ -37,10 +39,9 @@ class UserMovie extends Model protected $dateFormat = false; /** - * @param $uid - * @param $imdbid - * @param array $catID - * + * @param $uid + * @param $imdbid + * @param array $catID * @return int|\Illuminate\Database\Eloquent\Builder */ public static function addMovie($uid, $imdbid, array $catID = []) @@ -105,7 +106,7 @@ class UserMovie extends Model /** * @param $uid * @param $imdbid - * @param array $catID + * @param array $catID */ public static function updateMovie($uid, $imdbid, array $catID = []) { diff --git a/app/Models/UserRequest.php b/app/Models/UserRequest.php index a2eba1cfb..35edd7382 100644 --- a/app/Models/UserRequest.php +++ b/app/Models/UserRequest.php @@ -14,12 +14,14 @@ use Illuminate\Support\Facades\DB; * @property string $request * @property string $timestamp * @property-read \App\Models\User $user + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserRequest whereHosthash($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserRequest whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserRequest whereRequest($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserRequest whereTimestamp($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserRequest whereUsersId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserRequest newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserRequest newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserRequest query() @@ -69,9 +71,9 @@ class UserRequest extends Model /** * Get the quantity of API requests in the last day for the users_id. * - * @param int $userID - * + * @param int $userID * @return int + * * @throws \Exception * @throws \Throwable */ @@ -87,8 +89,8 @@ class UserRequest extends Model /** * If a user accesses the API, log it. * - * @param string $token API token of the user - * @param string $request The API request. + * @param string $token API token of the user + * @param string $request The API request. */ public static function addApiRequest($token, $request): void { @@ -99,11 +101,11 @@ class UserRequest extends Model /** * Delete api requests older than a day. * - * @param int|bool $userID - * int The users ID. - * bool false do all user ID's.. - * + * @param int|bool $userID + * int The users ID. + * bool false do all user ID's.. * @return void + * * @throws \Exception * @throws \Throwable */ diff --git a/app/Models/UserSerie.php b/app/Models/UserSerie.php index 83391057c..89c427b17 100644 --- a/app/Models/UserSerie.php +++ b/app/Models/UserSerie.php @@ -14,6 +14,7 @@ use Illuminate\Database\Eloquent\Model; * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at * @property-read \App\Models\User $user + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserSerie whereCategories($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserSerie whereCreatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserSerie whereId($value) @@ -21,6 +22,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserSerie whereUsersId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserSerie whereVideosId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserSerie newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserSerie newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UserSerie query() @@ -51,7 +53,7 @@ class UserSerie extends Model * * @param $userId * @param $videoId - * @param array $catID + * @param array $catID * @return int|\Illuminate\Database\Eloquent\Builder */ public static function addShow($userId, $videoId, array $catID = []) @@ -137,9 +139,9 @@ class UserSerie extends Model /** * Update a TV show category ID for a user's "my show" TV show. * - * @param $users_id - * @param $videos_id - * @param array $catID List of category ID's. + * @param $users_id + * @param $videos_id + * @param array $catID List of category ID's. */ public static function updateShow($users_id, $videos_id, array $catID = []): void { diff --git a/app/Models/UsersRelease.php b/app/Models/UsersRelease.php index d77d4f82b..1c51a7712 100644 --- a/app/Models/UsersRelease.php +++ b/app/Models/UsersRelease.php @@ -14,12 +14,14 @@ use Illuminate\Database\Eloquent\Model; * @property \Carbon\Carbon|null $updated_at * @property-read \App\Models\Release $release * @property-read \App\Models\User $user + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsersRelease whereCreatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsersRelease whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsersRelease whereReleasesId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsersRelease whereUpdatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsersRelease whereUsersId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsersRelease newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsersRelease newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\UsersRelease query() @@ -57,7 +59,6 @@ class UsersRelease extends Model /** * @param $uid * @param $releaseid - * * @return int|\Illuminate\Database\Eloquent\Builder */ public static function addCart($uid, $releaseid) diff --git a/app/Models/Video.php b/app/Models/Video.php index 9c7cb09d9..7fbef4733 100644 --- a/app/Models/Video.php +++ b/app/Models/Video.php @@ -23,6 +23,7 @@ use Illuminate\Database\Eloquent\Model; * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\VideoAlias[] $alias * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\TvEpisode[] $episode * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Release[] $release + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Video whereAnidb($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Video whereCountriesId($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Video whereId($value) @@ -37,6 +38,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Video whereTvrage($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Video whereType($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Video newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Video newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Video query() @@ -87,7 +89,6 @@ class Video extends Model * * * @param $id - * * @return \Illuminate\Database\Eloquent\Model|null|static */ public static function getByVideoID($id) @@ -103,7 +104,7 @@ class Video extends Model * Retrieves a range of all shows for the show-edit admin list. * * - * @param string $showname + * @param string $showname * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator */ public static function getRange($showname = '') @@ -123,7 +124,7 @@ class Video extends Model * Returns a count of all shows -- usually used by pager. * * - * @param string $showname + * @param string $showname * @return int */ public static function getCount($showname = ''): int @@ -140,10 +141,9 @@ class Video extends Model /** * Retrieves and returns a list of shows with eligible releases. * - * @param $uid - * @param string $letter - * @param string $showname - * + * @param $uid + * @param string $letter + * @param string $showname * @return array */ public static function getSeriesList($uid, $letter = '', $showname = ''): array diff --git a/app/Models/VideoAlias.php b/app/Models/VideoAlias.php index 6323f0fcc..af34a2516 100644 --- a/app/Models/VideoAlias.php +++ b/app/Models/VideoAlias.php @@ -10,9 +10,11 @@ use Illuminate\Database\Eloquent\Model; * @property int $videos_id FK to videos.id of the parent title. * @property string $title AKA of the video. * @property-read \App\Models\Video $video + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoAlias whereTitle($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoAlias whereVideosId($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoAlias newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoAlias newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoAlias query() diff --git a/app/Models/VideoData.php b/app/Models/VideoData.php index 8f1d6ab7d..033fd60f4 100644 --- a/app/Models/VideoData.php +++ b/app/Models/VideoData.php @@ -18,6 +18,7 @@ use Illuminate\Database\Eloquent\Model; * @property string|null $videoaspect * @property float|null $videoframerate * @property string|null $videolibrary + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoData whereContainerformat($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoData whereOverallbitrate($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoData whereReleasesId($value) @@ -30,6 +31,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoData whereVideolibrary($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoData whereVideowidth($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoData newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoData newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\VideoData query() diff --git a/app/Models/XxxInfo.php b/app/Models/XxxInfo.php index 9b67c592c..607129d9a 100644 --- a/app/Models/XxxInfo.php +++ b/app/Models/XxxInfo.php @@ -23,6 +23,7 @@ use Illuminate\Database\Eloquent\Model; * @property bool $backdrop * @property \Carbon\Carbon|null $created_at * @property \Carbon\Carbon|null $updated_at + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\XxxInfo whereActors($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\XxxInfo whereBackdrop($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\XxxInfo whereClassused($value) @@ -40,6 +41,7 @@ use Illuminate\Database\Eloquent\Model; * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\XxxInfo whereTrailers($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\XxxInfo whereUpdatedAt($value) * @mixin \Eloquent + * * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\XxxInfo newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\XxxInfo newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\XxxInfo query() diff --git a/app/Observers/UserServiceObserver.php b/app/Observers/UserServiceObserver.php index c6d8e9793..773551d33 100644 --- a/app/Observers/UserServiceObserver.php +++ b/app/Observers/UserServiceObserver.php @@ -16,9 +16,9 @@ class UserServiceObserver /** * Handle the user "created" event. * - * @param \App\Models\User $user - * + * @param \App\Models\User $user * @return void + * * @throws \Jrean\UserVerification\Exceptions\ModelNotCompliantException */ public function created(User $user) diff --git a/app/Support/Google2FAAuthenticator.php b/app/Support/Google2FAAuthenticator.php index 29bcb2963..bf39aa75a 100644 --- a/app/Support/Google2FAAuthenticator.php +++ b/app/Support/Google2FAAuthenticator.php @@ -25,6 +25,7 @@ class Google2FAAuthenticator extends Authenticator /** * @return mixed + * * @throws \PragmaRX\Google2FALaravel\Exceptions\InvalidSecretKey */ protected function getGoogle2FASecretKey() diff --git a/app/Transformers/ApiTransformer.php b/app/Transformers/ApiTransformer.php index 3199fbbed..17a44e5fa 100644 --- a/app/Transformers/ApiTransformer.php +++ b/app/Transformers/ApiTransformer.php @@ -22,7 +22,7 @@ class ApiTransformer extends TransformerAbstract } /** - * @param \App\Models\Release $releases + * @param \App\Models\Release $releases * @return array */ public function transform(Release $releases): array diff --git a/app/Transformers/CategoryTransformer.php b/app/Transformers/CategoryTransformer.php index b15741493..2b120d70b 100644 --- a/app/Transformers/CategoryTransformer.php +++ b/app/Transformers/CategoryTransformer.php @@ -10,7 +10,7 @@ class CategoryTransformer extends TransformerAbstract /** * A Fractal transformer. * - * @param \App\Models\RootCategory $category + * @param \App\Models\RootCategory $category * @return array */ public function transform(RootCategory $category): array diff --git a/app/Transformers/DetailsTransformer.php b/app/Transformers/DetailsTransformer.php index eb9876ac4..938bd7be2 100644 --- a/app/Transformers/DetailsTransformer.php +++ b/app/Transformers/DetailsTransformer.php @@ -24,8 +24,7 @@ class DetailsTransformer extends TransformerAbstract /** * A Fractal transformer. * - * @param \App\Models\Release $releases - * + * @param \App\Models\Release $releases * @return array */ public function transform(Release $releases): array diff --git a/cli/data/predb_import_daily_batch.php b/cli/data/predb_import_daily_batch.php index adc360896..ecc88ef28 100755 --- a/cli/data/predb_import_daily_batch.php +++ b/cli/data/predb_import_daily_batch.php @@ -15,6 +15,7 @@ * not, see: * * @link . + * * @author niel * @copyright 2015 nZEDb */ diff --git a/misc/testing/Dev/test_hash_algorithms.php b/misc/testing/Dev/test_hash_algorithms.php index 3990de487..ee431393b 100644 --- a/misc/testing/Dev/test_hash_algorithms.php +++ b/misc/testing/Dev/test_hash_algorithms.php @@ -22,26 +22,29 @@ class HashAlgorithms { /** * The input string. + * * @var string */ protected $_inputString; /** * The string we are expecting to get. + * * @var array */ protected $_expectedString; /** * Write results to file? + * * @var bool */ protected $_writeToFile; /** - * @param string $inputString - * @param string $expectedString - * @param bool $writeToFile + * @param string $inputString + * @param string $expectedString + * @param bool $writeToFile */ public function __construct($inputString, $expectedString, $writeToFile) { @@ -156,8 +159,7 @@ class HashAlgorithms /** * Return various versions of a input string to hash. * - * @param string $string - * + * @param string $string * @return array */ protected function _hashesToArray($string) diff --git a/misc/update/tmux/monitor.php b/misc/update/tmux/monitor.php index 96cd54445..5fa06e315 100644 --- a/misc/update/tmux/monitor.php +++ b/misc/update/tmux/monitor.php @@ -412,9 +412,8 @@ function errorOnSQL() } /** - * @param \PDOStatement $ps - * @param $table - * + * @param \PDOStatement $ps + * @param $table * @return bool|int|string */ function getTableRowCount(\PDOStatement $ps, $table)