File Video.php
has 778 lines of code (exceeds 500 allowed). Consider refactoring. Open
<?php
declare(strict_types=0);
/**
Video
has 53 functions (exceeds 20 allowed). Consider refactoring. Open
class Video extends database_object implements
Media,
library_item,
GarbageCollectibleInterface,
CatalogItemInterface
The class Video has an overall complexity of 136 which is very high. The configured complexity threshold is 50. Open
class Video extends database_object implements
Media,
library_item,
GarbageCollectibleInterface,
CatalogItemInterface
- Exclude checks
The class Video has 18 public methods. Consider refactoring Video to keep number of public methods under 10. Open
class Video extends database_object implements
Media,
library_item,
GarbageCollectibleInterface,
CatalogItemInterface
- Read upRead up
- Exclude checks
TooManyPublicMethods
Since: 0.1
A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
By default it ignores methods starting with 'get' or 'set'.
Example
Source https://phpmd.org/rules/codesize.html#toomanypublicmethods
The class Video has 44 fields. Consider redesigning Video to keep the number of fields under 15. Open
class Video extends database_object implements
Media,
library_item,
GarbageCollectibleInterface,
CatalogItemInterface
- Read upRead up
- Exclude checks
TooManyFields
Since: 0.1
Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.
Example
class Person {
protected $one;
private $two;
private $three;
[... many more fields ...]
}
Source https://phpmd.org/rules/codesize.html#toomanyfields
The class Video has 90 public methods and attributes. Consider reducing the number of public items to less than 45. Open
class Video extends database_object implements
Media,
library_item,
GarbageCollectibleInterface,
CatalogItemInterface
- Read upRead up
- Exclude checks
ExcessivePublicCount
Since: 0.1
A large number of public methods and attributes declared in a class can indicate the class may need to be broken up as increased effort will be required to thoroughly test it.
Example
public class Foo {
public $value;
public $something;
public $var;
// [... more more public attributes ...]
public function doWork() {}
public function doMoreWork() {}
public function doWorkAgain() {}
// [... more more public methods ...]
}
Source https://phpmd.org/rules/codesize.html#excessivepubliccount
Function insert
has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
public static function insert(array $data, ?array $gtypes = array(), ?array $options = array()): int
{
$check_file = Catalog::get_id_from_file($data['file'], 'video');
if ($check_file > 0) {
return $check_file;
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Method play_url
has 5 arguments (exceeds 4 allowed). Consider refactoring. Open
public function play_url($additional_params = '', $player = '', $local = false, $uid = false, $streamToken = null): string
Function format
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
public function format($details = true): void
{
$this->get_f_link();
$this->f_codec = $this->video_codec . ' / ' . $this->audio_codec;
if ($this->resolution_x || $this->resolution_y) {
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Avoid too many return
statements within this method. Open
return 'video/webm';
Avoid too many return
statements within this method. Open
return 'video/quicktime';
Avoid too many return
statements within this method. Open
return 'video/x-divx';
Avoid too many return
statements within this method. Open
return 'video/mp2t';
Avoid too many return
statements within this method. Open
return 'video/mpeg';
Avoid too many return
statements within this method. Open
return $data['id'];
Avoid too many return
statements within this method. Open
return 'video/x-matroska';
Avoid too many return
statements within this method. Open
return 'video/x-flv';
Function remove
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
public function remove(): bool
{
if (file_exists($this->file)) {
$deleted = unlink($this->file);
} else {
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Function get_subtitles
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
public function get_subtitles(): array
{
$subtitles = array();
$pinfo = pathinfo($this->file);
$filter = $pinfo['dirname'] . DIRECTORY_SEPARATOR . $pinfo['filename'] . '*.srt';
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
The class Video has 1179 lines of code. Current threshold is 1000. Avoid really long classes. Open
class Video extends database_object implements
Media,
library_item,
GarbageCollectibleInterface,
CatalogItemInterface
- Exclude checks
The method get_language_name() has 191 lines of code. Current threshold is set to 100. Avoid really long methods. Open
protected function get_language_name($code): string
{
$languageCodes = array(
"aa" => T_("Afar"),
"ab" => T_("Abkhazian"),
- Exclude checks
The method insert() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. Open
public static function insert(array $data, ?array $gtypes = array(), ?array $options = array()): int
{
$check_file = Catalog::get_id_from_file($data['file'], 'video');
if ($check_file > 0) {
return $check_file;
- Read upRead up
- Exclude checks
CyclomaticComplexity
Since: 0.1
Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.
Example
// Cyclomatic Complexity = 11
class Foo {
1 public function example() {
2 if ($a == $b) {
3 if ($a1 == $b1) {
fiddle();
4 } elseif ($a2 == $b2) {
fiddle();
} else {
fiddle();
}
5 } elseif ($c == $d) {
6 while ($c == $d) {
fiddle();
}
7 } elseif ($e == $f) {
8 for ($n = 0; $n < $h; $n++) {
fiddle();
}
} else {
switch ($z) {
9 case 1:
fiddle();
break;
10 case 2:
fiddle();
break;
11 case 3:
fiddle();
break;
default:
fiddle();
break;
}
}
}
}
Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity
The method type_to_mime() has a Cyclomatic Complexity of 16. The configured cyclomatic complexity threshold is 10. Open
public static function type_to_mime($type): string
{
// FIXME: This should really be done the other way around.
// Store the mime type in the database, and provide a function
// to make it a human-friendly type.
- Read upRead up
- Exclude checks
CyclomaticComplexity
Since: 0.1
Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.
Example
// Cyclomatic Complexity = 11
class Foo {
1 public function example() {
2 if ($a == $b) {
3 if ($a1 == $b1) {
fiddle();
4 } elseif ($a2 == $b2) {
fiddle();
} else {
fiddle();
}
5 } elseif ($c == $d) {
6 while ($c == $d) {
fiddle();
}
7 } elseif ($e == $f) {
8 for ($n = 0; $n < $h; $n++) {
fiddle();
}
} else {
switch ($z) {
9 case 1:
fiddle();
break;
10 case 2:
fiddle();
break;
11 case 3:
fiddle();
break;
default:
fiddle();
break;
}
}
}
}
Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity
The class Video has a coupling between objects value of 24. Consider to reduce the number of dependencies under 13. Open
class Video extends database_object implements
Media,
library_item,
GarbageCollectibleInterface,
CatalogItemInterface
- Read upRead up
- Exclude checks
CouplingBetweenObjects
Since: 1.1.0
A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability
Example
class Foo {
/**
* @var \foo\bar\X
*/
private $x = null;
/**
* @var \foo\bar\Y
*/
private $y = null;
/**
* @var \foo\bar\Z
*/
private $z = null;
public function setFoo(\Foo $foo) {}
public function setBar(\Bar $bar) {}
public function setBaz(\Baz $baz) {}
/**
* @return \SplObjectStorage
* @throws \OutOfRangeException
* @throws \InvalidArgumentException
* @throws \ErrorException
*/
public function process(\Iterator $it) {}
// ...
}
Source https://phpmd.org/rules/design.html#couplingbetweenobjects
The method remove uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$deleted = true;
}
- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}
Source https://phpmd.org/rules/cleancode.html#elseexpression
The method remove uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
debug_event(self::class, 'Cannot delete ' . $this->file . ' file. Please check permissions.', 1);
}
- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}
Source https://phpmd.org/rules/cleancode.html#elseexpression
FIXME found Open
// FIXME: This should really be done the other way around.
- Exclude checks
syntax error, unexpected 'int' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST)
Open
public int $id = 0;
- Exclude checks
Similar blocks of code found in 4 locations. Consider refactoring. Open
public static function build_cache($ids): bool
{
if (empty($ids)) {
return false;
}
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 111.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Avoid variables with short names like $id. Configured minimum length is 3. Open
public int $id = 0;
- Read upRead up
- Exclude checks
ShortVariable
Since: 0.2
Detects when a field, local, or parameter has a very short name.
Example
class Something {
private $q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal
$r = 20 + $this->q; // VIOLATION - Local
for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
$r += $this->q;
}
}
}
Source https://phpmd.org/rules/naming.html#shortvariable
The parameter $video_id is not named in camelCase. Open
public function __construct($video_id = 0)
{
if (!$video_id) {
return;
}
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $song_id is not named in camelCase. Open
public static function update_played($new_played, $song_id): void
{
self::_update_item('played', ($new_played ? 1 : 0), $song_id, '25');
}
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $new_video is not named in camelCase. Open
public static function update_video($video_id, Video $new_video): void
{
$update_time = time();
$release_date = is_numeric($new_video->release_date) ? $new_video->release_date : null;
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $video_id is not named in camelCase. Open
public static function generate_preview($video_id, $overwrite = false): void
{
if ($overwrite || !Art::has_db($video_id, 'video', 'preview')) {
$artp = new Art($video_id, 'video', 'preview');
$video = new Video($video_id);
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $new_played is not named in camelCase. Open
public static function update_played($new_played, $song_id): void
{
self::_update_item('played', ($new_played ? 1 : 0), $song_id, '25');
}
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $additional_params is not named in camelCase. Open
public function play_url($additional_params = '', $player = '', $local = false, $uid = false, $streamToken = null): string
{
if ($this->isNew()) {
return '';
}
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $user_id is not named in camelCase. Open
public function set_played($user_id, $agent, $location, $date): bool
{
// ignore duplicates or skip the last track
if (!$this->check_play_history($user_id, $agent, $date)) {
return false;
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $lang_code is not named in camelCase. Open
public function get_subtitle_file($lang_code): string
{
$subtitle = '';
if ($lang_code == '__' || $this->get_language_name($lang_code)) {
$pinfo = pathinfo($this->file);
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $video_id is not named in camelCase. Open
public static function update_utime($video_id, $time = 0): void
{
if (!$time) {
$time = time();
}
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $video_id is not named in camelCase. Open
public static function create_from_id($video_id): Video
{
foreach (ObjectTypeToClassNameMapper::VIDEO_TYPES as $dtype) {
$sql = "SELECT `id` FROM `" . strtolower($dtype) . "` WHERE `id` = ?";
$db_results = Dba::read($sql, array($video_id));
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $video_id is not named in camelCase. Open
public static function update_video($video_id, Video $new_video): void
{
$update_time = time();
$release_date = is_numeric($new_video->release_date) ? $new_video->release_date : null;
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $video_id is not named in camelCase. Open
private static function _update_item($field, $value, $video_id, $level): bool
{
/* Check them Rights! */
if (!Access::check('interface', $level)) {
return false;
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $video_id is not named in camelCase. Open
public static function update_video_counts($video_id): void
{
if ($video_id > 0) {
$params = array($video_id);
$sql = "UPDATE `video` SET `total_count` = 0 WHERE `total_count` > 0 AND `id` NOT IN (SELECT `object_id` FROM `object_count` WHERE `object_count`.`object_id` = ? AND `object_count`.`object_type` = 'video' AND `object_count`.`count_type` = 'stream');";
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $new_video is not named in camelCase. Open
public static function compare_video_information(Video $video, Video $new_video): array
{
// Remove some stuff we don't care about
unset($video->catalog, $video->played, $video->enabled, $video->addition_time, $video->update_time, $video->type);
$string_array = array('title', 'tags');
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $filter_type is not named in camelCase. Open
public function get_medias(?string $filter_type = null): array
{
$medias = array();
if ($filter_type === null || $filter_type === 'video') {
$medias[] = array(
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
Method name "_update_item" should not be prefixed with an underscore to indicate visibility Open
private static function _update_item($field, $value, $video_id, $level): bool
- Exclude checks