bristol-su / control

src/AdditionalProperties/AdditionalPropertyStore.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\AdditionalProperties;

/**
 * Handles storing the additional properties models can define
 */

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 AdditionalPropertyStore
{

    /**
     * Add a property to a model.
     * 
     * Properties must be initialised before they can be used.
     * 
     * @param string $model Model class name to add the property to
     * @param string $key Key of the property

Expected 3 spaces after parameter name; 1 found

     * @return void

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

     */
    public function addProperty(string $model, string $key): void;

    /**
     * Does the given model have any properties
     * 
     * @param string $model Full class name of the model
     * @return bool If the model has properties

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

     */
    public function hasProperties(string $model): bool;

    /**
     * Get all properties a model has
     * 
     * @param string $model Full class name of the model
     * @return array Array of property keys.

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

     */
    public function getProperties(string $model): array;
    
}