CptSubmissionDataSource.php 12.9 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
<?php

namespace NinjaForms\Includes\Database;

use NinjaForms\Includes\Contracts\SubmissionDataSource as ContractsSubmissionDataSource;
use NinjaForms\Includes\Entities\SingleSubmission;
use NinjaForms\Includes\Entities\SubmissionFilter;
use NinjaForms\Includes\Entities\SubmissionField;
use NinjaForms\Includes\Handlers\DateTimeConverter;

use \NF_Database_Models_Submission;

/**
 * Retrieves a CPT Ninja Forms submission by its form id
 * 
 * CPT indicates NF submissions stored as custom post type
 */
class CptSubmissionDataSource implements ContractsSubmissionDataSource
{

    const TIMESTAMP_FORMAT = 'Y-m-d H:i:s';

    /**
     * Identifier of where submission is stored
     *
     * @var string
     */
    protected $dataSource = 'nf_post';

    /**
     * Collection of submissions
     *
     * @var SingleSubmission[]
     */
    protected $submissionCollection = [];

    /** @var SubmissionFilter   */
    protected $submissionFilter;

    /**
     * Form Id of the primary form
     *
     * Form Id used to define fields; other forms can be included in results.
     *
     * @var [type]
     */
    protected $formId = null;

    /** @inheritDoc */
    public function retrieveSubmissionMeta(SubmissionFilter $submissionFilter): array
    {
        $this->submissionFilter = $submissionFilter;

        $this->submissionCollection = [];

        if ([] !== $submissionFilter->getNfFormIds()) {

            $formIdCollection = $submissionFilter->getNfFormIds();

            $this->formId = $formIdCollection[0];

            foreach ($formIdCollection as $formIdFromCollection) {

                $this->retrieveSubmissionMetaByNfFormId($formIdFromCollection);
            }
        }

        if(''!==$this->submissionFilter->getSearchString()){
            $this->applySearchCriterion();
        }
        
        return $this->submissionCollection;
    }

    /** @inheritDoc */
    public function retrieveSingleSubmission(SingleSubmission $singleSubmission): SingleSubmission
    {
        /** @var NF_Database_Models_Submission $nfSub */
        $nfSub = $this->getNfSub($singleSubmission);

        $subDate = $nfSub->get_sub_date(SingleSubmission::TIMESTAMP_FORMAT);
        $singleSubmission->setTimestamp($subDate);

        $singleSubmission = $this->fullyPopulateSingleSubmission($singleSubmission, $nfSub);

        return $singleSubmission;
    }

    /** @inheritDoc */
    public function retrieveSubmissionValues(SingleSubmission $singleSubmission): SingleSubmission
    {
        $submissionRecordId = $singleSubmission->getSubmissionRecordId();

        if (isset($this->submissionCollection[$submissionRecordId])) {

            $nfSub  = $this->getNfSub($singleSubmission);

            $singleSubmission = $this->fullyPopulateSingleSubmission($singleSubmission, $nfSub);

            $this->submissionCollection[$submissionRecordId] = $singleSubmission;
        }

        return $singleSubmission;
    }

    /** @inheritDoc */
    public function deleteSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource
    {
        $submissionId = $singleSubmission->getSubmissionRecordId();
        
        $submission = Ninja_Forms()->form()->get_sub( $submissionId );

        $status = ["publish"];
        if( in_array($submission->get_status(), $status) ){
            $submission->trash();
        } else {
            $submission->delete();
        }
  
        return $this;
    }

    /** @inheritDoc */
    public function restoreSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource
    {
        $submissionId = $singleSubmission->getSubmissionRecordId();
        
        wp_update_post([
            "ID"            =>  $submissionId,
            "post_status"   =>  "publish"
        ]);
  
        return $this;
    }

    /** @inheritDoc */
    public function updateSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource
    {  
        $submissionId = $singleSubmission->getSubmissionRecordId();
      
        $submission = Ninja_Forms()->form()->get_sub( $submissionId );
        
        $updatedFieldsCollection = [];
        
        /** @var SubmissionField $submissionField */
        foreach($singleSubmission->getSubmissionFieldCollection() as $submissionField){
            $updatedFieldsCollection[$submissionField->getSlug()]=$submissionField->getValue();         
        }

        $submission->update_field_values($updatedFieldsCollection)->save();
        
        $submission->save();

        return $this;
    }

