public/main/inc/lib/notification.lib.php
The method Notification::send() calls the typical debug function print_r() which is mostly only used during development. Open
Open
error_log('Updating record : '.print_r($item_to_send, 1));- Read upRead up
- Exclude checks
DevelopmentCodeFragment
Since: 2.3.0
Functions like vardump(), printr() etc. are normally only used during development and therefore such calls in production code are a good indicator that they were just forgotten.
Example
class SuspectCode {
public function doSomething(array $items)
{
foreach ($items as $i => $item) {
// …
if ('qafoo' == $item) var_dump($i);
// …
}
}
}Source https://phpmd.org/rules/design.html#developmentcodefragment
The method formatContent() has an NPath complexity of 660. The configured NPath complexity threshold is 200. Open
Open
public function formatContent($messageId, $content, $senderInfo, $recipientLanguage = null, $baseUrl = null)
{
$newMessageText = $linkToNewMessage = '';
$showEmail = ('true' === api_get_setting('mail.show_user_email_in_notification'));
$senderInfoName = '';- 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 saveNotification() has an NPath complexity of 2260. The configured NPath complexity threshold is 200. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- 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
Missing class import via use statement (line '473', column '36'). Open
Open
$extraFieldValue = new ExtraFieldValue('user');- 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
Avoid assigning values to variables in if clauses and the like (line '64', column '13'). Open
Open
public function __construct()
{
$this->table = Database::get_main_table(TABLE_NOTIFICATION);
if ($smtpFromEmail = api_get_setting('mail.smtp_from_email')) {- 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
Avoid assigning values to variables in if clauses and the like (line '67', column '17'). Open
Open
public function __construct()
{
$this->table = Database::get_main_table(TABLE_NOTIFICATION);
if ($smtpFromEmail = api_get_setting('mail.smtp_from_email')) {- 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
The method __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
// Default no-reply email
$this->adminEmail = api_get_setting('mail.noreply_email_address');
$this->adminName = api_get_setting('platform.site_name');
$this->titlePrefix = '['.api_get_setting('platform.site_name').'] ';- 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 unused local variables such as '$topicPage'. Open
Open
$topicPage = isset($_REQUEST['topics_page_nr']) ? (int) $_REQUEST['topics_page_nr'] : 0;- Read upRead up
- Exclude checks
UnusedLocalVariable
Since: 0.2
Detects when a local variable is declared and/or assigned, but not used.
Example
class Foo {
public function doSomething()
{
$i = 5; // Unused
}
}Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable
The property $max_content_length is not named in camelCase. Open
Open
class Notification extends Model
{
// mail_notify_message ("At once", "Daily", "No")
const NOTIFY_MESSAGE_AT_ONCE = 1;
const NOTIFY_MESSAGE_DAILY = 8;- Read upRead up
- Exclude checks
CamelCasePropertyName
Since: 0.2
It is considered best practice to use the camelCase notation to name attributes.
Example
class ClassName {
protected $property_name;
}Source
Variable "item_to_send" is not in valid camel caps format Open
Open
$item_to_send['dest_mail'],- Exclude checks
Expected 10 spaces after parameter name; 1 found Open
Open
* @param string|null $recipientLanguage The language of the recipient for translation.- Exclude checks
Variable "item_to_send" is not in valid camel caps format Open
Open
Security::filter_terms($item_to_send['title']),- Exclude checks
Variable "item_to_send" is not in valid camel caps format Open
Open
error_log('Updating record : '.print_r($item_to_send, 1));- Exclude checks
Expected 7 spaces after parameter type; 2 found Open
Open
* @param array $senderInfo Information about the sender.- Exclude checks
Variable "item_to_send" is not in valid camel caps format Open
Open
$item_to_send['sent_at'] = api_get_utc_datetime();- Exclude checks
Variable "extra_data" is not in valid camel caps format Open
Open
$userSetting = $extra_data[$settingToCheck];- Exclude checks
Variable "user_id" is not in valid camel caps format Open
Open
'dest_user_id' => $user_id,- Exclude checks
Missing function doc comment Open
Open
public function __construct()- Exclude checks
Doc comment for parameter $type does not match actual variable name $messageId Open
Open
* @param int $type message type- Exclude checks
Variable "item_to_send" is not in valid camel caps format Open
Open
$item_to_send['dest_mail'],- Exclude checks
Variable "item_to_send" is not in valid camel caps format Open
Open
Security::filter_terms($item_to_send['content']),- Exclude checks
Expected 17 spaces after parameter name; 1 found Open
Open
* @param array $senderInfo Information about the sender.- Exclude checks
Doc comment for parameter $messageId does not match actual variable name $type Open
Open
* @param int $messageId- Exclude checks
Variable "extra_data" is not in valid camel caps format Open
Open
$extra_data = UserManager::get_extra_user_data($user_id);- Exclude checks
Variable "extra_data" is not in valid camel caps format Open
Open
if (isset($extra_data[$settingToCheck])) {- Exclude checks
Expected 22 spaces after parameter name; 1 found Open
Open
* @param string $title The original title of the notification.- Exclude checks
Variable "avoid_my_self" is not in valid camel caps format Open
Open
$avoid_my_self = false;- Exclude checks
Variable "user_id" is not in valid camel caps format Open
Open
$extra_data = UserManager::get_extra_user_data($user_id);- Exclude checks
Expected 8 spaces after parameter type; 3 found Open
Open
* @param bool $forceTitleWhenSendingEmail Whether to force the use of the original title.- Exclude checks
Member variable "max_content_length" is not in valid camel caps format Open
Open
public $max_content_length = 254;- Exclude checks
Variable "avoid_my_self" is not in valid camel caps format Open
Open
if ($avoid_my_self) {- Exclude checks
Variable "user_id" is not in valid camel caps format Open
Open
if ($user_id == api_get_user_id()) {- Exclude checks
Variable "user_id" is not in valid camel caps format Open
Open
$userInfo = api_get_user_info($user_id);- Exclude checks
Variable "item_to_send" is not in valid camel caps format Open
Open
$this->update($item_to_send);- Exclude checks
Expected 6 spaces after parameter type; 1 found Open
Open
* @param string $title The original title of the notification.- Exclude checks
Variable "user_id" is not in valid camel caps format Open
Open
foreach ($userList as $user_id) {- Exclude checks
Variable "item_to_send" is not in valid camel caps format Open
Open
foreach ($notifications as $item_to_send) {- Exclude checks
Variable "avoid_my_self" is not in valid camel caps format Open
Open
$avoid_my_self = true;- Exclude checks
The variable $user_id is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $user_id is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $item_to_send is not named in camelCase. Open
Open
public function send($frequency = 8)
{
$notifications = $this->find(
'all',
['where' => ['sent_at IS NULL AND send_freq = ?' => $frequency]]- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $avoid_my_self is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $user_id is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $avoid_my_self is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $item_to_send is not named in camelCase. Open
Open
public function send($frequency = 8)
{
$notifications = $this->find(
'all',
['where' => ['sent_at IS NULL AND send_freq = ?' => $frequency]]- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $extra_data is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $item_to_send is not named in camelCase. Open
Open
public function send($frequency = 8)
{
$notifications = $this->find(
'all',
['where' => ['sent_at IS NULL AND send_freq = ?' => $frequency]]- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $item_to_send is not named in camelCase. Open
Open
public function send($frequency = 8)
{
$notifications = $this->find(
'all',
['where' => ['sent_at IS NULL AND send_freq = ?' => $frequency]]- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $extra_data is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $user_id is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $item_to_send is not named in camelCase. Open
Open
public function send($frequency = 8)
{
$notifications = $this->find(
'all',
['where' => ['sent_at IS NULL AND send_freq = ?' => $frequency]]- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $user_id is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $item_to_send is not named in camelCase. Open
Open
public function send($frequency = 8)
{
$notifications = $this->find(
'all',
['where' => ['sent_at IS NULL AND send_freq = ?' => $frequency]]- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $item_to_send is not named in camelCase. Open
Open
public function send($frequency = 8)
{
$notifications = $this->find(
'all',
['where' => ['sent_at IS NULL AND send_freq = ?' => $frequency]]- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $item_to_send is not named in camelCase. Open
Open
public function send($frequency = 8)
{
$notifications = $this->find(
'all',
['where' => ['sent_at IS NULL AND send_freq = ?' => $frequency]]- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $avoid_my_self is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $extra_data is not named in camelCase. Open
Open
public function saveNotification(
$messageId,
$type,
$userList,
$title,- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}