PHP7 compatible function definitions.

2025-10-13 16:00:13 +00:00 · 2016-04-06 09:27:45 +02:00
parent 37fe2d22b0
commit c8440af9a5
77 changed files with 278 additions and 345 deletions
--- a/app/Models/Account.php
+++ b/app/Models/Account.php
@@ -4,6 +4,8 @@ use Auth;
 use Crypt;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Database\Query\JoinClause;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@@ -146,36 +148,39 @@ class Account extends Model
    }

    /**
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     * @return HasMany
     */
-    public function accountMeta()
+    public function accountMeta(): HasMany
    {
        return $this->hasMany('FireflyIII\Models\AccountMeta');
    }

    /**
-     * @codeCoverageIgnore
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
     */
-    public function accountType()
+    public function accountType(): BelongsTo
    {
        return $this->belongsTo('FireflyIII\Models\AccountType');
    }

    /**
-     * @codeCoverageIgnore
+     * FIXME can return null
     *
     * @param $value
     *
     * @return string
     */
-    public function getIbanAttribute($value)
+    public function getIbanAttribute($value): string
    {
        if (is_null($value)) {
-            return null;
+            return '';
+        }
+        $result = Crypt::decrypt($value);
+        if (is_null($result)) {
+            return '';
        }

-        return Crypt::decrypt($value);
+        return $result;
    }

    /**
@@ -184,7 +189,7 @@ class Account extends Model
     *
     * @return string
     */
