MailNotification::getMailSubject()   A
last analyzed

Complexity

Conditions 2
Paths 1

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 5
nc 1
nop 2
dl 0
loc 8
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
/*
4
 * This file is part of Jitamin.
5
 *
6
 * Copyright (C) Jitamin Team
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Jitamin\Notification;
13
14
use Jitamin\Foundation\Base;
15
use Jitamin\Foundation\Notification\NotificationInterface;
16
17
/**
18
 * Email Notification.
19
 */
20
class MailNotification extends Base implements NotificationInterface
21
{
22
    /**
23
     * Notification type.
24
     *
25
     * @var string
26
     */
27
    const TYPE = 'email';
28
29
    /**
30
     * Send notification to a user.
31
     *
32
     * @param array  $user
33
     * @param string $event_name
34
     * @param array  $event_data
35
     */
36
    public function notifyUser(array $user, $event_name, array $event_data)
37
    {
38
        if (!empty($user['email'])) {
39
            $this->emailClient->send(
0 ignored issues
show
Documentation introduced by
The property emailClient does not exist on object<Jitamin\Notification\MailNotification>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
40
                $user['email'],
41
                $user['name'] ?: $user['username'],
42
                $this->getMailSubject($event_name, $event_data),
43
                $this->getMailContent($event_name, $event_data)
44
            );
45
        }
46
    }
47
48
    /**
49
     * Send notification to a project.
50
     *
51
     * @param array  $project
52
     * @param string $event_name
53
     * @param array  $event_data
54
     */
55
    public function notifyProject(array $project, $event_name, array $event_data)
56
    {
57
    }
58
59
    /**
60
     * Get the mail content for a given template name.
61
     *
62
     * @param string $event_name Event name
63
     * @param array  $event_data Event data
64
     *
65
     * @return string
66
     */
67
    public function getMailContent($event_name, array $event_data)
68
    {
69
        return $this->template->render(
0 ignored issues
show
Documentation introduced by
The property template does not exist on object<Jitamin\Notification\MailNotification>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
70
            'notification/'.str_replace('.', '_', $event_name),
71
            $event_data + ['application_url' => $this->settingModel->get('application_url')]
0 ignored issues
show
Documentation introduced by
The property settingModel does not exist on object<Jitamin\Notification\MailNotification>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
72
        );
73
    }
74
75
    /**
76
     * Get the mail subject for a given template name.
77
     *
78
     * @param string $eventName Event name
79
     * @param array  $eventData Event data
80
     *
81
     * @return string
82
     */
83
    public function getMailSubject($eventName, array $eventData)
84
    {
85
        return sprintf(
86
            '[%s] %s',
87
            isset($eventData['project_name']) ? $eventData['project_name'] : $eventData['task']['project_name'],
88
            $this->notificationModel->getTitleWithoutAuthor($eventName, $eventData)
0 ignored issues
show
Documentation introduced by
The property notificationModel does not exist on object<Jitamin\Notification\MailNotification>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
89
        );
90
    }
91
}
92