bristol-su / control

src/AdditionalProperties/ImplementsAdditionalProperties.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\AdditionalProperties;

/**
 * Handles additional properties
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

interface ImplementsAdditionalProperties
{

    /**
     * Add an additional property
     *
     * @param $key

Missing parameter comment

     */

Missing @return tag in function comment

    public static function addProperty(string $key): void;

    /**
     * Get all additional attributes the model is using
     *
     * @return array
     */
    public static function getAdditionalAttributes(): array;
    
    /**
     * Retrieve an additional attribute value
     *
     * @param string $key Key of the attribute
     * @return mixed Value of the attribute

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getAdditionalAttribute(string $key);

    /**
     * Set an additional attribute value
     *
     * @param string $key Key of the attribute

Expected 3 spaces after parameter name; 1 found

     * @param mixed $value Value of the attribute

Expected 2 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function setAdditionalAttribute(string $key, $value);

    /**
     * Save an additional attribute value
     *
     * @param string $key Key of the attribute

Expected 3 spaces after parameter name; 1 found

     * @param mixed $value Value of the attribute

Expected 2 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function saveAdditionalAttribute(string $key, $value);

}