    /**
     * Get the NF_Submission for a SingleSubmission entity
     */
    protected function getNfSub(SingleSubmission $singleSubmission): NF_Database_Models_Submission
    {
        $nfSub = Ninja_Forms()->form()->get_sub($singleSubmission->getSubmissionRecordId(), null);

        return $nfSub;
    }

    /**
     * Populate submission values, extra values, handlers
     *
     * @param SingleSubmission $singleSubmission
     * @param NF_Database_Models_Submission $nfSub
     * @return SingleSubmission
     */
    protected function fullyPopulateSingleSubmission(SingleSubmission $singleSubmission, NF_Database_Models_Submission $nfSub): SingleSubmission
    {
        $singleSubmission = $this->populateSubmissionValues($singleSubmission, $nfSub);

        $extraValues = $this->retrieveExtraValues($nfSub, $this->getExtraValueHandlers());

        $singleSubmission->setExtraValues($extraValues);

        $submissionHandlers = \apply_filters('nf_react_table_submission_handlers',[],$singleSubmission);

        $singleSubmission->setSubmissionHandlers($submissionHandlers);
        
        return $singleSubmission;
    }

    /**
     * Populate a single submissin with submitted values
  
     * @param SingleSubmission $singleSubmission
     * @param NF_Database_Models_Submission $nfSub
     * @return SingleSubmission
     */
    protected function populateSubmissionValues(SingleSubmission $singleSubmission,NF_Database_Models_Submission $nfSub): SingleSubmission
    {
        $updatedFieldValueCollection = [];

        foreach ($singleSubmission->getSubmissionFieldCollection() as $fieldSlug => $submissionField) {

            $value = $nfSub->get_field_value($fieldSlug);
            $submissionField->setValue($value);

            $updatedFieldValueCollection[$fieldSlug] = $submissionField;
        }

        $singleSubmission->setSubmissionFieldCollection($updatedFieldValueCollection);

        return $singleSubmission;
    }

    /**
     * Provide a filtered list of extra value keys storing extra data
     * 
     * Non-core actions can filter the list to provide their keys for retrieval
     * 
     * @return array 
     */
    protected function getExtraValueHandlers( ): array
    {   
        $metaboxHandlers = [];

        $return = \apply_filters('nf_react_table_extra_value_keys',$metaboxHandlers);
        
        // Example of adding an extraValue handler
        // $metaboxHandlers['nfacds']='\NinjaForms\ActiveCampaign\Admin\MetaboxEntityConstructor';
        
        return $return;
    }

    /**
     * Retrieve extraValues as constructed into MetaboxOutputEntities
     *
     * @param NF_Database_Models_Submission $nfSub
     * @param array $extraValueHandlers
     * @return array
     */
    protected function retrieveExtraValues($nfSub, array $extraValueHandlers): array
    {
        $return =[];

        foreach($extraValueHandlers as $extraValueKey=>$extraValueHandler){

            $extraValue =$nfSub->get_extra_value($extraValueKey);

            if(\class_exists($extraValueHandler)){
                
                $structured = (new $extraValueHandler())->handle($extraValue, $nfSub);
                
                if(!is_null($structured)){
                    $return[$extraValueKey]=$structured;
                }

            }
        }
        return $return;
    }
    
    /**
     * Apply search string filter to submission collection
     *
     * Runs a WP Query to search for all post Ids with both a form Id from the
     * submission filter and also a search string in any meta value of the same
     * form.  It then filters the submission collection to only those
     * submissions that meet these additional requirements.
     *
     * @return void
     */
    protected function applySearchCriterion(): void
    {
        $searchQuery = new \WP_Query(
            [
                'post_type' => 'nf_sub',
                'posts_per_page' => -1,
                'meta_query' => [
                    'relation' => 'AND', // both of below conditions must match
                    [
                        'key' => '_form_id',
                        'value' => $this->submissionFilter->getNfFormIds()
                    ],
                    [
                        'value' => $this->submissionFilter->getSearchString(),
                        'compare' => 'LIKE'
                    ]
                ]
            ]
        );

        /** @var array $searchCollection Array of submission Ids that match both form Id and search criterion */
        $searchCollection = [];

        foreach ($searchQuery->posts as $post) {
            $searchCollection[] = $post->ID;
        }

        $this->submissionCollection = \array_intersect_key($this->submissionCollection, \array_flip($searchCollection));
    }

    /**
     * Retrieve submissions Ids for a given NF form Id
     *
     * User Id is conditionally added if submission filter's property is
     * explicityly set (-1 is default value, indicating that no filtering on
     * User Id).
     *
     * WPDB query args is changed from individual args to being passed as array;
     * this makes for cleaner structure when sequence of arguments is variable.
     * 
     *
     * @return void 
     */
    protected function retrieveSubmissionMetaByNfFormId(string $formId): void
    {
        global $wpdb;

        $startDate = DateTimeConverter::localizeEpochIntoString( $this->submissionFilter->getStartDate());
        $endDate = DateTimeConverter::localizeEpochIntoString( $this->submissionFilter->getEndDate());
        
        $userId = $this->submissionFilter->getUserId();

        $statuses = $this->submissionFilter->getStatus();

        $status = !empty($statuses) && in_array( "trash", $statuses ) ? "trash" : "publish";

        $wpdbPrepareArgs = [];

        $submissionRecordIdQuery = "SELECT p.ID, p.post_author, p.post_date, mm.meta_value AS seq"
            ." FROM `" . $wpdb->prefix . "posts` AS p"
            ." INNER JOIN `" . $wpdb->prefix . "postmeta` AS m"
            ." ON p.ID = m.post_id"
            ." INNER JOIN `" . $wpdb->prefix . "postmeta` AS mm"
            ." ON p.ID = mm.post_id"
            ." WHERE p.post_type = 'nf_sub'";


        // Filter on post author as submitter's user id
        if (!\is_null($userId)) {

            $submissionRecordIdQuery .= "AND p.post_author = %d";
            $wpdbPrepareArgs[]=$userId;
        }

        // Filter on post status
        $submissionRecordIdQuery .= " AND p.post_status = %s";
        $wpdbPrepareArgs[]=$status;

        // Filter on form id meta key/value
        $submissionRecordIdQuery .= " AND m.meta_key =  '_form_id' AND m.meta_value =  %s";
        $wpdbPrepareArgs[]=$formId;

        $submissionRecordIdQuery .= " AND mm.meta_key = '_seq_num'";

        $submissionRecordIdQuery .= " AND CAST(p.post_modified AS DATE) BETWEEN %s AND %s";
        $wpdbPrepareArgs[]=$startDate;
        $wpdbPrepareArgs[]=$endDate;

        $recordCollection = $wpdb->get_results($wpdb->prepare($submissionRecordIdQuery, $wpdbPrepareArgs));     
        
        foreach ($recordCollection as $queryObject) {
            $submissionRecordId = $queryObject->ID;
            $subDate = $queryObject->post_date;
            $seq = $queryObject->seq;
            $submitterId = $queryObject->post_author;
            $this->submissionCollection[$submissionRecordId] = SingleSubmission::fromArray([
                'submissionRecordId' => $submissionRecordId,
                'timestamp' => $subDate,
                'formId' => $formId,
                'dataSource' => $this->dataSource,
                'status' =>  $status,
                'seq_num' => $seq,
                'submitterId'   => $submitterId
            ]);
        }
    }

    /**
     * Boolean to include as per date filter
     * 
     * true=>include, false=>omit
     *
     * @return boolean
     */
    protected function includeByDateFilter($subDate): bool
    {
        $include = true;
        
        $startDateUnix = $this->submissionFilter->getStartDate();
        $startDate = (new \DateTime())->setTimestamp($startDateUnix)->format(self::TIMESTAMP_FORMAT);
        
        $endDateUnix = $this->submissionFilter->getEndDate();
        $endDate = (new \DateTime())->setTimestamp($endDateUnix)->format(self::TIMESTAMP_FORMAT);

        if(''!==$startDate && $subDate<$startDate){
            $include=false;
        }

        if(''!==$endDate && $subDate>$endDate){
            $include=false;
        }

        return $include;
    }

    /** @inheritDoc */
    public function getDataSource(): string
    {
        return $this->dataSource;
    }
}