DonorNote.php
136 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Donors\Models; |
| 4 | |
| 5 | use DateTime; |
| 6 | use Exception; |
| 7 | use Give\Donors\Factories\DonorNoteFactory; |
| 8 | use Give\Donors\ValueObjects\DonorNoteType; |
| 9 | use Give\Framework\Models\Contracts\ModelCrud; |
| 10 | use Give\Framework\Models\Contracts\ModelHasFactory; |
| 11 | use Give\Framework\Models\Model; |
| 12 | use Give\Framework\Models\ModelQueryBuilder; |
| 13 | use Give\Framework\Models\ValueObjects\Relationship; |
| 14 | use Give\Framework\Support\Facades\DateTime\Temporal; |
| 15 | |
| 16 | /** |
| 17 | * @since 4.4.0 |
| 18 | * |
| 19 | * @property int $id |
| 20 | * @property int $donorId |
| 21 | * @property string $content |
| 22 | * @property DonorNoteType $type |
| 23 | * @property DateTime $createdAt |
| 24 | * @property Donor $donor |
| 25 | */ |
| 26 | class DonorNote extends Model implements ModelCrud, ModelHasFactory |
| 27 | { |
| 28 | /** |
| 29 | * @inheritdoc |
| 30 | */ |
| 31 | protected $properties = [ |
| 32 | 'id' => 'int', |
| 33 | 'donorId' => 'int', |
| 34 | 'content' => 'string', |
| 35 | 'type' => DonorNoteType::class, |
| 36 | 'createdAt' => DateTime::class, |
| 37 | ]; |
| 38 | |
| 39 | /** |
| 40 | * @inheritdoc |
| 41 | */ |
| 42 | protected $relationships = [ |
| 43 | 'donor' => Relationship::BELONGS_TO, |
| 44 | ]; |
| 45 | |
| 46 | /** |
| 47 | * @since 4.4.0 |
| 48 | */ |
| 49 | public static function find($id): ?DonorNote |
| 50 | { |
| 51 | return give()->donors->notes->getById($id); |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * @since 4.4.0 |
| 56 | * |
| 57 | * @throws Exception |
| 58 | */ |
| 59 | public static function create(array $attributes): DonorNote |
| 60 | { |
| 61 | $donorNote = new static($attributes); |
| 62 | |
| 63 | give()->donors->notes->insert($donorNote); |
| 64 | |
| 65 | return $donorNote; |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * @since 4.4.0 |
| 70 | * |
| 71 | * @throws Exception |
| 72 | */ |
| 73 | public function save(): DonorNote |
| 74 | { |
| 75 | if ( ! $this->id) { |
| 76 | give()->donors->notes->insert($this); |
| 77 | } else { |
| 78 | give()->donors->notes->update($this); |
| 79 | } |
| 80 | |
| 81 | return $this; |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * @since 4.4.0 |
| 86 | * |
| 87 | * @throws Exception |
| 88 | */ |
| 89 | public function delete(): bool |
| 90 | { |
| 91 | return give()->donors->notes->delete($this); |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * @since 4.4.0 |
| 96 | * |
| 97 | * @return ModelQueryBuilder<DonorNote> |
| 98 | */ |
| 99 | public static function query(): ModelQueryBuilder |
| 100 | { |
| 101 | return give()->donors->notes->prepareQuery(); |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * @since 4.4.0 |
| 106 | * |
| 107 | * @return ModelQueryBuilder<Donor> |
| 108 | */ |
| 109 | public function donor(): ModelQueryBuilder |
| 110 | { |
| 111 | return give()->donors->queryById($this->donorId); |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * @since 4.4.0 |
| 116 | */ |
| 117 | public static function fromQueryBuilderObject($object): DonorNote |
| 118 | { |
| 119 | return new DonorNote([ |
| 120 | 'id' => (int)$object->id, |
| 121 | 'type' => $object->type ? new DonorNoteType($object->type) : DonorNoteType::ADMIN(), |
| 122 | 'donorId' => (int)$object->donorId, |
| 123 | 'content' => (string)$object->content, |
| 124 | 'createdAt' => Temporal::toDateTime($object->createdAt), |
| 125 | ]); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * @since 4.4.0 |
| 130 | */ |
| 131 | public static function factory(): DonorNoteFactory |
| 132 | { |
| 133 | return new DonorNoteFactory(static::class); |
| 134 | } |
| 135 | } |
| 136 |