osb/app/Models/Service/Broadband.php

188 lines
4.2 KiB
PHP
Raw Normal View History

2018-05-20 12:53:14 +00:00
<?php
namespace App\Models\Service;
2018-05-20 12:53:14 +00:00
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;
2021-03-12 10:08:40 +00:00
use Leenooks\Carbon;
use App\Interfaces\{ServiceItem,ServiceUsage};
2020-02-05 04:47:24 +00:00
use App\Models\Base\ServiceType;
use App\Models\Supplier\Broadband as SupplierBroadband;
use App\Traits\NextKey;
class Broadband extends ServiceType implements ServiceItem,ServiceUsage
2018-05-20 12:53:14 +00:00
{
private const LOGKEY = 'MSA';
use NextKey;
const RECORD_ID = 'service__adsl';
2020-02-05 04:47:24 +00:00
protected $dates = [
'service_connect_date',
'service_contract_date'
];
public $dateFormat = 'U';
2020-02-19 12:37:45 +00:00
protected $table = 'ab_service__adsl';
2018-05-20 12:53:14 +00:00
/* RELATIONS */
2021-03-12 10:08:40 +00:00
2020-05-28 05:08:13 +00:00
/**
* The accounts that this user manages
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function traffic()
{
// @todo Need to include site_id in this relation
2020-05-28 05:08:13 +00:00
return $this->hasMany(AdslTraffic::class,'ab_service_adsl_id');
}
/* SCOPES */
2019-06-29 00:14:12 +00:00
/**
* Search for a record
*
* @param $query
* @param string $term
* @return
*/
public function scopeSearch($query,string $term)
{
// Build our where clause
return parent::scopeSearch($query,$term)
->orwhere('service_number','like','%'.$term.'%')
->orWhere('service_address','like','%'.$term.'%')
->orWhere('ipaddress','like','%'.$term.'%');
}
/**
2021-07-19 06:42:37 +00:00
* @deprecated use $o->service_name;
2020-02-05 04:47:24 +00:00
* @return mixed|string
2019-06-29 00:14:12 +00:00
*/
/* ATTRIBUTES */
2020-02-05 04:47:24 +00:00
public function getNameAttribute()
2018-11-21 03:37:17 +00:00
{
2020-02-05 04:47:24 +00:00
return $this->service_number ?: $this->service_address;
2018-11-21 03:37:17 +00:00
}
2020-02-05 04:47:24 +00:00
/**
* Return the service address
*
* @return string
*/
public function getServiceDescriptionAttribute(): string
2018-05-20 12:53:14 +00:00
{
2020-02-08 11:51:50 +00:00
return strtoupper($this->service_address) ?: 'NO Service Address';
2020-02-05 04:47:24 +00:00
}
public function getServiceExpireAttribute(): \Carbon\Carbon
{
// TODO: Implement getServiceExpireAttribute() method.
}
2020-02-05 04:47:24 +00:00
/**
* Return the service number
*
* @return string
*/
public function getServiceNameAttribute(): string
{
2021-07-19 06:42:37 +00:00
return $this->service_number ?: $this->service_address;
2018-05-20 12:53:14 +00:00
}
2019-06-29 00:14:12 +00:00
/* METHODS */
2020-02-05 04:47:24 +00:00
/**
* Is this service currently in a contract
*
* @return bool
*/
public function inContract(): bool
2019-06-29 00:14:12 +00:00
{
2020-02-05 04:47:24 +00:00
return $this->service_contract_date AND $this->service_contract_date->addMonths($this->contract_term)->isFuture();
2019-06-29 00:14:12 +00:00
}
/**
* Return the suppliers offering that this service is providing
*
* @return SupplierBroadband
*/
public function supplied(): SupplierBroadband
{
return $this->provided_adsl_plan_id
? SupplierBroadband::findOrFail($this->provided_adsl_plan_id)
: $this->service->product->type->supplied;
}
/**
* Return service usage data
*
* @param int $days
* @return Collection
*/
public function usage(int $days=31): Collection
{
2021-03-12 10:08:40 +00:00
$maxdate = $this->usage_last_date();
2021-03-12 10:08:40 +00:00
if (! $maxdate)
return collect();
Log::debug(sprintf('%s:Getting Usage data for [%d] days from [%s]',self::LOGKEY,$days,$maxdate->date->format('Y-m-d')),['m'=>__METHOD__]);
return $this->traffic()
2021-03-12 10:08:40 +00:00
->where('date','<=',$maxdate->date->format('Y-m-d'))
->where('date','>=',$maxdate->date->subDays($days)->format('Y-m-d'))
->get();
}
2021-03-12 10:08:40 +00:00
/**
* Find the last date any traffic was recorded for a service
*
* @return AdslTraffic|null
2021-03-12 10:08:40 +00:00
*/
private function usage_last_date(): ?AdslTraffic
2021-03-12 10:08:40 +00:00
{
return $this->traffic
->sortBy('date')
->last();
}
public function usage_summary(int $months=2): Collection
{
$maxdate = $this->usage_last_date();
if (! $maxdate)
return collect();
Log::debug(sprintf('%s:Getting Usage data for [%d] months from [%s]',self::LOGKEY,$months,$maxdate),['m'=>__METHOD__]);
// Go back an extra month;
$start = $maxdate->date->subMonths($months);
// If we are before the 15th
if ($start->day < 15) {
$start = Carbon::createFromFormat('Y-m-d',$start->subMonth()->format('Y-m-').'15');
2021-03-12 10:08:40 +00:00
} else {
$start = $start->subDays($start->day-15);
}
Log::debug(sprintf('%s:Getting Usage data from [%s]',self::LOGKEY,$start->format('Y-m-d')),['m'=>__METHOD__]);
$result = collect();
foreach ($this->traffic()
->where('date','>=',$start->format('Y-m-d'))
->where('date','<=',$maxdate->date->format('Y-m-d'))
->get()->groupBy(function($item) {
return sprintf('%s->%s',$item->trafficMonthStart->format('d M'),$item->trafficMonthEnd->format('d M'));
2021-03-12 10:08:40 +00:00
}) as $key => $o) {
$result->put($key,$o->sum('total'));
}
return $result;
}
}