digitalbiblesociety/dbp

<?php

namespace App\Models\Bible;

use App\Models\Organization\Organization;
use Illuminate\Database\Eloquent\Model;

/**
 * App\Models\Bible\BibleLink
 *
 * @property-read \App\Models\Organization\Organization $organization
 * @mixin \Eloquent
 * @method static BibleLink whereBibleId($value)
 * @method static BibleLink whereCreatedAt($value)
 * @method static BibleLink whereId($value)
 * @method static BibleLink whereOrganizationId($value)
 * @method static BibleLink whereProvider($value)
 * @method static BibleLink whereTitle($value)
 * @method static BibleLink whereType($value)
 * @method static BibleLink whereUpdatedAt($value)
 * @method static BibleLink whereUrl($value)
 *
 * @OA\Schema (
 *     type="object",
 *     description="BibleLink",
 *     title="BibleLink",
 *     @OA\Xml(name="BibleLink")
 * )
 *
 */
class BibleLink extends Model
{
    protected $connection = 'dbp';
    /**
     * BibleLinks will only be called from the Bibles Model. So we don't need ID or Abbr.
     *
     * @var array
     */
    protected $hidden = ['created_at','updated_at','id','abbr','visible'];
    /**
     * Values the User can Edit
     *
     * @var array
     */
    protected $fillable = ['bible_id', 'provider', 'link', 'type', 'organization_id','url','title'];


    /**
     *
     * @OA\Property(
     *   title="id",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereId($value)
     * @property int $id
     */
    protected $id;

    /**
     *
     * @OA\Property(
     *   title="bible_id",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereBibleId($value)
     * @property string|null $bible_id
     */
    protected $bible_id;

    /**
     *
     * @OA\Property(
     *   title="type",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereType($value)
     * @property string $type
     */
    protected $type;

    /**
     *
     * @OA\Property(
     *   title="url",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereUrl($value)
     * @property string $url
     */
    protected $url;

    /**
     *
     * @OA\Property(
     *   title="title",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereTitle($value)
     * @property string $title
     */
    protected $title;

    /**
     *
     * @OA\Property(
     *   title="organization_id",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereOrganizationId($value)
     * @property int|null $organization_id
     */
    protected $organization_id;

    /**
     *
     * @OA\Property(
     *   title="created_at",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereCreatedAt($value)
     * @property \Carbon\Carbon $created_at
     */
    protected $created_at;

    /**
     *
     * @OA\Property(
     *   title="updated_at",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereUpdatedAt($value)
     * @property \Carbon\Carbon $updated_at
     */
    protected $updated_at;

    /**
     *
     * @OA\Property(
     *   title="provider",
     *   type="string",
     *   description=""
     * )
     *
     * @method static BibleLink whereProvider($value)
     * @property string|null $provider
     */
    protected $provider;

    /**
     * The Organization who Provides that link [not necessarily the publisher]
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function organization()
    {
        return $this->hasOne(Organization::class, 'id');
    }

    public function bible()
    {
        return $this->belongsTo(Bible::class);
    }
}