-    public function getMeta($fieldName): string
+    public function getMeta(string $fieldName): string
    {
        foreach ($this->accountMeta as $meta) {
            if ($meta->name == $fieldName) {
@@ -196,13 +201,12 @@ class Account extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     *
     * @return string
     */
-    public function getNameAttribute($value)
+    public function getNameAttribute($value): string
    {

        if (intval($this->encrypted) == 1) {
@@ -216,7 +220,7 @@ class Account extends Model
     *
     * @return string
     */
-    public function getNameForEditformAttribute()
+    public function getNameForEditformAttribute(): string
    {
        $name = $this->name;
        if ($this->accountType->type == 'Cash account') {
@@ -227,16 +231,14 @@ class Account extends Model
    }

    /**
-     * @codeCoverageIgnore
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     * @return HasMany
     */
-    public function piggyBanks()
+    public function piggyBanks(): HasMany
    {
        return $this->hasMany('FireflyIII\Models\PiggyBank');
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param EloquentBuilder $query
     * @param array           $types
@@ -251,7 +253,6 @@ class Account extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param EloquentBuilder $query
     * @param string          $name
@@ -269,7 +270,6 @@ class Account extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     */
@@ -279,7 +279,6 @@ class Account extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     */
@@ -292,7 +291,6 @@ class Account extends Model
    /**
     * @param $value
     *
-     * @codeCoverageIgnore
     */
    public function setVirtualBalanceAttribute($value)
    {
@@ -300,19 +298,17 @@ class Account extends Model
    }

    /**
-     * @codeCoverageIgnore
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     * @return HasMany
     */
-    public function transactions()
+    public function transactions(): HasMany
    {
        return $this->hasMany('FireflyIII\Models\Transaction');
    }

    /**
-     * @codeCoverageIgnore
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
     */
-    public function user()
+    public function user(): BelongsTo
    {
        return $this->belongsTo('FireflyIII\User');
    }
--- a/app/Models/AccountMeta.php
+++ b/app/Models/AccountMeta.php
@@ -1,6 +1,7 @@
 <?php namespace FireflyIII\Models;

 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;

 /**
 * FireflyIII\Models\AccountMeta
@@ -29,9 +30,9 @@ class AccountMeta extends Model

    /**
     *
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
     */
-    public function account()
+    public function account(): BelongsTo
    {
        return $this->belongsTo('FireflyIII\Models\Account');
    }
--- a/app/Models/AccountType.php
+++ b/app/Models/AccountType.php
@@ -1,6 +1,7 @@
 <?php namespace FireflyIII\Models;

 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;

 /**
 * FireflyIII\Models\AccountType
@@ -25,9 +26,9 @@ class AccountType extends Model

    //
    /**
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     * @return HasMany
     */
-    public function accounts()
+    public function accounts(): HasMany
    {
        return $this->hasMany('FireflyIII\Models\Account');
    }
--- a/app/Models/Attachment.php
+++ b/app/Models/Attachment.php
@@ -6,6 +6,8 @@ namespace FireflyIII\Models;
 use Auth;
 use Crypt;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

@@ -70,8 +72,10 @@ class Attachment extends Model

    /**
     * Get all of the owning imageable models.
+     *
+     * @return MorphTo
     */
-    public function attachable()
+    public function attachable(): MorphTo
    {
        return $this->morphTo();
    }
@@ -87,8 +91,6 @@ class Attachment extends Model
    }

    /**
-     * @codeCoverageIgnore
-     *
     * @param $value
     *
     * @return null|string
@@ -103,8 +105,6 @@ class Attachment extends Model
    }

    /**
-     * @codeCoverageIgnore
-     *
     * @param $value
     *
     * @return null|string
@@ -119,8 +119,6 @@ class Attachment extends Model
    }

    /**
-     * @codeCoverageIgnore
-     *
     * @param $value
     *
     * @return null|string
@@ -135,7 +133,6 @@ class Attachment extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     *
@@ -151,7 +148,6 @@ class Attachment extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     *
@@ -169,7 +165,7 @@ class Attachment extends Model
    /**
     * @param string $value
     */
-    public function setDescriptionAttribute($value)
+    public function setDescriptionAttribute(string $value)
    {
        $this->attributes['description'] = Crypt::encrypt($value);
    }
@@ -177,7 +173,7 @@ class Attachment extends Model
    /**
     * @param string $value
     */
-    public function setFilenameAttribute($value)
+    public function setFilenameAttribute(string $value)
    {
        $this->attributes['filename'] = Crypt::encrypt($value);
    }
@@ -185,7 +181,7 @@ class Attachment extends Model
    /**
     * @param string $value
     */
-    public function setMimeAttribute($value)
+    public function setMimeAttribute(string $value)
    {
        $this->attributes['mime'] = Crypt::encrypt($value);
    }
@@ -193,7 +189,7 @@ class Attachment extends Model
    /**
     * @param string $value
     */
-    public function setNotesAttribute($value)
+    public function setNotesAttribute(string $value)
    {
        $this->attributes['notes'] = Crypt::encrypt($value);
    }
@@ -201,16 +197,15 @@ class Attachment extends Model
    /**
     * @param string $value
     */
-    public function setTitleAttribute($value)
+    public function setTitleAttribute(string $value)
    {
        $this->attributes['title'] = Crypt::encrypt($value);
    }

    /**
-     * @codeCoverageIgnore
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
     */
-    public function user()
+    public function user(): BelongsTo
    {
        return $this->belongsTo('FireflyIII\User');
    }
--- a/app/Models/Bill.php
+++ b/app/Models/Bill.php
@@ -3,6 +3,8 @@
 use Auth;
 use Crypt;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

 /**
@@ -135,17 +137,17 @@ class Bill extends Model
    }

    /**
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     * @return HasMany
     */
-    public function transactionjournals()
+    public function transactionjournals(): HasMany
    {
        return $this->hasMany('FireflyIII\Models\TransactionJournal');
    }

    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
     */
-    public function user()
+    public function user(): BelongsTo
    {
        return $this->belongsTo('FireflyIII\User');
    }
--- a/app/Models/Budget.php
+++ b/app/Models/Budget.php
@@ -3,6 +3,7 @@
 use Auth;
 use Crypt;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

@@ -136,9 +137,9 @@ class Budget extends Model
    }

    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
     */
-    public function user()
+    public function user(): BelongsTo
    {
        return $this->belongsTo('FireflyIII\User');
    }
--- a/app/Models/Category.php
+++ b/app/Models/Category.php
@@ -3,6 +3,7 @@
 use Auth;
 use Crypt;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

@@ -83,7 +84,6 @@ class Category extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     *
@@ -100,7 +100,6 @@ class Category extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     */
@@ -111,7 +110,6 @@ class Category extends Model
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function transactionjournals()
@@ -120,10 +118,9 @@ class Category extends Model
    }

    /**
-     * @codeCoverageIgnore
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
     */
-    public function user()
+    public function user(): BelongsTo
    {
        return $this->belongsTo('FireflyIII\User');
    }
--- a/app/Models/Component.php
+++ b/app/Models/Component.php
@@ -25,14 +25,7 @@ use Illuminate\Database\Eloquent\Model;
 */
 class Component extends Model
 {
+    protected $dates    = ['created_at', 'updated_at', 'deleted_at'];
    protected $fillable = ['user_id', 'name', 'class'];

-    /**
-     * @return array
-     */
-    public function getDates()
-    {
-        return ['created_at', 'updated_at', 'deleted_at'];
-    }
-
 }
--- a/app/Models/ExportJob.php
+++ b/app/Models/ExportJob.php
@@ -64,7 +64,6 @@ class ExportJob extends Model
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function user()
--- a/app/Models/Tag.php
+++ b/app/Models/Tag.php
@@ -109,7 +109,6 @@ class Tag extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     *
@@ -125,7 +124,6 @@ class Tag extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     *
@@ -155,7 +153,6 @@ class Tag extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     */
@@ -165,7 +162,6 @@ class Tag extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     */
@@ -175,7 +171,6 @@ class Tag extends Model
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function transactionjournals()
@@ -184,7 +179,6 @@ class Tag extends Model
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function user()
--- a/app/Models/TransactionJournal.php
+++ b/app/Models/TransactionJournal.php
@@ -158,7 +158,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function bill()
@@ -167,7 +166,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function budgets()
@@ -176,7 +174,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function categories()
@@ -185,7 +182,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     *
@@ -298,7 +294,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function piggyBankEvents()
@@ -322,7 +317,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param EloquentBuilder $query
     * @param Carbon          $date
@@ -335,7 +329,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param EloquentBuilder $query
     * @param Carbon          $date
@@ -391,7 +384,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param EloquentBuilder $query
     * @param array           $types
@@ -406,7 +398,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     *
     * @param $value
     */
@@ -417,7 +408,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function tags()
@@ -426,7 +416,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function transactionCurrency()
@@ -435,7 +424,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function transactionType()
@@ -444,7 +432,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function transactiongroups()
@@ -461,7 +448,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function transactions()
@@ -470,7 +456,6 @@ class TransactionJournal extends TransactionJournalSupport
    }

    /**
-     * @codeCoverageIgnore
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function user()
--- a/app/Models/TransactionType.php
+++ b/app/Models/TransactionType.php
@@ -63,7 +63,6 @@ class TransactionType extends Model
    }

    /**
-     * @codeCoverageIgnore
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */