mirror of
				https://github.com/invoiceninja/invoiceninja.git
				synced 2025-10-28 03:13:26 -04:00 
			
		
		
		
	
		
			
				
	
	
		
			320 lines
		
	
	
		
			7.6 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			320 lines
		
	
	
		
			7.6 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?php namespace App\Models;
 | |
| 
 | |
| use Utils;
 | |
| use DB;
 | |
| use Carbon;
 | |
| use Laracasts\Presenter\PresentableTrait;
 | |
| use Illuminate\Database\Eloquent\SoftDeletes;
 | |
| 
 | |
| class Client extends EntityModel
 | |
| {
 | |
|     use PresentableTrait;
 | |
|     use SoftDeletes;
 | |
| 
 | |
|     protected $presenter = 'App\Ninja\Presenters\ClientPresenter';
 | |
| 
 | |
|     protected $dates = ['deleted_at'];
 | |
| 
 | |
|     protected $fillable = [
 | |
|         'name',
 | |
|         'id_number',
 | |
|         'vat_number',
 | |
|         'work_phone',
 | |
|         'custom_value1',
 | |
|         'custom_value2',
 | |
|         'address1',
 | |
|         'address2',
 | |
|         'city',
 | |
|         'state',
 | |
|         'postal_code',
 | |
|         'country_id',
 | |
|         'private_notes',
 | |
|         'size_id',
 | |
|         'industry_id',
 | |
|         'currency_id',
 | |
|         'language_id',
 | |
|         'payment_terms',
 | |
|         'website',
 | |
|     ];
 | |
| 
 | |
|     public static $fieldName = 'name';
 | |
|     public static $fieldPhone = 'work_phone';
 | |
|     public static $fieldAddress1 = 'address1';
 | |
|     public static $fieldAddress2 = 'address2';
 | |
|     public static $fieldCity = 'city';
 | |
|     public static $fieldState = 'state';
 | |
|     public static $fieldPostalCode = 'postal_code';
 | |
|     public static $fieldNotes = 'notes';
 | |
|     public static $fieldCountry = 'country';
 | |
| 
 | |
|     public static function getImportColumns()
 | |
|     {
 | |
|         return [
 | |
|             Client::$fieldName,
 | |
|             Client::$fieldPhone,
 | |
|             Client::$fieldAddress1,
 | |
|             Client::$fieldAddress2,
 | |
|             Client::$fieldCity,
 | |
|             Client::$fieldState,
 | |
|             Client::$fieldPostalCode,
 | |
|             Client::$fieldCountry,
 | |
|             Client::$fieldNotes,
 | |
|             Contact::$fieldFirstName,
 | |
|             Contact::$fieldLastName,
 | |
|             Contact::$fieldPhone,
 | |
|             Contact::$fieldEmail,
 | |
|         ];
 | |
|     }
 | |
| 
 | |
|     public static function getImportMap()
 | |
|     {
 | |
|         return [
 | |
|             'first' => 'first_name',
 | |
|             'last' => 'last_name',
 | |
|             'email' => 'email',
 | |
|             'mobile|phone' => 'phone',
 | |
|             'name|organization' => 'name',
 | |
|             'street2|address2' => 'address2',
 | |
|             'street|address|address1' => 'address1',
 | |
|             'city' => 'city',
 | |
|             'state|province' => 'state',
 | |
|             'zip|postal|code' => 'postal_code',
 | |
|             'country' => 'country',
 | |
|             'note' => 'notes',
 | |
|         ];
 | |
|     }
 | |
| 
 | |
|     public function account()
 | |
|     {
 | |
|         return $this->belongsTo('App\Models\Account');
 | |
|     }
 | |
| 
 | |
|     public function user()
 | |
|     {
 | |
|         return $this->belongsTo('App\Models\User')->withTrashed();
 | |
|     }
 | |
| 
 | |
|     public function invoices()
 | |
|     {
 | |
|         return $this->hasMany('App\Models\Invoice');
 | |
|     }
 | |
| 
 | |
|     public function payments()
 | |
|     {
 | |
|         return $this->hasMany('App\Models\Payment');
 | |
|     }
 | |
| 
 | |
|     public function contacts()
 | |
|     {
 | |
|         return $this->hasMany('App\Models\Contact');
 | |
|     }
 | |
| 
 | |
|     public function country()
 | |
|     {
 | |
|         return $this->belongsTo('App\Models\Country');
 | |
|     }
 | |
| 
 | |
|     public function currency()
 | |
|     {
 | |
|         return $this->belongsTo('App\Models\Currency');
 | |
|     }
 | |
| 
 | |
|     public function language()
 | |
|     {
 | |
|         return $this->belongsTo('App\Models\Language');
 | |
|     }
 | |
| 
 | |
|     public function size()
 | |
|     {
 | |
|         return $this->belongsTo('App\Models\Size');
 | |
|     }
 | |
| 
 | |
|     public function industry()
 | |
|     {
 | |
|         return $this->belongsTo('App\Models\Industry');
 | |
|     }
 | |
| 
 | |
|     public function credits()
 | |
|     {
 | |
|         return $this->hasMany('App\Models\Credit');
 | |
|     }
 | |
| 
 | |
|     public function expenses()
 | |
|     {
 | |
|         return $this->hasMany('App\Models\Expense','client_id','id')->withTrashed();
 | |
|     }
 | |
| 
 | |
|     public function addContact($data, $isPrimary = false)
 | |
|     {
 | |
|         $publicId = isset($data['public_id']) ? $data['public_id'] : (isset($data['id']) ? $data['id'] : false);
 | |
| 
 | |
|         if ($publicId && $publicId != '-1') {
 | |
|             $contact = Contact::scope($publicId)->firstOrFail();
 | |
|         } else {
 | |
|             $contact = Contact::createNew();
 | |
|             $contact->send_invoice = true;
 | |
|         }
 | |
|         
 | |
|         if (!Utils::isPro() || $this->account->enable_portal_password){
 | |
|             if(!empty($data['password']) && $data['password']!='-%unchanged%-'){
 | |
|                 $contact->password = bcrypt($data['password']);
 | |
|             } else if(empty($data['password'])){
 | |
|                 $contact->password = null;
 | |
|             }
 | |
|         }
 | |
|             
 | |
|         $contact->fill($data);
 | |
|         $contact->is_primary = $isPrimary;
 | |
| 
 | |
|         return $this->contacts()->save($contact);
 | |
|     }
 | |
| 
 | |
|     public function updateBalances($balanceAdjustment, $paidToDateAdjustment)
 | |
|     {
 | |
|         if ($balanceAdjustment === 0 && $paidToDateAdjustment === 0) {
 | |
|             return;
 | |
|         }
 | |
| 
 | |
|         $this->balance = $this->balance + $balanceAdjustment;
 | |
|         $this->paid_to_date = $this->paid_to_date + $paidToDateAdjustment;
 | |
|         
 | |
|         $this->save();
 | |
|     }
 | |
| 
 | |
|     public function getRoute()
 | |
|     {
 | |
|         return "/clients/{$this->public_id}";
 | |
|     }
 | |
| 
 | |
|     public function getTotalCredit()
 | |
|     {
 | |
|         return DB::table('credits')
 | |
|                 ->where('client_id', '=', $this->id)
 | |
|                 ->whereNull('deleted_at')
 | |
|                 ->sum('balance');
 | |
|     }
 | |
| 
 | |
|     public function getName()
 | |
|     {
 | |
|         return $this->name;
 | |
|     }
 | |
|     
 | |
|     public function getDisplayName()
 | |
|     {
 | |
|         if ($this->name) {
 | |
|             return $this->name;
 | |
|         }
 | |
|         
 | |
|         if ( ! count($this->contacts)) {
 | |
|             return '';
 | |
|         }
 | |
| 
 | |
|         $contact = $this->contacts[0];
 | |
|         return $contact->getDisplayName();
 | |
|     }
 | |
| 
 | |
|     public function getCityState()
 | |
|     {
 | |
|         $swap = $this->country && $this->country->swap_postal_code;
 | |
|         return Utils::cityStateZip($this->city, $this->state, $this->postal_code, $swap);
 | |
|     }
 | |
| 
 | |
|     public function getEntityType()
 | |
|     {
 | |
|         return ENTITY_CLIENT;
 | |
|     }
 | |
| 
 | |
|     public function hasAddress()
 | |
|     {
 | |
|         $fields = [
 | |
|             'address1',
 | |
|             'address2',
 | |
|             'city',
 | |
|             'state',
 | |
|             'postal_code',
 | |
|             'country_id',
 | |
|         ];
 | |
| 
 | |
|         foreach ($fields as $field) {
 | |
|             if ($this->$field) {
 | |
|                 return true;
 | |
|             }
 | |
|         }
 | |
| 
 | |
|         return false;
 | |
|     }
 | |
| 
 | |
|     public function getDateCreated()
 | |
|     {
 | |
|         if ($this->created_at == '0000-00-00 00:00:00') {
 | |
|             return '---';
 | |
|         } else {
 | |
|             return $this->created_at->format('m/d/y h:i a');
 | |
|         }
 | |
|     }
 | |
| 
 | |
| 
 | |
|     public function getGatewayToken()
 | |
|     {
 | |
|         $this->account->load('account_gateways');
 | |
| 
 | |
|         if (!count($this->account->account_gateways)) {
 | |
|             return false;
 | |
|         }
 | |
| 
 | |
|         $accountGateway = $this->account->getGatewayConfig(GATEWAY_STRIPE);
 | |
|         
 | |
|         if (!$accountGateway) {
 | |
|             return false;
 | |
|         }
 | |
| 
 | |
|         $token = AccountGatewayToken::where('client_id', '=', $this->id)
 | |
|                     ->where('account_gateway_id', '=', $accountGateway->id)->first();
 | |
| 
 | |
|         return $token ? $token->token : false;
 | |
|     }
 | |
| 
 | |
|     public function getGatewayLink()
 | |
|     {
 | |
|         $token = $this->getGatewayToken();
 | |
|         return $token ? "https://dashboard.stripe.com/customers/{$token}" : false;
 | |
|     }
 | |
| 
 | |
|     public function getAmount()
 | |
|     {
 | |
|         return $this->balance + $this->paid_to_date;
 | |
|     }
 | |
| 
 | |
|     public function getCurrencyId()
 | |
|     {
 | |
|         if ($this->currency_id) {
 | |
|             return $this->currency_id;
 | |
|         }
 | |
| 
 | |
|         if (!$this->account) {
 | |
|             $this->load('account');
 | |
|         }
 | |
| 
 | |
|         return $this->account->currency_id ?: DEFAULT_CURRENCY;
 | |
|     }
 | |
| 
 | |
|     public function getCounter($isQuote)
 | |
|     {
 | |
|         return $isQuote ? $this->quote_number_counter : $this->invoice_number_counter;
 | |
|     }
 | |
| 
 | |
|     public function markLoggedIn()
 | |
|     {
 | |
|         $this->last_login = Carbon::now()->toDateTimeString();
 | |
|         $this->save();
 | |
|     }
 | |
| }
 | |
| 
 | |
| Client::creating(function ($client) {
 | |
|     $client->setNullValues();
 | |
| });
 | |
| 
 | |
| Client::updating(function ($client) {
 | |
|     $client->setNullValues();
 | |
| });
 |