The class Share has an overall complexity of 68 which is very high. The configured complexity threshold is 50. Open
class Share extends database_object
{
protected const DB_TABLENAME = 'share';
public const VALID_TYPES = array(
'album',
- Exclude checks
Share
has 21 functions (exceeds 20 allowed). Consider refactoring. Open
class Share extends database_object
{
protected const DB_TABLENAME = 'share';
public const VALID_TYPES = array(
'album',
The class Share has 16 fields. Consider redesigning Share to keep the number of fields under 15. Open
class Share extends database_object
{
protected const DB_TABLENAME = 'share';
public const VALID_TYPES = array(
'album',
- 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
Function is_valid
has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
public function is_valid($secret, $action): bool
{
if ($this->isNew()) {
debug_event(self::class, 'Access Denied: Invalid share.', 3);
- 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 is_shared_media
has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
public function is_shared_media($media_id): bool
{
$isShare = false;
switch ($this->object_type) {
case 'album':
- 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 show_action_buttons
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
public function show_action_buttons(): void
{
if ($this->isNew() === false) {
if ((!empty(Core::get_global('user')) && Core::get_global('user')->has_access(75)) || $this->user == (int)Core::get_global('user')->id) {
if ($this->allow_download) {
- 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 false;
Avoid too many return
statements within this method. Open
return false;
Avoid too many return
statements within this method. Open
return false;
Avoid too many return
statements within this method. Open
return true;
The method is_valid() has an NPath complexity of 1296. The configured NPath complexity threshold is 200. Open
public function is_valid($secret, $action): bool
{
if ($this->isNew()) {
debug_event(self::class, 'Access Denied: Invalid share.', 3);
- Read upRead up
- Exclude checks
NPathComplexity
Since: 0.1
The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.
Example
class Foo {
function bar() {
// lots of complicated code
}
}
Source https://phpmd.org/rules/codesize.html#npathcomplexity
The method is_valid() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10. Open
public function is_valid($secret, $action): bool
{
if ($this->isNew()) {
debug_event(self::class, 'Access Denied: Invalid share.', 3);
- 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 get_expiry uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
// fall back to config defaults
$expire_days = AmpConfig::get('share_expire', 7);
}
- 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
syntax error, unexpected 'int' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST)
Open
public int $id = 0;
- Exclude checks
The parameter $media_id is not named in camelCase. Open
public function is_shared_media($media_id): bool
{
$isShare = false;
switch ($this->object_type) {
case 'album':
- 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 $share_id is not named in camelCase. Open
public function __construct($share_id = 0)
{
if (!$share_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 $object_id is not named in camelCase. Open
public static function display_ui($object_type, $object_id, $show_text = true): string
{
$result = sprintf(
'<a onclick="showShareDialog(event, \'%s\', %d);">%s',
$object_type,
- 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 $share_id is not named in camelCase. Open
public static function get_url($share_id, $secret): string
{
$url = AmpConfig::get('web_path') . '/share.php?id=' . $share_id;
if (!empty($secret)) {
$url .= '&secret=' . $secret;
- 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 $show_text is not named in camelCase. Open
public static function display_ui($object_type, $object_id, $show_text = true): string
{
$result = sprintf(
'<a onclick="showShareDialog(event, \'%s\', %d);">%s',
$object_type,
- 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
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 $object_type is not named in camelCase. Open
public static function display_ui($object_type, $object_id, $show_text = true): string
{
$result = sprintf(
'<a onclick="showShareDialog(event, \'%s\', %d);">%s',
$object_type,
- 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) {
}
}