bytic / MediaLibrary

src/Models/MediaProperties/MediaProperty.php

<?php

namespace ByTIC\MediaLibrary\Models\MediaProperties;

use ByTIC\MediaLibrary\Collections\Collection;
use ByTIC\MediaLibrary\HasMedia\HasMediaTrait;
use Nip\Records\Record;

/**
 * Class MediaProperty
 * @package ByTIC\MediaLibrary\Models\MediaRecords
 *
 * @property string $model
 * @property int $model_id
 * @property string $collection_name
 * @property string $custom_properties
 *
 * @method HasMediaTrait|Record getModel
 */
class MediaProperty extends Record
{
    /**
     * @var null|array
     */
    protected $customPropertiesArray = null;

    /**
     * @param Record $model
     */
    public function populateFromModel(Record $model)
    {
        $this->model = $model->getManager()->getMorphName();

It seems like $model->getManager()->getMorphName() of type Nip\Records\AbstractModels\RecordManager or Nip\Records\Collections\Collection or Nip\Records\Traits\Relations\HasRelationsRecordsTrait or true is incompatible with the declared type string of property $model.

It seems like getMorphName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->model_id = $model->getPrimaryKey();
    }

    /**
     * @param Collection|string $collection
     */
    public function populateFromCollection($collection)
    {
        $name = is_object($collection) ? $collection->getName() : $collection;
        $this->collection_name = $name;
    }

    /**
     * @return array
     */
    public function getCustomProperties()
    {
        $this->checkCustomProperties();
        return $this->customPropertiesArray;
    }

    protected function checkCustomProperties()
    {
        if ($this->customPropertiesArray == null) {
            $this->initCustomProperties();
        }
    }


    public function initCustomProperties()
    {
        $properties = json_decode($this->getAttributeFromArray('custom_properties'), true);

It seems like $this->getAttributeFromArray('custom_properties') can also be of type null; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

        $properties = (is_array($properties)) ? $properties : [];
        $this->customPropertiesArray = $properties;
    }

    /**
     * @param $name
     * @param null $default

Are you sure the doc-type for parameter $default is correct as it would always require null to be passed?

     * @return mixed
     */
    public function getCustomProperty($name, $default = null)
    {
        $this->checkCustomProperties();
        return isset($this->customPropertiesArray[$name]) ? $this->customPropertiesArray[$name] : $default;
    }

    /**
     * @param $name
     * @param $value
     */
    public function setCustomPropery($name, $value)
    {
        $this->checkCustomProperties();
        $this->customPropertiesArray[$name] = $value;
        $this->setCustomPropertiesAttribute($this->getCustomProperties());
    }

    /**
     * @param bool $value
     */
    public function saveDbLoaded($value)
    {
        $this->dbLoaded($value);
        $this->save();
    }

    /**
     * @param bool|null $value
     * @return bool
     */
    public function dbLoaded($value = null)
    {
        if ($value == null) {
            return $this->getCustomProperty('dbLoaded', false);
        }
        $value = ($value == true);

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

        $this->setCustomPropery('dbLoaded', $value);
        return $value;
    }

    /**
     * @param null $value

Are you sure the doc-type for parameter $value is correct as it would always require null to be passed?

     * @return mixed|null
     */
    public function defaultMedia($value = null)
    {
        if ($value == null) {

The condition $value == null is always true.

            $model = $this->getModel();
            $default = $model ? $model->getAttribute('default_image') : null;

It seems like getAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return $this->getCustomProperty('defaultMedia', $default);
        }

        $this->setCustomPropery('defaultMedia', $value);
        return $value;
    }

    /**
     * @param $value
     */
    public function setDefaultMedia($value)
    {
        $this->defaultMedia($value);
        $this->save();

        $model = $this->getModel();
        if ($this->collection_name == 'images') {
            $model->setAttribute('default_image', $value);

It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $model->update();

It seems like update() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
    }

    /**
     * @param $value
     */
    public function setCustomPropertiesAttribute($value)
    {
        if (is_string($value)) {
            $this->customPropertiesArray = null;
        } else {
            $this->customPropertiesArray = $value;
            $value = json_encode($value);
        }
        $this->setPropertyValue('custom_properties', $value);
    }
}