bristol-su / control

src/Models/Position.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Models;


use BristolSU\ControlDB\Traits\PositionTrait;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * Represents a position
 */

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

class Position extends Model implements \BristolSU\ControlDB\Contracts\Models\Position
{
    use SoftDeletes, PositionTrait {
        setDataProviderId as baseSetDataProviderId;
    }

    /**
     * Table to use
     *
     * @var string
     */
    protected $table = 'control_positions';

    /**
     * Fillable attributes
     *
     * @var array
     */
    protected $fillable = ['data_provider_id'];

    /**
     * Attributes to append when casting to an array
     *
     * @var array
     */
    protected $appends = [
        'data'
    ];

    /**
     * ID of the position
     *
     * @return int
     */
    public function id(): int
    {
        return $this->id;
    }

    /**
     * ID of the data provider for the position
     *
     * @return int
     */
    public function dataProviderId(): int
    {
        return $this->data_provider_id;
    }

    /**
     * Laravel integration for a data property
     *
     * @return \BristolSU\ControlDB\Contracts\Models\DataPosition
     */
    public function getDataAttribute(): \BristolSU\ControlDB\Contracts\Models\DataPosition
    {
        return $this->data();
    }

    /**
     * Set the ID of the data provider
     *
     * @param int $dataProviderId

Missing parameter comment

     */

Missing @return tag in function comment

    public function setDataProviderId(int $dataProviderId): void
    {
        $this->baseSetDataProviderId($dataProviderId);
        $this->refresh();
    }


}