deon/osb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Start work on updating services

Browse Source
This commit is contained in:
Deon George
2022-04-19 17:07:39 +10:00
parent ebf08ea414
commit 621a132e35
63 changed files with 1038 additions and 612 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
app/Console/Commands/ServiceList.php
View File

@@ -33,7 +33,7 @@ class ServiceList extends Command
*/
public function handle()
{
$header = '|%13s|%-10s|%-35s|%-40s|%8s|%10s|%15s|%10s|%10s|%12s|%14s|';
$header = '|%13s|%-14s|%-35s|%-40s|%8s|%17s|%12s|%12s|%12s|%12s|%14s|';
$this->warn(sprintf($header,
'ID',
@@ -58,24 +58,24 @@ class ServiceList extends Command
if ($this->option('type') AND ($o->product->getProductTypeAttribute() !== $this->option('type')))
continue;
$c = $o->invoice_items->filter(function($item) {return $item->item_type === 0; })->sortby('date_start')->first();
$c = $o->invoice_items->filter(function($item) {return $item->item_type === 0; })->sortby('start_at')->first();
if ($this->option('fix') AND ! $o->date_start AND $c AND $c->date_start AND $o->type AND $o->type->service_connect_date AND $c->date_start->format('Y-m-d') == $o->type->service_connect_date->format('Y-m-d')) {
$o->date_start = $o->type->service_connect_date;
if ($this->option('fix') AND ! $o->start_at AND $c AND $c->start_at AND $o->type AND $o->type->connect_at AND $c->start_at->format('Y-m-d') == $o->type->connect_at->format('Y-m-d')) {
$o->start_at = $o->type->connect_at;
$o->save();
}
$this->info(sprintf($header,
$o->sid,
$o->product->getProductTypeAttribute(),
$o->product->getNameAttribute(),
$o->name_short,
substr($o->product->getNameAttribute(),0,35),
substr($o->name_short,0,40),
$o->active ? 'active' : 'inactive',
$o->status,
$o->invoice_next ? $o->invoice_next->format('Y-m-d') : NULL,
$o->date_start ? $o->date_start->format('Y-m-d') : NULL,
$o->date_end ? $o->date_end->format('Y-m-d') : NULL,
($o->type AND $o->type->service_connect_date) ? $o->type->service_connect_date->format('Y-m-d') : NULL,
$o->start_at ? $o->start_at->format('Y-m-d') : NULL,
$o->stop_at ? $o->stop_at->format('Y-m-d') : NULL,
($o->type AND $o->type->connect_at) ? $o->type->connect_at->format('Y-m-d') : NULL,
($c && $c->date_start) ? $c->date_start->format('Y-m-d') : NULL,
));
}

2
app/Http/Controllers/AdminController.php
View File

@@ -28,7 +28,7 @@ class AdminController extends Controller
$request->validate([
'account_id' => 'required|exists:accounts,id',
'charge_date' => 'required|date',
'service_id' => 'required|exists:ab_service,id',
'service_id' => 'required|exists:services,id',
'quantity' => 'required|numeric|not_in:0',
'amount' => 'required|numeric|min:0.01',
'sweep_type' => 'required|numeric|in:'.implode(',',array_keys(Charge::sweep)),

6
app/Http/Controllers/ProductController.php
View File

@@ -20,7 +20,7 @@ class ProductController extends Controller
{
switch ($request->type) {
case 'App\Models\Product\Broadband':
return Product\Broadband::select(['id','supplier_broadband_id'])
return Product\Broadband::select(['id','supplier_item_id'])
->with(['supplied.supplier_detail.supplier'])
->get()
->map(function($item) { return ['id'=>$item->id,'name'=>sprintf('%s: %s',$item->supplied->supplier_detail->supplier->name,$item->supplied->name)]; })
@@ -28,7 +28,7 @@ class ProductController extends Controller
->values();
case 'App\Models\Product\Email':
return Product\Email::select(['id','supplier_email_id'])
return Product\Email::select(['id','supplier_item_id'])
->with(['supplied.supplier_detail.supplier'])
->get()
->map(function($item) { return ['id'=>$item->id,'name'=>sprintf('%s: %s',$item->supplied->supplier_detail->supplier->name,$item->supplied->name)]; })
@@ -36,7 +36,7 @@ class ProductController extends Controller
->values();
case 'App\Models\Product\Host':
return Product\Host::select(['id','supplier_host_id'])
return Product\Host::select(['id','supplier_item_id'])
->with(['supplied.supplier_detail.supplier'])
->get()
->map(function($item) { return ['id'=>$item->id,'name'=>sprintf('%s: %s',$item->supplied->supplier_detail->supplier->name,$item->supplied->name)]; })

12
app/Http/Controllers/SearchController.php
View File

@@ -7,7 +7,7 @@ use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Gate;
use App\Models\{Account,Invoice,Payment,Service,Service\Adsl,Service\Voip,User};
use App\Models\{Account,Invoice,Payment,Service,Service\Broadband,Service\Phone,User};
class SearchController extends Controller
{
@@ -65,8 +65,8 @@ class SearchController extends Controller
$result->push(['name'=>sprintf('%s: %s',$o->sid,$o->account->name),'value'=>'/u/invoice/'.$o->id,'category'=>'Invoices']);
}
# Look for an ADSL/NBN Service
foreach (Service\Broadband::Search($request->input('term'))
# Look for an Broadband Service
foreach (Broadband::Search($request->input('term'))
->whereIN('account_id',$accounts)
->orderBy('service_number')
->limit(10)->get() as $o)
@@ -74,13 +74,13 @@ class SearchController extends Controller
$result->push(['name'=>sprintf('%s (%s)',$o->service_name,$o->service->sid),'value'=>'/u/service/'.$o->id,'category'=>'Broadband']);
}
# Look for an VOIP Service
foreach (Voip::Search($request->input('term'))
# Look for an Phone Service
foreach (Phone::Search($request->input('term'))
->whereIN('account_id',$accounts)
->orderBy('service_number')
->limit(10)->get() as $o)
{
$result->push(['name'=>sprintf('%s (%s)',$o->service_name,$o->service->sid),'value'=>'/u/service/'.$o->id,'category'=>'VOIP']);
$result->push(['name'=>sprintf('%s (%s)',$o->service_name,$o->service->sid),'value'=>'/u/service/'.$o->id,'category'=>'Phone']);
}
# Look for Domain Name

12
app/Http/Controllers/ServiceController.php
View File

@@ -246,8 +246,8 @@ class ServiceController extends Controller
{
$o = Service\Domain::serviceActive()
->serviceUserAuthorised(Auth::user())
->select('service_domains.*')
->join('ab_service',['ab_service.id'=>'service_domains.service_id'])
->select('service_domain.*')
->join('services',['services.id'=>'service_domain.service_id'])
->with(['service.account','registrar'])
->get();
@@ -260,8 +260,8 @@ class ServiceController extends Controller
// @todo Need to add the with path when calculating next_billed and price
$o = Service\Email::serviceActive()
->serviceUserAuthorised(Auth::user())
->select('service_emails.*')
->join('ab_service',['ab_service.id'=>'service_emails.service_id'])
->select('service_email.*')
->join('services',['services.id'=>'service_email.service_id'])
->with(['service.account','service.product.type.supplied.supplier_detail.supplier','tld'])
->get();
@@ -274,8 +274,8 @@ class ServiceController extends Controller
// @todo Need to add the with path when calculating next_billed and price
$o = Service\Host::serviceActive()
->serviceUserAuthorised(Auth::user())
->select('ab_service__hosting.*')
->join('ab_service',['ab_service.id'=>'ab_service__hosting.service_id'])
->select('service_host.*')
->join('services',['services.id'=>'service_host.service_id'])
->with(['service.account','service.product.type.supplied.supplier_detail.supplier','tld'])
->get();

16
app/Interfaces/ServiceItem.php
View File

@@ -6,6 +6,13 @@ use Carbon\Carbon;
interface ServiceItem
{
/**
* Months the service is contracted for.
*
* @return int
*/
public function getContractTermAttribute(): int;
/**
* Return the Service Description.
*
@@ -16,7 +23,7 @@ interface ServiceItem
/**
* Date the service expires
*/
public function getServiceExpireAttribute(): Carbon;
public function getServiceExpireAttribute(): ?Carbon;
/**
* Return the Service Name.
@@ -25,6 +32,13 @@ interface ServiceItem
*/
public function getServiceNameAttribute(): string;
/**
* Has this service expired
*
* @return bool
*/
public function hasExpired(): bool;
/**
* Is this service in a contract
*

8
app/Jobs/BroadbandTraffic.php
View File

@@ -90,11 +90,11 @@ final class BroadbandTraffic implements ShouldQueue
// Find the right service dependant on the dates we supplied the service
$oo = Adsl::where('service_username',$row[$o->getColumnKey('Login')])
->select(DB::raw('ab_service__adsl.*'))
->join('ab_service','ab_service.id','=','service_id')
->where('ab_service.date_start','<=',$date->format('U'))
->join('services','services.id','=','service_id')
->where('services.start_at','<=',$date)
->where(function($query) use ($date) {
$query->whereNULL('ab_service.date_end')
->orWhere('ab_service.date_end','<=',$date->format('U'));
$query->whereNULL('services.stop_at')
->orWhere('services.stop_at','<=',$date);
})
->get();

8
app/Mail/CancelRequest.php
View File

@@ -36,12 +36,12 @@ class CancelRequest extends Mailable
public function build()
{
switch (get_class($this->service->type)) {
case 'App\Models\Service\Adsl':
$subject = sprintf('CANCEL NBN: %s',$this->service->type->service_address);
case 'App\Models\Service\Broadband':
$subject = sprintf('Cancel BROADBAND: %s',$this->service->type->service_address);
break;
case 'App\Models\Service\Voip':
$subject = sprintf('CANCEL VOIP: %s',$this->service->type->service_number);
case 'App\Models\Service\Phone':
$subject = sprintf('Cancel PHONE: %s',$this->service->type->service_number);
break;
default:

8
app/Mail/ChangeRequest.php
View File

@@ -36,12 +36,12 @@ class ChangeRequest extends Mailable
public function build()
{
switch (get_class($this->service->type)) {
case 'App\Models\Service\Adsl':
$subject = sprintf('Change NBN: %s',$this->service->type->service_address);
case 'App\Models\Service\Broadband':
$subject = sprintf('Change BROADBAND: %s',$this->service->type->service_address);
break;
case 'App\Models\Service\Voip':
$subject = sprintf('Change VOIP: %s',$this->service->type->service_number);
case 'App\Models\Service\Phone':
$subject = sprintf('Change PHONE: %s',$this->service->type->service_number);
break;
default:

8
app/Mail/OrderRequest.php
View File

@@ -36,12 +36,12 @@ class OrderRequest extends Mailable
public function build()
{
switch (get_class($this->service->type)) {
case 'App\Models\Service\Adsl':
$subject = sprintf('NBN: %s',$this->service->type->service_address);
case 'App\Models\Service\Broadband':
$subject = sprintf('Order BROADBAND: %s',$this->service->type->service_address);
break;
case 'App\Models\Service\Voip':
$subject = sprintf('VOIP: %s',$this->service->type->service_number);
case 'App\Models\Service\Phone':
$subject = sprintf('Order PHONE: %s',$this->service->type->service_number);
break;
default:

5
app/Mail/OrderRequestApprove.php
View File

@@ -35,11 +35,12 @@ class OrderRequestApprove extends Mailable
*/
public function build()
{
// @todo This is not consistent with Cancel/Change Request
switch ($this->service->category) {
case 'ADSL': $subject = sprintf('%s: %s',$this->service->category,$this->service->service_adsl->service_address);
case 'BROADBAND': $subject = sprintf('%s: %s',$this->service->category,$this->service->type->service_address);
break;
case 'VOIP': $subject = sprintf('%s: %s',$this->service->category,$this->service->service_voip->service_number);
case 'PHONE': $subject = sprintf('%s: %s',$this->service->category,$this->service->type->service_number);
break;
default:

68
app/Models/Base/ServiceType.php
View File

@@ -2,14 +2,34 @@
namespace App\Models\Base;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;
use App\Models\Service;
use App\Interfaces\ServiceItem;
use App\Models\{Account,Service};
use App\Models\Supplier\Type;
use App\Traits\{ScopeServiceActive,ScopeServiceUserAuthorised};
abstract class ServiceType extends Model
abstract class ServiceType extends Model implements ServiceItem
{
use ScopeServiceActive,ScopeServiceUserAuthorised;
protected $dates = [
'expire_at',
];
public $timestamps = FALSE;
/* RELATIONS */
/**
* Account this service belongs to
* @return \Illuminate\Database\Eloquent\Relations\HasOneThrough
*/
public function account()
{
return $this->hasOneThrough(Account::class,Service::class);
}
/**
* @NOTE: The service_id column could be discarded, if the id column=service_id
* @return \Illuminate\Database\Eloquent\Relations\MorphOne
@@ -19,27 +39,61 @@ abstract class ServiceType extends Model
return $this->morphOne(Service::class,'type','model','id','service_id');
}
/** SCOPES */
/* SCOPES */
/**
* Search for a record
*
* @param $query
* @param string $term
* @return
* @return mixed
*/
public function scopeSearch($query,string $term)
{
return $query
->with(['service'])
->join('ab_service','ab_service.id','=',$this->getTable().'.service_id')
->Where('ab_service.id','like','%'.$term.'%');
->join('services','services.id','=',$this->getTable().'.service_id')
->Where('services.id','like','%'.$term.'%');
}
/** ATTRIBUTES **/
/* INTERFACE */
public function getContractTermAttribute(): int
{
return $this->service->offering->contract_term;
}
public function getServiceExpireAttribute(): ?Carbon
{
return $this->expire_at ?: $this->service->invoice_next_at;
}
public function hasExpired(): bool
{
return (! $this->inContract()) && ($this->service->invoice_next_at && $this->service->invoice_next_at->isPast());
}
public function inContract(): bool
{
return $this->expire_at && $this->expire_at->isFuture();
}
/* ATTRIBUTES */
public function getTypeAttribute()
{
return strtolower((new \ReflectionClass($this))->getShortName());
}
/* METHODS */
/**
* The supplier's service that we provide
*
* @return Type
*/
public function supplied(): Type
{
return $this->service->product->type->supplied;
}
}

6
app/Models/Invoice.php
View File

@@ -163,7 +163,8 @@ class Invoice extends Model implements IDs
public function items()
{
return $this->hasMany(InvoiceItem::class)
->where('active',TRUE);
->where('active',TRUE)
->with(['taxes','product']);
}
public function payments()
@@ -402,8 +403,7 @@ class Invoice extends Model implements IDs
$return->push($po);
}
$lo = $this->account->user->language;
return $return->sortBy(function ($item) use ($lo) {
return $return->sortBy(function ($item) {
return $item->name;
});
}

3
app/Models/Product/Broadband.php
View File

@@ -10,6 +10,7 @@ use App\Models\Supplier;
use App\Models\Service\Broadband as ServiceBroadband;
use App\Models\Supplier\Broadband as SupplierBroadband;
// @todo does this need to extend Type? Perhaps have a ProductType consistent with ServiceType.
final class Broadband extends Type implements ProductItem
{
use ScopeActive;
@@ -44,7 +45,7 @@ final class Broadband extends Type implements ProductItem
*/
public function supplied()
{
return $this->hasOne(SupplierBroadband::class,'id','supplier_broadband_id');
return $this->hasOne(SupplierBroadband::class,'id','supplier_item_id');
}
/* INTERFACES */

2
app/Models/Product/Domain.php
View File

@@ -24,7 +24,7 @@ final class Domain extends Type implements ProductItem
*/
public function supplied()
{
return $this->hasOne(SupplierDomain::class,'id','supplier_domain_id');
return $this->hasOne(SupplierDomain::class,'id','supplier_item_id');
}
/* INTERFACES */

2
app/Models/Product/Email.php
View File

@@ -24,7 +24,7 @@ final class Email extends Type implements ProductItem
*/
public function supplied()
{
return $this->hasOne(SupplierEmail::class,'id','supplier_email_id');
return $this->hasOne(SupplierEmail::class,'id','supplier_item_id');
}
/* INTERFACES */

2
app/Models/Product/Generic.php
View File

@@ -24,7 +24,7 @@ final class Generic extends Type implements ProductItem
*/
public function supplied()
{
return $this->hasOne(SupplierGeneric::class,'id','supplier_generic_id');
return $this->hasOne(SupplierGeneric::class,'id','supplier_item_id');
}
/* INTERFACES */

2
app/Models/Product/Host.php
View File

@@ -24,7 +24,7 @@ final class Host extends Type implements ProductItem
*/
public function supplied()
{
return $this->hasOne(SupplierHost::class,'id','supplier_host_id');
return $this->hasOne(SupplierHost::class,'id','supplier_item_id');
}
/* INTERFACES */

17
app/Models/Product/Voip.php → app/Models/Product/Phone.php
View File

@@ -5,18 +5,18 @@ namespace App\Models\Product;
use Illuminate\Support\Collection;
use App\Interfaces\ProductItem;
use App\Models\Service\Voip as ServiceVoip;
use App\Models\Supplier\Voip as SupplierVoip;
use App\Models\Service\Phone as ServicePhone;
use App\Models\Supplier\Phone as SupplierPhone;
final class Voip extends Type implements ProductItem
final class Phone extends Type implements ProductItem
{
protected $table = 'product_voip';
protected $table = 'product_phone';
protected array $order_attributes = [
'options.phonenumber'=>[
'request'=>'options.phonenumber',
'key'=>'service_number',
'validation'=>'nullable|size:10|unique:ab_service__voip,service_number',
'validation'=>'nullable|size:10|unique:service_phone,service_number',
'validation_message'=>'Phone Number is a required field.',
],
'options.supplier'=>[
@@ -40,7 +40,7 @@ final class Voip extends Type implements ProductItem
];
// The model that is referenced when this product is ordered
protected string $order_model = ServiceVoip::class;
protected string $order_model = ServicePhone::class;
/* RELATIONS */
@@ -51,19 +51,20 @@ final class Voip extends Type implements ProductItem
*/
public function supplied()
{
return $this->hasOne(SupplierVoip::class,'id','supplier_voip_id');
return $this->hasOne(SupplierPhone::class,'id','supplier_item_id');
}
/* INTERFACES */
public function getContractTermAttribute(): int
{
// @todo Get this from the DB
return 12;
}
public function getTypeAttribute()
{
return 'VOIP';
return 'PHONE';
}
public function hasUsage(): bool

14
app/Models/Product/SSL.php
View File

@@ -24,7 +24,7 @@ final class SSL extends Type implements ProductItem
*/
public function supplied()
{
return $this->hasOne(SupplierSSL::class,'id','supplier_ssl_id');
return $this->hasOne(SupplierSSL::class,'id','supplier_item_id');
}
/* INTERFACES */
@@ -52,19 +52,9 @@ final class SSL extends Type implements ProductItem
return 0;
}
public function getProductAttribute()
{
$o = new \stdClass();
$o->product_id = 'INT';
$o->setup_cost = 0;
$o->base_cost = 0;
$o->contract_term = 0; // @todo
return $o;
}
public function getSupplierAttribute()
{
abort(500,'deprecated');
$o = new \stdClass();
$o->name = 'Internal';

4
app/Models/Product/Type.php
View File

@@ -7,6 +7,10 @@ use Illuminate\Database\Eloquent\Model;
use App\Models\Product;
use App\Traits\{OrderServiceOptions,SiteID};
/**
* @todo These tables have a base_cost/setup_cost/contract_term columns - how is that different to the supplier_tables?
* @todo Ensure our terminology is consistent - we have a "cost", we "charge" clients.
*/
abstract class Type extends Model
{
use SiteID,OrderServiceOptions;

97
app/Models/Service.php
View File

@@ -18,35 +18,35 @@ use Leenooks\Carbon;
use Symfony\Component\HttpKernel\Exception\HttpException;
use App\Interfaces\IDs;
use App\Traits\NextKey;
/**
* Class Service
* Services that belong to an account
*
* Attributes for services:
* + additional_cost : Pending additional charges for this service (excluding setup)
* + additional_cost : Pending additional charges for this service (excluding setup) //@todo check all these are still valid
* + billing_cost : Charge for this service each invoice period
* + billing_interval : The period that this service is billed for by default
* + billing_interval_string : The period that this service is billed for by default as a name
* + contract_term : The term that this service must be active
* + contract_end : The date that the contract ends for this service
* + name : Service short name with service address
* + name_short : Service Product short name, eg: phone number, domain name, certificate CN
* + name_detail : Service Detail, eg: service_address
* + sid : System ID for service
*
* = Terminology:
* - Offering, what product we supply (we make offerings from supplier's supplied products) - in the DB these are products/*
* - Supplied, our supplier's product that is providing the service - in the DB these are supplier/*
* - Type, what service we are providing, made up of a product we supply - in the DB these are service/*
*
* @package App\Models
* @todo "Billing Start Date" = "connection date" for sub types??
*/
// @todo All the methods/attributes in this file need to be checked.
class Service extends Model implements IDs
{
use HasFactory,NextKey;
const RECORD_ID = 'service';
public $incrementing = FALSE;
protected $table = 'ab_service';
const CREATED_AT = 'date_orig';
const UPDATED_AT = 'date_last';
use HasFactory;
protected $appends = [
'account_name',
@@ -59,17 +59,16 @@ class Service extends Model implements IDs
'status',
];
protected $dates = [
'date_last_invoice',
'date_next_invoice',
'date_start',
'date_end',
];
protected $casts = [
'order_info'=>AsCollection::class,
];
public $dateFormat = 'U';
protected $dates = [
'invoice_last_at',
'invoice_next_at',
'start_at',
'stop_at',
];
protected $visible = [
'account_name',
@@ -484,7 +483,6 @@ class Service extends Model implements IDs
* Return the auto billing details
*
* @return mixed
* @deprecated use billing directly?
*/
public function getAutoPayAttribute()
{
@@ -536,6 +534,33 @@ class Service extends Model implements IDs
return Invoice::billing_name($this->getBillingIntervalAttribute());
}
/**
* The date the contract ends
*
* Service contracts end the later of the start_date + contract_term or the expire date.
*
* @return Carbon
*/
public function getContractEndAttribute(): ?\Carbon\Carbon
{
// If we have no start date or expire date, then NULL;
if (! $this->start_at && ! $this->type->expire_at)
return NULL;
// If we dont have a start date, use the expire date
if (! $this->start_at)
return $this->type->expire_at;
$end = $this->start_at->addMonths($this->getContractTermAttribute());
// If we dont have an expire date, use the start date + contract_term
if (! $this->type->expire_at)
return $end;
// We have both, so it's the later of the two.
return ($end < $this->type->expire_at) ? $this->type->expire_at : $end;
}
/**
* This function will determine the minimum contract term for a service, which is the maximum of
* this::type->contract_term, or the product->type->contract_term();
@@ -544,7 +569,7 @@ class Service extends Model implements IDs
*/
public function getContractTermAttribute(): int
{
abort(500,'To implement (Dec 2021)');
return $this->product->type->supplied->contract_term ?: 0;
}
/**
@@ -570,7 +595,7 @@ class Service extends Model implements IDs
$date = $last
? $last->addDay()
: ($this->date_next_invoice ? $this->date_next_invoice->clone()
: ($this->date_start ?: Carbon::now()));
: ($this->start_at ?: Carbon::now()));
return request()->wantsJson() ? $date->format('Y-m-d') : $date;
}
@@ -705,8 +730,9 @@ class Service extends Model implements IDs
: NULL;
// For SSL Certificates, the invoice_to date is the expiry date of the Cert
if (is_null($result) AND $this->type AND $this->type->type == 'ssl' AND $this->type->valid_to)
return $this->type->valid_to;
// @todo can we use the expire_at attribute?
if (is_null($result) AND $this->type AND $this->type->type == 'ssl' AND $this->type->expire_at)
return $this->type->expire_at;
return $result;
}
@@ -751,6 +777,17 @@ class Service extends Model implements IDs
return $this->getInvoiceNextAttribute();
}
/**
* The product we supply for this service
*
* @return Model
* @todo Remove all references to product->type to use this method
*/
public function getOfferingAttribute(): Model
{
return $this->product->type;
}
public function getOrderInfoNotesAttribute(): ?string
{
return $this->getOrderInfoValue('notes');
@@ -954,6 +991,16 @@ class Service extends Model implements IDs
return ($this->product->type && $this->product->type->supplied) ? $this->product->type->supplied->getTypeAttribute() : '** TBA **';
}
/**
* Get the service providers offering that we are providing for this service
*
* @return Model|null
*/
public function getSupplierProductAttribute(): ?Model
{
dd($this->product,$this->product->type,$this->product->type->supplied);
}
/**
* URL used by an admin to administer the record
*
@@ -1397,11 +1444,11 @@ class Service extends Model implements IDs
switch ($this->product->prod_plugin_file)
{
case 'ADSL': return $this->service_adsl;
case 'BROADBAND': return $this->service_broadband;
case 'DOMAIN': return $this->service_domain;
case 'HOST': return $this->service_host;
case 'SSL': return $this->service_ssl;
case 'VOIP': return $this->service_voip;
case 'PHONE': return $this->service_voip;
default: return NULL;
}

124
app/Models/Service/Broadband.php
View File

@@ -6,24 +6,64 @@ use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;
use Leenooks\Carbon;
use App\Interfaces\{ServiceItem,ServiceUsage};
use App\Interfaces\ServiceUsage;
use App\Models\Base\ServiceType;
use App\Models\Supplier\Broadband as SupplierBroadband;
use App\Traits\NextKey;
use App\Models\Supplier\Type;
class Broadband extends ServiceType implements ServiceItem,ServiceUsage
/**
* Class Broadband (Service)
* Services that are Internet Broadband
*/
class Broadband extends ServiceType implements ServiceUsage
{
private const LOGKEY = 'MSA';
use NextKey;
const RECORD_ID = 'service__adsl';
private const LOGKEY = 'MSB';
protected $dates = [
'service_connect_date',
'service_contract_date'
'connect_at',
'expire_at',
];
public $dateFormat = 'U';
protected $table = 'ab_service__adsl';
protected $table = 'service_broadband';
/* ABSTRACT */
/**
* Search for a record
*
* @param $query
* @param string $term
* @return mixed
*/
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.'%');
}
/* INTERFACES */
/**
* Return the service address
*
* @return string
*/
public function getServiceDescriptionAttribute(): string
{
return strtoupper($this->service_address) ?: '-';
}
/**
* Return the service number
*
* @return string
*/
public function getServiceNameAttribute(): string
{
return $this->service_number ?: ($this->service_address ?: '-');
}
/* RELATIONS */
@@ -38,79 +78,37 @@ class Broadband extends ServiceType implements ServiceItem,ServiceUsage
return $this->hasMany(AdslTraffic::class,'ab_service_adsl_id');
}
/* SCOPES */
/**
* 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.'%');
}
/* ATTRIBUTES */
/**
* @deprecated use $o->service_name;
* @return mixed|string
*/
/* ATTRIBUTES */
public function getNameAttribute()
{
abort(500,'deprecated - use $o->service_name');
return $this->service_number ?: $this->service_address;
}
/**
* Return the service address
* The type of technology used to provide this Internet Service
*
* @return string
* @param $value
* @return null|string
*/
public function getServiceDescriptionAttribute(): string
public function getTechnologyAttribute($value): ?string
{
return strtoupper($this->service_address) ?: 'NO Service Address';
}
public function getServiceExpireAttribute(): \Carbon\Carbon
{
// TODO: Implement getServiceExpireAttribute() method.
}
/**
* Return the service number
*
* @return string
*/
public function getServiceNameAttribute(): string
{
return $this->service_number ?: $this->service_address;
return $value ?: $this->supplied()->technology;
}
/* METHODS */
/**
* Is this service currently in a contract
*
* @return bool
*/
public function inContract(): bool
{
return $this->service_contract_date AND $this->service_contract_date->addMonths($this->contract_term)->isFuture();
}
/**
* Return the suppliers offering that this service is providing
*
* @return SupplierBroadband
* @return Type
*/
public function supplied(): SupplierBroadband
public function supplied(): Type
{
return $this->provided_adsl_plan_id
? SupplierBroadband::findOrFail($this->provided_adsl_plan_id)
@@ -184,4 +182,4 @@ class Broadband extends ServiceType implements ServiceItem,ServiceUsage
return $result;
}
}
}

84
app/Models/Service/Domain.php
View File

@@ -2,97 +2,25 @@
namespace App\Models\Service;
use Carbon\Carbon;
use App\Models\Base\ServiceType;
use App\Models\{Account,DomainRegistrar,DomainTld,Service};
use App\Interfaces\ServiceItem;
use App\Traits\{NextKey,ScopeServiceActive,ScopeServiceUserAuthorised};
use App\Traits\ServiceDomains;
use App\Models\DomainRegistrar;
/**
* Class Domain (Service)
* Services that domain names
*
* Attributes for services:
* + service_description : Description as shown in a Service Context
* + service_expire : The date the service expires
* + service_name : Name as shown in a Service Context
*
* @package App\Models\Service
* Services that are managed Domain Names
*/
class Domain extends ServiceType implements ServiceItem
class Domain extends ServiceType
{
use ScopeServiceActive,ScopeServiceUserAuthorised;
use ServiceDomains;
protected $dates = [
'domain_expire',
];
public $dateFormat = 'U';
protected $table = 'service_domains';
protected $table = 'service_domain';
protected $with = ['tld'];
/* INTERFACES */
public function getServiceDescriptionAttribute(): string
{
// N/A
return 'Domain Name';
}
public function getServiceExpireAttribute(): Carbon
{
return $this->domain_expire;
}
/**
* The name of the domain with its TLD
*
* @return string
*/
public function getServiceNameAttribute(): string
{
return strtoupper(sprintf('%s.%s',$this->domain_name,$this->tld->name));
}
public function inContract(): bool
{
return $this->domain_expire->isFuture();
}
/* RELATIONS */
public function account()
{
return $this->hasOneThrough(Account::class,Service::class);
}
public function registrar()
{
return $this->belongsTo(DomainRegistrar::class,'domain_registrar_id');
}
public function tld()
{
return $this->belongsTo(DomainTld::class,'domain_tld_id');
}
/* SCOPES */
/**
* Search for a record
*
* @param $query
* @param string $term
* @return mixed
*/
public function scopeSearch($query,string $term)
{
// If we have a period in the name, we'll ignore everything after it.
$term = strstr($term,'.',TRUE) ?: $term;
// Build our where clause
return parent::scopeSearch($query,$term)
->orwhere('domain_name','like','%'.$term.'%');
}
/* ATTRIBUTES */
}

59
app/Models/Service/Email.php
View File

@@ -2,64 +2,17 @@
namespace App\Models\Service;
use Carbon\Carbon;
use App\Models\Base\ServiceType;
use App\Models\{Account, DomainRegistrar, DomainTld, Service, TLD};
use App\Interfaces\ServiceItem;
use App\Traits\{NextKey,ScopeServiceActive,ScopeServiceUserAuthorised};
use App\Traits\ServiceDomains;
/**
* Class Email (Service)
* Services that email hostings
*
* Attributes for services:
* + service_description : Description as shown in a Service Context
* + service_expire : The date the service expires
* + service_name : Name as shown in a Service Context
*
* @package App\Models\Service
* Services that are Email Hosting
*/
class Email extends ServiceType implements ServiceItem
class Email extends ServiceType
{
use ScopeServiceActive,ScopeServiceUserAuthorised;
use ServiceDomains;
protected $dates = ['expire_at'];
protected $table = 'service_emails';
/* INTERFACES */
public function getServiceDescriptionAttribute(): string
{
// N/A
return 'Email Hosting';
}
public function getServiceExpireAttribute(): Carbon
{
return $this->expire_at ?: $this->service->next_invoice;
}
/**
* The name of the domain with its TLD
*
* @return string
* // @todo
*/
public function getServiceNameAttribute(): string
{
return strtoupper(sprintf('%s.%s',$this->domain_name,$this->tld->name));
}
public function inContract(): bool
{
return $this->expire_at && $this->expire_at->isFuture();
}
/* RELATIONS */
public function tld()
{
return $this->belongsTo(TLD::class);
}
protected $table = 'service_email';
protected $with = ['tld'];
}

13
app/Models/Service/Generic.php
View File

@@ -4,8 +4,21 @@ namespace App\Models\Service;
use App\Models\Base\ServiceType;
// @todo Document how this is used.
class Generic extends ServiceType
{
protected $table = 'service__generic';
public $timestamps = FALSE;
/* INTERFACE */
public function getServiceDescriptionAttribute(): string
{
return 'Generic';
}
public function getServiceNameAttribute(): string
{
return 'Generic';
}
}

52
app/Models/Service/Host.php
View File

@@ -2,55 +2,25 @@
namespace App\Models\Service;
use Carbon\Carbon;
use App\Interfaces\ServiceItem;
use App\Models\Base\ServiceType;
use App\Models\DomainTld;
use App\Traits\ServiceDomains;
use App\Models\HostServer;
use App\Traits\NextKey;
use App\Traits\{ScopeServiceActive,ScopeServiceUserAuthorised};
class Host extends ServiceType implements ServiceItem
/**
* Class Host (Service)
* Services that are Web Hosting
*/
class Host extends ServiceType
{
use ScopeServiceActive,ScopeServiceUserAuthorised;
use NextKey;
const RECORD_ID = 'service__hosting';
use ServiceDomains;
protected $dates = [
'host_expire',
];
public $dateFormat = 'U';
protected $table = 'ab_service__hosting';
protected $table = 'service_host';
protected $with = ['tld'];
/* RELATIONS */
public function provider()
{
return $this->belongsTo(HostServer::class,'host_server_id');
}
public function tld()
{
return $this->belongsTo(DomainTld::class,'domain_tld_id');
}
public function getServiceDescriptionAttribute(): string
{
// N/A
return 'Hosting';
}
public function getServiceExpireAttribute(): Carbon
{
return $this->host_expire;
}
public function getServiceNameAttribute(): string
{
return sprintf('%s.%s',strtoupper($this->domain_name),strtoupper($this->tld->name));
}
public function inContract(): bool
{
return $this->host_expire->isFuture();
}
}

70
app/Models/Service/Phone.php Normal file
View File

@@ -0,0 +1,70 @@
<?php
namespace App\Models\Service;
use App\Models\Base\ServiceType;
/**
* Class Phone (Service)
* Services that are Voice Telephony
*/
class Phone extends ServiceType
{
protected $dates = [
'connect_at',
'expire_at',
];
protected $table = 'service_phone';
/* ABSTRACT */
/**
* Search for a record
*
* @param $query
* @param string $term
* @return mixed
*/
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.'%');
}
/* INTERFACES */
/**
* Return the service address
*
* @return string
*/
public function getServiceDescriptionAttribute(): string
{
return strtoupper($this->service_address) ?: '-';
}
/**
* Return the service number
*
* @return string
*/
public function getServiceNameAttribute(): string
{
return $this->service_number ?: ($this->service_address ?: '-');
}
/* ATTRIBUTES */
/**
* The type of technology used to provide this Internet Service
*
* @param $value
* @return null|string
*/
public function getTechnologyAttribute($value): ?string
{
return $value ?: $this->supplied()->technology;
}
}

66
app/Models/Service/SSL.php
View File

@@ -5,19 +5,20 @@ namespace App\Models\Service;
use Illuminate\Support\Arr;
use Carbon\Carbon;
use App\Interfaces\ServiceItem;
use App\Models\Base\ServiceType;
use App\Traits\NextKey;
class SSL extends ServiceType implements ServiceItem
/**
* Class SSL (Service)
* Services that are provide an SSL Certificate
*/
class SSL extends ServiceType
{
use NextKey;
const RECORD_ID = 'service__ssl';
protected $table = 'service_ssl';
protected $table = 'ab_service__ssl';
protected $crt_parse = NULL;
protected $public_key = NULL;
protected $crt_parse = NULL;
/* STATIC */
public static function boot()
{
@@ -33,11 +34,27 @@ class SSL extends ServiceType implements ServiceItem
});
}
public function getValidToAttribute()
/* ABSTRACT */
/**
* Search for a record
*
* @param $query
* @param string $term
* @return mixed
*/
public function scopeSearch($query,string $term)
{
return $this->cert ? Carbon::createFromTimestamp($this->crt_parse->get('validTo_time_t')) : NULL;
// @todo
}
/* INTERFACES */
/**
* Return the Cert DN
*
* @return string
*/
public function getServiceDescriptionAttribute(): string
{
if ($this->cert)
@@ -58,11 +75,19 @@ class SSL extends ServiceType implements ServiceItem
}
}
public function getServiceExpireAttribute(): Carbon
/**
* Return the Certificate Expiry Date
*/
public function getServiceExpireAttribute(): ?Carbon
{
// TODO: Implement getServiceExpireAttribute() method.
return $this->cert ? Carbon::createFromTimestamp($this->crt_parse->get('validTo_time_t')) : NULL;
}
/**
* Return the Cert Name
*
* @return string
*/
public function getServiceNameAttribute(): string
{
return $this->cert
@@ -70,9 +95,24 @@ class SSL extends ServiceType implements ServiceItem
: Arr::get(openssl_csr_get_subject($this->csr),'CN','');
}
/**
* Certificates have no contract and can be cancelled anytime.
*
* @return bool
*/
public function inContract(): bool
{
// N/A
return FALSE;
}
/* METHODS */
/**
* @return Carbon|null
* @deprecated use getServiceExpireAttribute()
*/
public function getValidToAttribute()
{
abort(500,'use getServiceExpireAttribute');
}
}

72
app/Models/Service/Voip.php
View File

@@ -1,72 +0,0 @@
<?php
namespace App\Models\Service;
use App\Interfaces\ServiceItem;
use App\Models\Base\ServiceType;
use App\Traits\NextKey;
use Carbon\Carbon;
class Voip extends ServiceType implements ServiceItem
{
use NextKey;
const RECORD_ID = 'service__adsl';
protected $dates = [
'service_connect_date',
'service_contract_date',
];
public $dateFormat = 'U';
protected $table = 'ab_service__voip';
/* SCOPES */
/**
* 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.'%');
}
/* ATTRIBUTES */
/**
* Return the service address
*
* @return string
*/
public function getServiceDescriptionAttribute(): string
{
return $this->service_address ?: 'VOIP';
}
public function getServiceExpireAttribute(): Carbon
{
// TODO: Implement getServiceExpireAttribute() method.
}
/**
* Return the service number
*
* @return string
*/
public function getServiceNameAttribute(): string
{
return $this->service_number ?: ($this->service_address ?: 'Unknown');
}
/* METHODS */
public function inContract(): bool
{
return $this->service_contract_date AND $this->service_contract_date->addMonths($this->contract_term)->isFuture();
}
}

16
app/Models/ServiceChange.php Normal file
View File

@@ -0,0 +1,16 @@
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
/**
* This model records the changes made to services
*
* @package App\Models
*/
class ServiceChange extends Model
{
protected $table = 'service__change';
public $timestamps = FALSE;
}

15
app/Models/Supplier.php
View File

@@ -7,7 +7,7 @@ use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Leenooks\Traits\ScopeActive;
use App\Models\Supplier\{Broadband,Domain,Email,Ethernet,Generic,Host,HSPA,Voip};
use App\Models\Supplier\{Broadband,Domain,Email,Ethernet,Generic,Host,HSPA,Phone,SSL};
class Supplier extends Model
{
@@ -45,14 +45,21 @@ class Supplier extends Model
'name' => 'Hosting',
'class' => Host::class,
],
'voip' => [
'name' => 'VOIP Telephone',
'class' => Voip::class,
'phone' => [
'name' => 'Phone',
'class' => Phone::class,
],
'ssl' => [
'name' => 'SSL',
'class' => SSL::class,
],
];
/* RELATIONS */
// @todo Need to put in an integrity constraint to support the hasOne()
// @todo Some suppliers have multiple different configuration urls/passwords and contacts for different types of services, perhaps this should be hasMany()?
// EG: Crazy Domains, "domains" and "hosting".
public function detail()
{
return $this->hasOne(SupplierDetail::class);

3
app/Models/Supplier/Broadband.php
View File

@@ -8,6 +8,7 @@ use Illuminate\Support\Collection;
use App\Interfaces\SupplierItem;
use App\Models\Product\Broadband as ProductBroadband;
// @todo does this need to extend Type? Perhaps have a SupplierType consistent with ServiceType.
class Broadband extends Type implements SupplierItem
{
protected $casts = [
@@ -37,7 +38,7 @@ class Broadband extends Type implements SupplierItem
public function types()
{
return $this->belongsToMany(ProductBroadband::class,$this->table,'id','id','id',$this->table.'_id');
return $this->belongsToMany(ProductBroadband::class,$this->table,'id','id','id','supplier_item_id');
}
public function getBillingIntervalAttribute(): int

2
app/Models/Supplier/Domain.php
View File

@@ -24,7 +24,7 @@ final class Domain extends Type implements SupplierItem
public function types()
{
return $this->belongsToMany(ProductDomain::class,$this->table,'id','id','id',$this->table.'_id');
return $this->belongsToMany(ProductDomain::class,$this->table,'id','id','id','supplier_item_id');
}
/* RELATIONS */

2
app/Models/Supplier/Email.php
View File

@@ -18,6 +18,6 @@ final class Email extends Type implements SupplierItem
public function types()
{
return $this->belongsToMany(ProductEmail::class,$this->table,'id','id','id',$this->table.'_id');
return $this->belongsToMany(ProductEmail::class,$this->table,'id','id','id','supplier_item_id');
}
}

2
app/Models/Supplier/Generic.php
View File

@@ -13,7 +13,7 @@ final class Generic extends Type implements SupplierItem
public function types()
{
return $this->belongsToMany(ProductGeneric::class,$this->table,'id','id','id',$this->table.'_id');
return $this->belongsToMany(ProductGeneric::class,$this->table,'id','id','id','supplier_item_id');
}
public function getBillingIntervalAttribute(): int

2
app/Models/Supplier/Host.php
View File

@@ -13,7 +13,7 @@ final class Host extends Type implements SupplierItem
public function types()
{
return $this->belongsToMany(ProductHost::class,$this->table,'id','id','id',$this->table.'_id');
return $this->belongsToMany(ProductHost::class,$this->table,'id','id','id','supplier_item_id');
}
public function getBillingIntervalAttribute(): int

8
app/Models/Supplier/Voip.php → app/Models/Supplier/Phone.php
View File

@@ -3,17 +3,17 @@
namespace App\Models\Supplier;
use App\Interfaces\SupplierItem;
use App\Models\Product\Voip as ProductVoip;
use App\Models\Product\Phone as ProductVoip;
final class Voip extends Type implements SupplierItem
final class Phone extends Type implements SupplierItem
{
protected $table = 'supplier_voip';
protected $table = 'supplier_phone';
/* INTERFACES */
public function types()
{
return $this->belongsToMany(ProductVoip::class,$this->table,'id','id','id',$this->table.'_id');
return $this->belongsToMany(ProductVoip::class,$this->table,'id','id','id','supplier_item_id');
}
public function getBillingIntervalAttribute(): int

2
app/Models/Supplier/SSL.php
View File

@@ -13,7 +13,7 @@ final class SSL extends Type implements SupplierItem
public function types()
{
return $this->belongsToMany(ProductSSL::class,$this->table,'id','id','id',$this->table.'_id');
return $this->belongsToMany(ProductSSL::class,$this->table,'id','id','id','supplier_item_id');
}
public function getBillingIntervalAttribute(): int

4
app/Traits/ScopeServiceActive.php
View File

@@ -15,10 +15,10 @@ trait ScopeServiceActive
public function scopeServiceActive($query)
{
return $query->where(function($q) {
return $q->where('ab_service.active',TRUE)
return $q->where('services.active',TRUE)
->orWhere(function($q) {
return $q->whereNotNull('order_status')
->whereNotIn('ab_service.order_status',Service::INACTIVE_STATUS);
->whereNotIn('services.order_status',Service::INACTIVE_STATUS);
});
});
}

2
app/Traits/ScopeServiceUserAuthorised.php
View File

@@ -16,6 +16,6 @@ trait ScopeServiceUserAuthorised
public function scopeServiceUserAuthorised($query,User $uo)
{
return $query
->whereIN('ab_service.account_id',$uo->all_accounts()->pluck('id')->unique()->toArray());
->whereIN('services.account_id',$uo->all_accounts()->pluck('id')->unique()->toArray());
}
}

59
app/Traits/ServiceDomains.php Normal file
View File

@@ -0,0 +1,59 @@
<?php
/**
* Service Types that have a domain name attribute.
*/
namespace App\Traits;
use App\Models\TLD;
trait ServiceDomains
{
/* INTERFACES */
/**
* There is no detailed description for domain services
*
* @return string
*/
public function getServiceDescriptionAttribute(): string
{
return '';
}
/**
* The name of the domain with its TLD
*
* @return string
*/
public function getServiceNameAttribute(): string
{
return strtoupper(sprintf('%s.%s',$this->domain_name,$this->tld->name));
}
/* RELATIONS */
public function tld()
{
return $this->belongsTo(TLD::class);
}
/* SCOPES */
/**
* Search for a record
*
* @param $query
* @param string $term
* @return mixed
*/
public function scopeSearch($query,string $term)
{
// If we have a period in the name, we'll ignore everything after it.
$term = strstr($term,'.',TRUE) ?: $term;
// Build our where clause
return parent::scopeSearch($query,$term)
->orwhere('domain_name','like','%'.$term.'%');
}
}