Files
firefly-iii/app/Models/Attachment.php

228 lines
5.1 KiB
PHP
Raw Normal View History

2015-07-18 09:49:19 +02:00
<?php
/**
* Attachment.php
2017-10-21 08:40:00 +02:00
* Copyright (c) 2017 thegrumpydictator@gmail.com
*
2017-10-21 08:40:00 +02:00
* This file is part of Firefly III.
*
2017-10-21 08:40:00 +02:00
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
2017-12-17 14:44:05 +01:00
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
2015-07-18 09:49:19 +02:00
namespace FireflyIII\Models;
2015-07-19 09:37:28 +02:00
use Crypt;
2015-07-18 09:49:19 +02:00
use Illuminate\Database\Eloquent\Model;
2016-04-06 09:27:45 +02:00
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;
2015-07-18 09:49:19 +02:00
use Illuminate\Database\Eloquent\SoftDeletes;
2016-01-09 15:53:11 +01:00
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
2015-07-18 09:49:19 +02:00
2016-11-18 20:06:08 +01:00
/**
2017-11-15 12:25:49 +01:00
* Class Attachment.
2016-11-18 20:06:08 +01:00
*/
2015-07-18 09:49:19 +02:00
class Attachment extends Model
{
use SoftDeletes;
2016-12-24 17:36:51 +01:00
/**
* The attributes that should be casted to native types.
*
* @var array
*/
protected $casts
= [
2017-11-03 16:04:17 +01:00
'created_at' => 'datetime',
'updated_at' => 'datetime',
'deleted_at' => 'datetime',
2016-12-24 17:36:51 +01:00
'uploaded' => 'boolean',
];
/** @var array */
2015-07-19 09:37:28 +02:00
protected $fillable = ['attachable_id', 'attachable_type', 'user_id', 'md5', 'filename', 'mime', 'title', 'notes', 'description', 'size', 'uploaded'];
2015-07-18 09:49:19 +02:00
2016-02-23 06:54:51 +01:00
/**
* @param string $value
2016-02-23 06:54:51 +01:00
*
* @return Attachment
*/
2018-02-07 11:15:36 +01:00
public static function routeBinder($guard, string $value): Attachment
2016-02-23 06:54:51 +01:00
{
2018-02-07 11:15:36 +01:00
if ($guard->check()) {
$attachmentId = intval($value);
2018-02-07 11:15:36 +01:00
$attachment = $guard->user()->attachments()->find($attachmentId);
if (!is_null($attachment)) {
return $attachment;
2016-02-23 06:54:51 +01:00
}
}
throw new NotFoundHttpException;
}
2015-07-18 09:49:19 +02:00
/**
* Get all of the owning attachable models.
2017-12-29 09:05:35 +01:00
*
* @codeCoverageIgnore
2016-04-06 09:27:45 +02:00
*
* @return MorphTo
2015-07-18 09:49:19 +02:00
*/
2016-04-06 09:27:45 +02:00
public function attachable(): MorphTo
2015-07-18 09:49:19 +02:00
{
return $this->morphTo();
}
/**
2016-02-23 06:54:51 +01:00
* Returns the expected filename for this attachment.
2017-12-29 09:05:35 +01:00
*
* @codeCoverageIgnore
2016-02-23 06:54:51 +01:00
* @return string
2015-07-18 09:49:19 +02:00
*/
2016-02-23 06:54:51 +01:00
public function fileName(): string
2015-07-18 09:49:19 +02:00
{
2016-02-23 06:54:51 +01:00
return sprintf('at-%s.data', strval($this->id));
2015-07-18 09:49:19 +02:00
}
2015-07-19 09:37:28 +02:00
/**
* @param $value
2017-12-29 09:05:35 +01:00
*
* @codeCoverageIgnore
2015-07-19 09:37:28 +02:00
* @return null|string
*/
2016-02-23 06:54:51 +01:00
public function getDescriptionAttribute($value)
2015-07-19 09:37:28 +02:00
{
2017-11-15 12:25:49 +01:00
if (null === $value || 0 === strlen($value)) {
2015-07-19 09:37:28 +02:00
return null;
}
return Crypt::decrypt($value);
}
/**
2016-02-23 06:54:51 +01:00
* @param $value
2017-12-29 09:05:35 +01:00
*
* @codeCoverageIgnore
2016-02-23 06:54:51 +01:00
* @return null|string
2015-07-19 09:37:28 +02:00
*/
2016-02-23 06:54:51 +01:00
public function getFilenameAttribute($value)
2015-07-19 09:37:28 +02:00
{
2017-11-15 12:25:49 +01:00
if (null === $value || 0 === strlen($value)) {
2016-02-23 06:54:51 +01:00
return null;
}
return Crypt::decrypt($value);
2015-07-19 09:37:28 +02:00
}
/**
* @param $value
2017-12-29 09:05:35 +01:00
*
* @codeCoverageIgnore
2015-07-19 09:37:28 +02:00
* @return null|string
*/
public function getMimeAttribute($value)
{
2017-11-15 12:25:49 +01:00
if (null === $value || 0 === strlen($value)) {
2015-07-19 09:37:28 +02:00
return null;
}
return Crypt::decrypt($value);
}
/**
* @param $value
2017-12-29 09:05:35 +01:00
*
* @codeCoverageIgnore
2015-07-19 09:37:28 +02:00
* @return null|string
*/
2016-02-23 06:54:51 +01:00
public function getNotesAttribute($value)
2015-07-19 09:37:28 +02:00
{
2017-11-15 12:25:49 +01:00
if (null === $value || 0 === strlen($value)) {
2015-07-19 09:37:28 +02:00
return null;
}
return Crypt::decrypt($value);
}
/**
* @param $value
2017-12-29 09:05:35 +01:00
*
* @codeCoverageIgnore
2015-07-19 09:37:28 +02:00
* @return null|string
*/
2016-02-23 06:54:51 +01:00
public function getTitleAttribute($value)
2015-07-19 09:37:28 +02:00
{
2017-11-15 12:25:49 +01:00
if (null === $value || 0 === strlen($value)) {
2015-07-19 09:37:28 +02:00
return null;
}
return Crypt::decrypt($value);
}
/**
* @codeCoverageIgnore
2017-12-29 09:05:35 +01:00
*
2015-07-19 09:37:28 +02:00
* @param string $value
*/
2016-04-06 09:27:45 +02:00
public function setDescriptionAttribute(string $value)
2015-07-19 09:37:28 +02:00
{
$this->attributes['description'] = Crypt::encrypt($value);
}
/**
* @codeCoverageIgnore
2017-12-29 09:05:35 +01:00
*
2016-02-23 06:54:51 +01:00
* @param string $value
2015-07-19 09:37:28 +02:00
*/
2016-04-06 09:27:45 +02:00
public function setFilenameAttribute(string $value)
2015-07-19 09:37:28 +02:00
{
2016-02-23 06:54:51 +01:00
$this->attributes['filename'] = Crypt::encrypt($value);
}
2015-07-19 09:37:28 +02:00
2016-02-23 06:54:51 +01:00
/**
* @codeCoverageIgnore
2017-12-29 09:05:35 +01:00
*
2016-02-23 06:54:51 +01:00
* @param string $value
*/
2016-04-06 09:27:45 +02:00
public function setMimeAttribute(string $value)
2016-02-23 06:54:51 +01:00
{
$this->attributes['mime'] = Crypt::encrypt($value);
2015-07-19 09:37:28 +02:00
}
/**
* @codeCoverageIgnore
2017-12-29 09:05:35 +01:00
*
2015-07-19 09:37:28 +02:00
* @param string $value
*/
2016-04-06 09:27:45 +02:00
public function setNotesAttribute(string $value)
2015-07-19 09:37:28 +02:00
{
$this->attributes['notes'] = Crypt::encrypt($value);
}
/**
* @codeCoverageIgnore
2017-12-29 09:05:35 +01:00
*
2016-02-23 06:54:51 +01:00
* @param string $value
*/
2016-04-06 09:27:45 +02:00
public function setTitleAttribute(string $value)
2016-01-09 15:53:11 +01:00
{
2016-02-23 06:54:51 +01:00
$this->attributes['title'] = Crypt::encrypt($value);
}
2016-01-09 15:53:11 +01:00
2016-02-23 06:54:51 +01:00
/**
* @codeCoverageIgnore
2016-04-06 09:27:45 +02:00
* @return BelongsTo
2016-02-23 06:54:51 +01:00
*/
2016-04-06 09:27:45 +02:00
public function user(): BelongsTo
2016-02-23 06:54:51 +01:00
{
return $this->belongsTo('FireflyIII\User');
2016-01-09 15:53:11 +01:00
}
2015-07-19 09:38:44 +02:00
}