bristol-su / control

src/AdditionalProperties/HasAdditionalProperties.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\AdditionalProperties;

use Exception;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

/**
 * Allow a model to have any arbitrary properties, set at runtime
 */

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

trait HasAdditionalProperties
{

    /**
     * Initialise the trait
     *
     * - Add all additional properties to the appends array
     * - Add additional_properties column to hidden
     * - Cast the additional_properties column to an array
     */

Missing @return tag in function comment

    public function initializeHasAdditionalProperties()
    {
        if (is_subclass_of($this, Model::class)) {
            $this->append(static::getAdditionalAttributes());

The method append() does not exist on BristolSU\ControlDB\AdditionalProperties\HasAdditionalProperties. Since you implemented __call, consider adding a @method annotation.

            $this->addHidden($this->getColumnName());

The method addHidden() does not exist on BristolSU\ControlDB\AdditionalProperties\HasAdditionalProperties. Since you implemented __call, consider adding a @method annotation.

            $this->casts[] = $this->getColumnName();

The property casts does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        } else {
            throw new Exception('The HasAdditionalProperties trait must only be used in an Eloquent model');
        }
    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public static function addProperty(string $key): void
    {
        app(AdditionalPropertyStore::class)->addProperty(static::class, $key);
    }

    /**
     * Get all additional attributes the model is using
     * 
     * @return array
     */
    public static function getAdditionalAttributes(): array
    {
        return (app(AdditionalPropertyStore::class)->getProperties(static::class) ?? []);
    }
    
    /**
     * 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)
    {
        return (array_key_exists($key, ($this->{$this->getColumnName()}??[])) 
            ? $this->{$this->getColumnName()}[$key] : null);
    }

    /**
     * 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)
    {
        $this->attributes[$this->getColumnName()] = array_merge(($this->{$this->getColumnName()}??[]), [$key => $value]);

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * 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)
    {
        $this->setAdditionalAttribute($key, $value);
        $this->save();

The method save() does not exist on BristolSU\ControlDB\AdditionalProperties\HasAdditionalProperties. Since you implemented __call, consider adding a @method annotation.

    }

    /**
     * Override the default getAttribute function
     * 
     * Any time an attribute is retrieved, we will check if it's an additional property and return it if so
     * 
     * @param string $key Key of the property to retrieve
     * @return mixed Value of the property

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

     */
    public function getAttribute($key)
    {
        if (in_array($key, static::getAdditionalAttributes())) {
            return $this->getAdditionalAttribute($key);
        }
        return parent::getAttribute($key);
    }

    /**
     * Override the default getAttribute function
     *
     * Any time an attribute is set, we will check if it's an additional property and set it correspondingly if so
     *
     * @param string $key Key of the property to retrieve

Expected 3 spaces after parameter name; 1 found

     * @param mixed $value Value of the attribute

Expected 2 spaces after parameter type; 1 found

     * @return mixed Value of the property

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

     */
    public function setAttribute($key, $value)
    {
        if (in_array($key, static::getAdditionalAttributes())) {
            $this->setAdditionalAttribute($key, $value);
        } else {
            parent::setAttribute($key, $value);
        }
    }

    /**
     * Cast the additional attributes column to an array, or return an empty array by default.
     * 
     * @return array|mixed
     */
    public function getAdditionalAttributesAttribute()
    {
        if(!array_key_exists($this->getColumnName(), $this->attributes)) {

Expected "if (...) {\n"; found "if(...) {\n"

            return [];
        }
        if(is_string($this->attributes[$this->getColumnName()])) {

Expected "if (...) {\n"; found "if(...) {\n"

            return (json_decode($this->attributes[$this->getColumnName()], true) ?? []);
        }
        return $this->attributes[$this->getColumnName()];
    }

    /**
     * Get the name of the additional attributes column
     * 
     * @return string Name of the additional attributes column
     */
    private function getColumnName()

Private method name "HasAdditionalProperties::getColumnName" must be prefixed with an underscore

    {
        return 'additional_attributes';
    }

    /**
     * Dynamically define accessors for the appended properties.
     * 
     * By catching all method calls, we can check if they are calls for an accessor or mutator to an attribute and
     * carry out the corresponding action.
     * 
     * @param string $method Method of the call
     * @param array $args Arguments for the call

Expected 2 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 1 found

     * @return mixed

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

     */
    public function __call($method, $args)
    {
        // Check if the call was an accessor
        $additionalAccessors = array_map(function($propertyKey) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            return 'get'.Str::studly($propertyKey).'Attribute';
        }, static::getAdditionalAttributes());

For multi-line function calls, the closing parenthesis should be on a new line.

        if(in_array($method, $additionalAccessors)) {

Expected "if (...) {\n"; found "if(...) {\n"

            return $this->getAdditionalAttribute(
                Str::snake(Str::substr(Str::substr($method, 3), 0, -9))
            );
        }
        
        // Check if the call was a mutator
        $additionalAccessors = array_map(function($propertyKey) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            return 'set'.Str::studly($propertyKey).'Attribute';
        }, static::getAdditionalAttributes());

For multi-line function calls, the closing parenthesis should be on a new line.

        if(in_array($method, $additionalAccessors)) {

Expected "if (...) {\n"; found "if(...) {\n"

            $this->setAdditionalAttribute(
                Str::snake(Str::substr(Str::substr($method, 3), 0, -9)), $args[0]
            );
        } else {
            return parent::__call($method,

The opening parenthesis of a multi-line function call should be the last content on the line.

                $args);

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

For multi-line function calls, the closing parenthesis should be on a new line.

        }
        
        
    }
}