CustomColumnTypeComment

Complexity

Total Complexity

12

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

92.59%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getTableName()	0	4	1
A	getQuery()	0	5	1
A	getCustom()	0	4	1
A	encodeHTMLValue()	0	4	1
A	getAllCustomValuesFromDatabase()	0	4	1
A	getDescription()	0	6	3
A	getCustomByBook()	0	11	2
A	isSearchable()	0	4	1

<?php
/**
 * COPS (Calibre OPDS PHP Server) class file
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Sébastien Lucas <sebastien@slucas.fr>
 */

class CustomColumnTypeComment extends CustomColumnType

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    protected function __construct($pcustomId)
    {
        parent::__construct($pcustomId, self::CUSTOM_TYPE_COMMENT);
    }

    /**
     * Get the name of the sqlite table for this column
     *
     * @return string|null
     */
    private function getTableName()
    {
        return "custom_column_{$this->customId}";

As per coding-style, please use concatenation or sprintf for the variable $this instead of interpolation.

    }

    public function getQuery($id)
    {
        $query = str_format(Book::SQL_BOOKS_BY_CUSTOM_DIRECT_ID, "{0}", "{1}", $this->getTableName());

The string literal {0} does not require double quotes, as per coding-style, please use single quotes.

The string literal {1} does not require double quotes, as per coding-style, please use single quotes.

        return array($query, array($id));
    }

    public function getCustom($id)
    {
        return new CustomColumn($id, $id, $this);
    }

    public function encodeHTMLValue($value)
    {
        return "<div>" . $value . "</div>"; // no htmlspecialchars, this is already HTML

The string literal <div> does not require double quotes, as per coding-style, please use single quotes.

The string literal </div> does not require double quotes, as per coding-style, please use single quotes.

    }

    protected function getAllCustomValuesFromDatabase()
    {
        return NULL;
    }

    public function getDescription()
    {
        $desc = $this->getDatabaseDescription();
        if ($desc === NULL || empty($desc)) $desc = str_format(localize("customcolumn.description"), $this->getTitle());

The string literal customcolumn.description does not require double quotes, as per coding-style, please use single quotes.

        return $desc;
    }

    public function getCustomByBook($book)
    {
        $queryFormat = "SELECT {0}.id AS id, {0}.value AS value FROM {0} WHERE {0}.book = {1}";

The string literal SELECT {0}.id AS id, {0}.value AS value FROM {0} WHERE {0}.book = {1} does not require double quotes, as per coding-style, please use single quotes.

        $query = str_format($queryFormat, $this->getTableName(), $book->id);

        $result = Base::getDb()->query($query);
        if ($post = $result->fetchObject()) {
            return new CustomColumn($post->id, $post->value, $this);
        }
        return new CustomColumn(NULL, localize("customcolumn.float.unknown"), $this);

The string literal customcolumn.float.unknown does not require double quotes, as per coding-style, please use single quotes.

    }

    public function isSearchable()
    {
        return false;
    }
}