1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-13 22:54:25 +01:00
invoiceninja/app/Ninja/Transformers/VendorTransformer.php
Louis-Rémi Babé 9f1df5e924 Fix remaining swagger docs errors
+ Take @hillelcoren remarks into account
2017-03-09 11:11:45 +01:00

92 lines
3.8 KiB
PHP

<?php
namespace App\Ninja\Transformers;
use App\Models\Account;
use App\Models\Vendor;
// vendor
/**
* @SWG\Definition(definition="Vendor", @SWG\Xml(name="Vendor"))
*/
class VendorTransformer extends EntityTransformer
{
/**
* @SWG\Property(property="id", type="integer", example=1, readOnly=true)
* @SWG\Property(property="balance", type="number", format="float", example=10, readOnly=true)
* @SWG\Property(property="paid_to_date", type="number", format="float", example=10, readOnly=true)
* @SWG\Property(property="user_id", type="integer", example=1)
* @SWG\Property(property="account_key", type="string", example="123456")
* @SWG\Property(property="updated_at", type="integer", example=1451160233, readOnly=true)
* @SWG\Property(property="archived_at", type="integer", example=1451160233, readOnly=true)
* @SWG\Property(property="address1", type="string", example="10 Main St.")
* @SWG\Property(property="address2", type="string", example="1st Floor")
* @SWG\Property(property="city", type="string", example="New York")
* @SWG\Property(property="state", type="string", example="NY")
* @SWG\Property(property="postal_code", type="string", example=10010)
* @SWG\Property(property="country_id", type="integer", example=840)
* @SWG\Property(property="work_phone", type="string", example="(212) 555-1212")
* @SWG\Property(property="private_notes", type="string", example="Notes...")
* @SWG\Property(property="last_login", type="string", format="date-time", example="2016-01-01 12:10:00")
* @SWG\Property(property="website", type="string", example="http://www.example.com")
* @SWG\Property(property="is_deleted", type="boolean", example=false)
* @SWG\Property(property="vat_number", type="string", example="123456")
* @SWG\Property(property="id_number", type="string", example="123456")
*/
protected $defaultIncludes = [
'vendor_contacts',
];
protected $availableIncludes = [
'invoices',
//'expenses',
];
public function includeVendorContacts(Vendor $vendor)
{
$transformer = new VendorContactTransformer($this->account, $this->serializer);
return $this->includeCollection($vendor->vendor_contacts, $transformer, ENTITY_CONTACT);
}
public function includeInvoices(Vendor $vendor)
{
$transformer = new InvoiceTransformer($this->account, $this->serializer);
return $this->includeCollection($vendor->invoices, $transformer, ENTITY_INVOICE);
}
public function includeExpenses(Vendor $vendor)
{
$transformer = new ExpenseTransformer($this->account, $this->serializer);
return $this->includeCollection($vendor->expenses, $transformer, ENTITY_EXPENSE);
}
public function transform(Vendor $vendor)
{
return array_merge($this->getDefaults($vendor), [
'id' => (int) $vendor->public_id,
'name' => $vendor->name,
'balance' => (float) $vendor->balance,
'paid_to_date' => (float) $vendor->paid_to_date,
'updated_at' => $this->getTimestamp($vendor->updated_at),
'archived_at' => $this->getTimestamp($vendor->deleted_at),
'address1' => $vendor->address1,
'address2' => $vendor->address2,
'city' => $vendor->city,
'state' => $vendor->state,
'postal_code' => $vendor->postal_code,
'country_id' => (int) $vendor->country_id,
'work_phone' => $vendor->work_phone,
'private_notes' => $vendor->private_notes,
'last_login' => $vendor->last_login,
'website' => $vendor->website,
'is_deleted' => (bool) $vendor->is_deleted,
'vat_number' => $vendor->vat_number,
'id_number' => $vendor->id_number,
'currency_id' => (int) $vendor->currency_id,
]);
}
}