Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace NinjaForms\Includes\Abstracts;

[2] Fix | Delete

[3] Fix | Delete

use NinjaForms\Includes\Contracts\SubmissionHandler as ContractSubmissionHandler;

[4] Fix | Delete

use NinjaForms\Includes\Entities\SingleSubmission;

[5] Fix | Delete

use NinjaForms\Includes\Entities\SubmissionExtraHandlerResponse;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Abstract class implementing SubmissionHandler

[9] Fix | Delete

[10] Fix | Delete

* Child class sets responseType, download, blobType, filename

[11] Fix | Delete

[12] Fix | Delete

* $this->responseType can be 'none' or 'download'. 'none' means that some

[13] Fix | Delete

* action is performed but there is no returned data to be downloaded.

[14] Fix | Delete

* 'download' means that there is data to be downloaded, such as a PDF or CSV.

[15] Fix | Delete

[16] Fix | Delete

* $this->download is the data that is to be downloaded

[17] Fix | Delete

[18] Fix | Delete

* $this->blobType is the application type of the download, instructing the

[19] Fix | Delete

* fetch command the format of the downloadable data

[20] Fix | Delete

[21] Fix | Delete

* $this->result is a summary message for the request, usually 'ok' or a

[22] Fix | Delete

* failure message

[23] Fix | Delete

[24] Fix | Delete

abstract class SubmissionHandler implements ContractSubmissionHandler

[25] Fix | Delete

{

[26] Fix | Delete

/**

[27] Fix | Delete

* camelCase slug of class

[28] Fix | Delete

[29] Fix | Delete

protected $slug = '';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Response can be 'none' or `download`

[33] Fix | Delete

[34] Fix | Delete

protected $responseType = 'none';

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Result of request (usu. 'ok' or failure message)

[38] Fix | Delete

[39] Fix | Delete

* @var string

[40] Fix | Delete

[41] Fix | Delete

protected $result = '';

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Base 64 encoded downloadable string

[45] Fix | Delete

[46] Fix | Delete

* @var string

[47] Fix | Delete

[48] Fix | Delete

protected $download = '';

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Application type of download (for constructing download)

[52] Fix | Delete

[53] Fix | Delete

protected $blobType = '';

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Filename of the download, including file extension

[57] Fix | Delete

[58] Fix | Delete

* @var string

[59] Fix | Delete

[60] Fix | Delete

protected $filename = '';

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Label for single row command

[64] Fix | Delete

[65] Fix | Delete

* @var string

[66] Fix | Delete

[67] Fix | Delete

protected $label;

[68] Fix | Delete

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Registers command to export single submission as PDF

[72] Fix | Delete

* @return void

[73] Fix | Delete

[74] Fix | Delete

public function __construct()

[75] Fix | Delete

{

[76] Fix | Delete

$this->constructLabel();

[77] Fix | Delete

[78] Fix | Delete

\add_filter('nf_react_table_submission_handlers', [$this, 'addSubmissionHandler'], 10, 2);

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Construct translatable label property

[83] Fix | Delete

[84] Fix | Delete

* @return void

[85] Fix | Delete

[86] Fix | Delete

abstract protected function constructLabel(): void;

[87] Fix | Delete

[88] Fix | Delete

public function addSubmissionHandler(array $handlerCollection, ?SingleSubmission $singleSubmission): array

[89] Fix | Delete

{

[90] Fix | Delete

if(!is_null($singleSubmission) && $this->doesAddHandler($singleSubmission)){

[91] Fix | Delete

[92] Fix | Delete

$handlerCollection[$this->getSlug()] =

[93] Fix | Delete

[

[94] Fix | Delete

'handlerClassName' => $this->getHandlerClassName(),

[95] Fix | Delete

'handlerLabel' => $this->getLabel()

[96] Fix | Delete

];

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

return $handlerCollection;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Determine if handler is added to submission row

[104] Fix | Delete

[105] Fix | Delete

* @param SingleSubmission $singleSubmission

[106] Fix | Delete

* @return boolean

[107] Fix | Delete

[108] Fix | Delete

abstract protected function doesAddHandler(SingleSubmission $singleSubmission): bool;

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Perform extra handler action on a single submission

[112] Fix | Delete

[113] Fix | Delete

* @param SingleSubmission $singleSubmission

[114] Fix | Delete

* @return array

[115] Fix | Delete

[116] Fix | Delete

public function handle(SingleSubmission $singleSubmission): array

[117] Fix | Delete

{

[118] Fix | Delete

$this->handleSubmission($singleSubmission);

[119] Fix | Delete

[120] Fix | Delete

$returnArray = (SubmissionExtraHandlerResponse::fromArray([

[121] Fix | Delete

'responseType' => $this->responseType,

[122] Fix | Delete

'download' => $this->download,

[123] Fix | Delete

'blobType' => $this->blobType,

[124] Fix | Delete

'result' => $this->result,

[125] Fix | Delete

'filename' => $this->filename

[126] Fix | Delete

]))->toArray();

[127] Fix | Delete

[128] Fix | Delete

return $returnArray;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Perform functionality on submission, update properties for return

[133] Fix | Delete

[134] Fix | Delete

* @param SingleSubmission $singleSubmission

[135] Fix | Delete

* @return void

[136] Fix | Delete

[137] Fix | Delete

abstract protected function handleSubmission(SingleSubmission $singleSubmission):void;

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Returns payload for download

[141] Fix | Delete

[142] Fix | Delete

* @return string

[143] Fix | Delete

[144] Fix | Delete

public function getDownload(): string

[145] Fix | Delete

{

[146] Fix | Delete

return $this->download;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Return an identifying slug for the handler

[151] Fix | Delete

* @return string

[152] Fix | Delete

[153] Fix | Delete

public function getSlug(): string

[154] Fix | Delete

{

[155] Fix | Delete

return $this->slug;

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* Return a label for the handler

[160] Fix | Delete

* @return string

[161] Fix | Delete

[162] Fix | Delete

public function getLabel(): string

[163] Fix | Delete

{

[164] Fix | Delete

[165] Fix | Delete

return $this->label;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Return class name of SubmissionHandler

[170] Fix | Delete

* @return string

[171] Fix | Delete

[172] Fix | Delete

abstract public function getHandlerClassName(): string;

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete