Logger::createEmail() - Code Metrics - Inspection of "fix" - mdaniels5757/waca - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — rbac ( be68b4...52c28b )

by Michael

created 2020-04-26 02:29 UTC

Logger::createEmail() A

↳ Parent: Logger

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	0
cts	3
cp	0
rs	10
cc	1
nc	1
nop	2
crap	2

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\Helpers;

use Exception;
use Waca\DataObject;
use Waca\DataObjects\Ban;
use Waca\DataObjects\Comment;
use Waca\DataObjects\EmailTemplate;
use Waca\DataObjects\Log;
use Waca\DataObjects\Request;
use Waca\DataObjects\SiteNotice;
use Waca\DataObjects\User;
use Waca\DataObjects\WelcomeTemplate;
use Waca\PdoDatabase;

/**
 * Helper class for creating log entries
 *
 * Logger description.
 *
 * @version 1.0
 * @author  stwalkerster
 */
class Logger
{
    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function emailConfirmed(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param DataObject  $object
     * @param string      $logAction
     * @param null|string $comment
     * @param User        $user
     *
     * @throws Exception
     */
    private static function createLogEntry(
        PdoDatabase $database,
        DataObject $object,
        $logAction,
        $comment = null,

        $user = null

    ) {
        if ($user == null) {
            $user = User::getCurrent($database);
        }

        $objectType = get_class($object);
        if (strpos($objectType, 'Waca\\DataObjects\\') !== false) {
            $objectType = str_replace('Waca\\DataObjects\\', '', $objectType);
        }

        $log = new Log();
        $log->setDatabase($database);
        $log->setAction($logAction);
        $log->setObjectId($object->getId());
        $log->setObjectType($objectType);
        $log->setUser($user);
        $log->setComment($comment);
        $log->save();
    }


    #region Users

    /**
     * @param PdoDatabase $database
     * @param User        $user
     */
    public static function newUser(PdoDatabase $database, User $user)
    {
        self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
    }


    /**
     * @param PdoDatabase $database
     * @param User        $object
     */
    public static function approvedUser(PdoDatabase $database, User $object)
    {
        self::createLogEntry($database, $object, "Approved");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param User        $object
     * @param string      $comment
     */
    public static function declinedUser(PdoDatabase $database, User $object, $comment)
    {
        self::createLogEntry($database, $object, "Declined", $comment);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param User        $object
     * @param string      $comment
     */
    public static function suspendedUser(PdoDatabase $database, User $object, $comment)
    {
        self::createLogEntry($database, $object, "Suspended", $comment);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param User        $object
     * @param string      $comment
     */
    public static function demotedUser(PdoDatabase $database, User $object, $comment)
    {
        self::createLogEntry($database, $object, "Demoted", $comment);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param User        $object
     */
    public static function promotedUser(PdoDatabase $database, User $object)
    {
        self::createLogEntry($database, $object, "Promoted");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param User        $object
     * @param string      $comment
     */
    public static function renamedUser(PdoDatabase $database, User $object, $comment)
    {
        self::createLogEntry($database, $object, "Renamed", $comment);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param User        $object
     */
    public static function userPreferencesChange(PdoDatabase $database, User $object)
    {
        self::createLogEntry($database, $object, "Prefchange");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param User        $object
     * @param string      $reason
     * @param array       $added
     * @param array       $removed
     */
    public static function userRolesEdited(PdoDatabase $database, User $object, $reason, $added, $removed)
    {
        $logData = serialize(array(
            'added'   => $added,
            'removed' => $removed,
            'reason'  => $reason,
        ));

        self::createLogEntry($database, $object, "RoleChange", $logData);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    #endregion

    /**
     * @param PdoDatabase $database
     * @param SiteNotice  $object
     */
    public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
    {
        self::createLogEntry($database, $object, "Edited");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    #region Welcome Templates

    /**
     * @param PdoDatabase     $database
     * @param WelcomeTemplate $object
     */
    public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
    {
        self::createLogEntry($database, $object, "CreatedTemplate");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase     $database
     * @param WelcomeTemplate $object
     */
    public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
    {
        self::createLogEntry($database, $object, "EditedTemplate");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase     $database
     * @param WelcomeTemplate $object
     */
    public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
    {
        self::createLogEntry($database, $object, "DeletedTemplate");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    #endregion

    #region Bans

    /**
     * @param PdoDatabase $database
     * @param Ban         $object
     * @param string      $reason
     */
    public static function banned(PdoDatabase $database, Ban $object, $reason)
    {
        self::createLogEntry($database, $object, "Banned", $reason);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param Ban         $object
     * @param string      $reason
     */
    public static function unbanned(PdoDatabase $database, Ban $object, $reason)
    {
        self::createLogEntry($database, $object, "Unbanned", $reason);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    #endregion

    #region Requests

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     * @param string      $target
     */
    public static function deferRequest(PdoDatabase $database, Request $object, $target)
    {
        self::createLogEntry($database, $object, "Deferred to $target");
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
    }


    /**
     * @param PdoDatabase $database
     * @param Request     $object
     * @param integer     $target
     * @param string      $comment
     */
    public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment)
    {
        self::createLogEntry($database, $object, "Closed $target", $comment);
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
    }


    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function reserve(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "Reserved");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function breakReserve(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "BreakReserve");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function unreserve(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "Unreserved");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param Comment     $object
     * @param Request     $request
     */
    public static function editComment(PdoDatabase $database, Comment $object, Request $request)
    {
        self::createLogEntry($database, $request, "EditComment-r");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        self::createLogEntry($database, $object, "EditComment-c");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param Request     $object
     * @param User        $target
     */
    public static function sendReservation(PdoDatabase $database, Request $object, User $target)
    {
        self::createLogEntry($database, $object, "SendReserved");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase $database
     * @param Request     $object
     * @param string      $comment
     */
    public static function sentMail(PdoDatabase $database, Request $object, $comment)
    {
        self::createLogEntry($database, $object, "SentMail", $comment);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }

    #endregion

    #region Email templates

    /**
     * @param PdoDatabase   $database
     * @param EmailTemplate $object
     */
    public static function createEmail(PdoDatabase $database, EmailTemplate $object)
    {
        self::createLogEntry($database, $object, "CreatedEmail");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    /**
     * @param PdoDatabase   $database
     * @param EmailTemplate $object
     */
    public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
    {
        self::createLogEntry($database, $object, "EditedEmail");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }


    #endregion

    #region Display

    #endregion
}



1			<?php
2			/******************************************************************************
3			* Wikipedia Account Creation Assistance tool *
4			* *
5			* All code in this file is released into the public domain by the ACC *
6			* Development Team. Please see team.json for a list of contributors. *
7			******************************************************************************/
8
9			namespace Waca\Helpers;
10
11			use Exception;
12			use Waca\DataObject;
13			use Waca\DataObjects\Ban;
14			use Waca\DataObjects\Comment;
15			use Waca\DataObjects\EmailTemplate;
16			use Waca\DataObjects\Log;
17			use Waca\DataObjects\Request;
18			use Waca\DataObjects\SiteNotice;
19			use Waca\DataObjects\User;
20			use Waca\DataObjects\WelcomeTemplate;
21			use Waca\PdoDatabase;
22
23			/**
24			* Helper class for creating log entries
25			*
26			* Logger description.
27			*
28			* @version 1.0
29			* @author stwalkerster
30			*/
31			class Logger
32			{
33			/**
34			* @param PdoDatabase $database
35			* @param Request $object
36			*/
37			public static function emailConfirmed(PdoDatabase $database, Request $object)
38			{
39			self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
			0 ignored issues – show Coding Style Comprehensibility introduced 2020-04-23 23:50 UTC by Report Bug Copy Issue Report The string literal `Email Confirmed` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...

mdaniels5757 / waca

Push — rbac ( be68b4...52c28b )

Logger::createEmail() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like