invoiceninja/app/Transformers/RecurringInvoiceTransformer.php

<?php
/**
 * Invoice Ninja (https://invoiceninja.com)
 *
 * @link https://github.com/invoiceninja/invoiceninja source repository
 *
 * @copyright Copyright (c) 2019. Invoice Ninja LLC (https://invoiceninja.com)
 *
 * @license https://opensource.org/licenses/AAL
 */

namespace App\Transformers;

use App\Models\Invoice;
use App\Models\RecurringInvoice;
use App\Utils\Traits\MakesHash;

/**
 * @SWG\Definition(definition="Invoice", required={"invoice_number"}, @SWG\Xml(name="Invoice"))
 */
class RecurringInvoiceTransformer extends EntityTransformer
{
    use MakesHash;
    /**
    * @SWG\Property(property="id", type="integer", example=1, readOnly=true)
    * @SWG\Property(property="amount", type="number", format="float", example=10, readOnly=true)
    * @SWG\Property(property="balance", type="number", format="float", example=10, readOnly=true)
    * @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="is_deleted", type="boolean", example=false, readOnly=true)
    * @SWG\Property(property="client_id", type="integer", example=1)
    * @SWG\Property(property="status_id", type="integer", example=1, readOnly=true)
    * @SWG\Property(property="invoice_number", type="string", example="0001")
    * @SWG\Property(property="discount", type="number", format="float", example=10)
    * @SWG\Property(property="po_number", type="string", example="0001")
    * @SWG\Property(property="invoice_date", type="string", format="date", example="2018-01-01")
    * @SWG\Property(property="due_date", type="string", format="date", example="2018-01-01")
    * @SWG\Property(property="terms", type="string", example="sample")
    * @SWG\Property(property="private_notes", type="string", example="Notes")
    * @SWG\Property(property="public_notes", type="string", example="Notes")
    * @SWG\Property(property="invoice_type_id", type="integer", example=1, readOnly=true)
    * @SWG\Property(property="is_recurring", type="boolean", example=false)
    * @SWG\Property(property="frequency_id", type="integer", example=1)
    * @SWG\Property(property="start_date", type="string", format="date", example="2018-01-01")
    * @SWG\Property(property="end_date", type="string", format="date", example="2018-01-01")
    * @SWG\Property(property="last_sent_date", type="string", format="date", example="2018-01-01", readOnly=true)
    * @SWG\Property(property="recurring_invoice_id", type="integer", example=1, readOnly=true)
    * @SWG\Property(property="tax_name1", type="string", example="VAT")
    * @SWG\Property(property="tax_name2", type="string", example="Upkeep")
    * @SWG\Property(property="tax_rate1", type="number", format="float", example="17.5")
    * @SWG\Property(property="tax_rate2", type="number", format="float", example="30.0")
    * @SWG\Property(property="is_amount_discount", type="boolean", example=false)
    * @SWG\Property(property="invoice_footer", type="string", example="Footer")
    * @SWG\Property(property="partial", type="number",format="float", example=10)
    * @SWG\Property(property="partial_due_date", type="string", format="date", example="2018-01-01")
    * @SWG\Property(property="has_tasks", type="boolean", example=false, readOnly=true)
    * @SWG\Property(property="auto_bill", type="boolean", example=false)
    * @SWG\Property(property="custom_value1", type="number",format="float", example=10)
    * @SWG\Property(property="custom_value2", type="number",format="float", example=10)
    * @SWG\Property(property="custom_taxes1", type="boolean", example=false)
    * @SWG\Property(property="custom_taxes2", type="boolean", example=false)
    * @SWG\Property(property="has_expenses", type="boolean", example=false, readOnly=true)
    * @SWG\Property(property="quote_invoice_id", type="integer", example=1, readOnly=true)
    * @SWG\Property(property="custom_text_value1", type="string", example="Custom Text Value")
    * @SWG\Property(property="custom_text_value2", type="string", example="Custom Text Value")
    * @SWG\Property(property="is_quote", type="boolean", example=false, readOnly=true)
    * @SWG\Property(property="is_public", type="boolean", example=false)
    * @SWG\Property(property="filename", type="string", example="Filename", readOnly=true)
    */
    protected $defaultIncludes = [
    //    'invoice_items',
    ];

