<?php
/**
 * CommonPlugin for phplist.
 *
 * This file is a part of CommonPlugin.
 *
 * @category  phplist
 *
 * @author    Duncan Cameron
 * @copyright 2011-2018 Duncan Cameron
 * @license   http://www.gnu.org/licenses/gpl.html GNU General Public License, Version 3
 */

namespace phpList\plugin\Common\DAO;

use function phpList\plugin\Common\shortenText;

/**
 * Trait that provides access to the attribute table.
 */
trait AttributeTrait
{
    /**
     * Returns the fields for each attribute keyed by attribute id.
     * Can limit the number of attributes returned and the length of the attribute name.
     *
     * @return array attributes indexed by id
     */
    public function attributesById($attrNameLength = 0, $maxAttrs = 0)
    {
        $limit = $maxAttrs > 0 ? "LIMIT $maxAttrs" : '';
        $sql =
            "SELECT id, name, type, tablename
            FROM {$this->tables['attribute']}
            ORDER BY listorder
            $limit";
        $result = [];

        foreach ($this->dbCommand->queryAll($sql, 'id') as $id => $row) {
            $row['name'] = $this->transformAttributeName($row['name'], $attrNameLength);
            $result[$id] = $row;
        }

        return $result;
    }

    /**
     * Now just an alias for attributesById().
     */
    public function attributes(...$params)
    {
        return $this->attributesById(...$params);
    }

    /*
     * Returns the fields for one attribute
     *
     * @return array attribute fields
     */
    public function getAttribute($attr)
    {
        $sql =
            "SELECT id, name, type, tablename
            FROM {$this->tables['attribute']}
            WHERE id = $attr";
        $row = $this->dbCommand->queryRow($sql);
        $row['name'] = $this->transformAttributeName($row['name']);

        return $row;
    }

    private function transformAttributeName($name, $maxLength = 0)
    {
        $name = stripslashes($name);

        if ($maxLength > 0) {
            $name = shortenText($name, $maxLength);
        }

        return $name;
    }
}