Longman\TelegramBot\Entities\User

Complexity

Total Complexity

5

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
B	tryMention()	0	24	5

<?php
/**
 * This file is part of the TelegramBot package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Longman\TelegramBot\Entities;

/**
 * Class User
 *
 * @link https://core.telegram.org/bots/api#user
 *
 * @property int    $id         Unique identifier for this user or bot
 * @property string $first_name User's or bot’s first name
 * @property string $last_name  Optional. User's or bot’s last name
 * @property string $username   Optional. User's or bot’s username
 *
 * @method int    getId()        Unique identifier for this user or bot
 * @method string getFirstName() User's or bot’s first name
 * @method string getLastName()  Optional. User's or bot’s last name
 * @method string getUsername()  Optional. User's or bot’s username
 */
class User extends Entity
{
    /**
     * tryMention
     *
     * Mention the user with the username otherwise print first and last name
     * if the $markdown arguments is true special characters are escaped from the output
     *
     * @param bool $markdown
     *
     * @return string
     */
    public function tryMention($markdown = false)
    {
        $username = $this->getProperty('username');
        if ($username !== null) {
            if ($markdown) {
                //Escaping md special characters
                //Please notice that just the _ is allowed in the username ` * [ are not allowed
                return '@' . $this->stripMarkDown($this->username);
            }
            return '@' . $this->username;
        }

        $name = $this->getProperty('first_name');
        $last_name = $this->getProperty('last_name');
        if ($last_name !== null) {
            $name .= ' ' . $last_name;
        }
        
        if ($markdown) {
            //Escaping md special characters
            return $this->stripMarkDown($name);
        }
        return $name;
    }
}