Method unread
has 28 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function unread() {
if ($this->db instanceof \sql_db) {
$query = "SELECT DISTINCT privmsgs_id
FROM nuke_bbprivmsgs
WHERE privmsgs_to_userid = ".$this->db->real_escape_string($this->User->id)."
Function unread
has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
public function unread() {
if ($this->db instanceof \sql_db) {
$query = "SELECT DISTINCT privmsgs_id
FROM nuke_bbprivmsgs
WHERE privmsgs_to_userid = ".$this->db->real_escape_string($this->User->id)."
- 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
Missing class import via use statement (line '68', column '31'). Open
throw new \Exception($this->db->error."\n".$query);
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
The method __construct has a boolean flag argument $User, which is a certain sign of a Single Responsibility Principle violation. Open
public function __construct($User = false) {
- Read upRead up
- Exclude checks
BooleanArgumentFlag
Since: 1.4.0
A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.
Example
class Foo {
public function bar($flag = true) {
}
}
Source https://phpmd.org/rules/cleancode.html#booleanargumentflag
Missing class import via use statement (line '39', column '27'). Open
throw new \Exception("Cannot instantiate ".__CLASS__." - user object is empty or not loaded".printArray(debug_backtrace()));
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
The method unread uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
throw new \Exception($this->db->error."\n".$query);
return false;
}
- 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 unread uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$query = "SELECT DISTINCT privmsgs_id
FROM nuke_bbprivmsgs
WHERE privmsgs_to_userid = ?
AND privmsgs_type IN (?, ?)
- 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
Avoid assigning values to variables in if clauses and the like (line '59', column '21'). Open
public function unread() {
if ($this->db instanceof \sql_db) {
$query = "SELECT DISTINCT privmsgs_id
FROM nuke_bbprivmsgs
WHERE privmsgs_to_userid = ".$this->db->real_escape_string($this->User->id)."
- Read upRead up
- Exclude checks
IfStatementAssignment
Since: 2.7.0
Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.
Example
class Foo
{
public function bar($flag)
{
if ($foo = 'bar') { // possible typo
// ...
}
if ($baz = 0) { // always false
// ...
}
}
}
Source http://phpmd.org/rules/cleancode.html#ifstatementassignment
Similar blocks of code found in 2 locations. Consider refactoring. Open
while ($row = $rs->fetch_assoc()) {
$return[] = $row['privmsgs_id'];
}
- 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 24.
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
Similar blocks of code found in 2 locations. Consider refactoring. Open
$query = "SELECT DISTINCT privmsgs_id
FROM nuke_bbprivmsgs
WHERE privmsgs_to_userid = ".$this->db->real_escape_string($this->User->id)."
AND privmsgs_type IN (".PRIVMSGS_NEW_MAIL.", ".PRIVMSGS_UNREAD_MAIL.")
- 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 21.
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
The parameter $User is not named in camelCase. Open
public function __construct($User = false) {
parent::__construct();
if (!$User || !$User->id || $User->id == NULL || empty($User->id)) {
throw new \Exception("Cannot instantiate ".__CLASS__." - user object is empty or not loaded".printArray(debug_backtrace()));
- 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
Line indented incorrectly; expected 8 spaces, found 12 Open
}
- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
}
- Exclude checks
Line indented incorrectly; expected 12 spaces, found 16 Open
if ($rs = $this->db->query($query)) {
- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
public function __construct($User = false) {
- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
class User extends PrivateMessages {
- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
public function unread() {
- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
}
- Exclude checks
Line indented incorrectly; expected 12 spaces, found 16 Open
}
- Exclude checks
Line indented incorrectly; expected 0 spaces, found 4 Open
}
- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
if (!$User || !$User->id || $User->id == NULL || empty($User->id)) {
- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
public $User;
- Exclude checks
Line indented incorrectly; expected 12 spaces, found 16 Open
}
- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
}
- Exclude checks
Line indented incorrectly; expected 12 spaces, found 16 Open
} else {
- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
} else {
- Exclude checks
Line indented incorrectly; expected 12 spaces, found 16 Open
foreach ($this->db->fetchAll($query, array($this->User->id, PRIVMSGS_NEW_MAIL, PRIVMSGS_UNREAD_MAIL)) as $row) {
- Exclude checks
Line indented incorrectly; expected 16 spaces, found 20 Open
while ($row = $rs->fetch_assoc()) {
- Exclude checks
Line indented incorrectly; expected 16 spaces, found 20 Open
}
- Exclude checks
Line indented incorrectly; expected 8 spaces, found 12 Open
if ($this->db instanceof \sql_db) {
- Exclude checks