PurpleBooth\GitGitHubLint\Status\LimitTheBodyWrapLengthTo72CharactersStatus

Complexity

Total Complexity

3

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getWeight()	0	4	1
A	getState()	0	4	1
A	getMessage()	0	4	1

<?php
declare(strict_types = 1);
namespace PurpleBooth\GitGitHubLint\Status;

use PurpleBooth\GitGitHubLint\Validator\LimitTheBodyWrapLengthTo72CharactersValidator;

/**
 * This is the status returned when the LimitTheBodyWrapLengthTo72CharactersValidator identifies a problem
 *
 * @see     LimitTheBodyWrapLengthTo72CharactersValidator
 *
 * @package PurpleBooth\GitGitHubLint\Status
 */
class LimitTheBodyWrapLengthTo72CharactersStatus implements Status
{
    /**
     * Get the importance of this status.
     *
     * The lower the value the less important it is, the higher the more important.
     *
     * @return int
     */
    public function getWeight() : int
    {
        return Status::WEIGHT_ERROR;
    }

    /**
     * The GitHub equivalent of this state
     *
     * Can be one of pending, success, error, or failure.
     *
     * @return string
     */
    public function getState() : string
    {
        return Status::STATE_FAILURE;
    }

    /**
     * A human readable message that describes this state
     *
     * This will be displayed to the user via the GitHub state
     *
     * @return string
     */
    public function getMessage() :string
    {
        return 'Please limit the body line length of the commit message to 72 characters';
    }
}