    protected $availableIncludes = [
    //    'invitations',
    //    'payments',
    //    'client',
    //    'documents',
    ];

/*
    public function includeInvoiceItems(Invoice $invoice)
    {
        $transformer = new InvoiceItemTransformer($this->serializer);

        return $this->includeCollection($invoice->invoice_items, $transformer, ENTITY_INVOICE_ITEM);
    }

    public function includeInvitations(Invoice $invoice)
    {
        $transformer = new InvitationTransformer($this->account, $this->serializer);

        return $this->includeCollection($invoice->invitations, $transformer, ENTITY_INVITATION);
    }

    public function includePayments(Invoice $invoice)
    {
        $transformer = new PaymentTransformer($this->account, $this->serializer, $invoice);

        return $this->includeCollection($invoice->payments, $transformer, ENTITY_PAYMENT);
    }

    public function includeClient(Invoice $invoice)
    {
        $transformer = new ClientTransformer($this->account, $this->serializer);

        return $this->includeItem($invoice->client, $transformer, ENTITY_CLIENT);
    }

    public function includeExpenses(Invoice $invoice)
    {
        $transformer = new ExpenseTransformer($this->account, $this->serializer);

        return $this->includeCollection($invoice->expenses, $transformer, ENTITY_EXPENSE);
    }

    public function includeDocuments(Invoice $invoice)
    {
        $transformer = new DocumentTransformer($this->account, $this->serializer);

        $invoice->documents->each(function ($document) use ($invoice) {
            $document->setRelation('invoice', $invoice);
        });

        return $this->includeCollection($invoice->documents, $transformer, ENTITY_DOCUMENT);
    }
*/
    public function transform(RecurringInvoice $invoice)
    {
        return [
            'id' => $this->encodePrimaryKey($invoice->id),
            'amount' => (float) $invoice->amount,
            'balance' => (float) $invoice->balance,
            'client_id' => (int) $invoice->client_id,
            'status_id' => (int) ($invoice->status_id ?: 1),
            'updated_at' => $invoice->updated_at,
            'archived_at' => $invoice->deleted_at,
            'discount' => (float) $invoice->discount,
            'po_number' => $invoice->po_number,
            'invoice_date' => $invoice->invoice_date ?: '',
            'due_date' => $invoice->due_date ?: '',
            'terms' => $invoice->terms ?: '',
            'public_notes' => $invoice->public_notes ?: '',
            'private_notes' => $invoice->private_notes ?: '',
            'is_deleted' => (bool) $invoice->is_deleted,
            'tax_name1' => $invoice->tax_name1 ? $invoice->tax_name1 : '',
            'tax_rate1' => (float) $invoice->tax_rate1,
            'tax_name2' => $invoice->tax_name2 ? $invoice->tax_name2 : '',
            'tax_rate2' => (float) $invoice->tax_rate2,
            'is_amount_discount' => (bool) ($invoice->is_amount_discount ?: false),
            'invoice_footer' => $invoice->invoice_footer ?: '',
            'partial' => (float) ($invoice->partial ?: 0.0),
            'partial_due_date' => $invoice->partial_due_date ?: '',
            'custom_value1' => (float) $invoice->custom_value1,
            'custom_value2' => (float) $invoice->custom_value2,
            'custom_taxes1' => (bool) $invoice->custom_taxes1,
            'custom_taxes2' => (bool) $invoice->custom_taxes2,
            'has_tasks' => (bool) $invoice->has_tasks,
            'has_expenses' => (bool) $invoice->has_expenses,
            'custom_text_value1' => $invoice->custom_text_value1 ?: '',
            'custom_text_value2' => $invoice->custom_text_value2 ?: '',
            'backup' => $invoice->backup ?: '',
            'settings' => $invoice->settings,
            'frequency_id' => (int) $invoice->frequency_id,
            'start_date' => $invoice->start_date,
            'last_sent_date' => $invoice->last_sent_date,
            'next_send_date' => $invoice->next_send_date,
            'remaining_cycles' => (int) $invoice->remaining_cycles,
        ];
    }
}