| 1 |
<?php |
| 2 |
|
| 3 |
declare(strict_types=1); |
| 4 |
|
| 5 |
namespace Give\DonationForms\V2\ListTable\Columns; |
| 6 |
|
| 7 |
use Give\DonationForms\Repositories\DonationFormDataRepository; |
| 8 |
use Give\DonationForms\V2\Models\DonationForm; |
| 9 |
use Give\Framework\ListTable\ModelColumn; |
| 10 |
|
| 11 |
/** |
| 12 |
* @since 2.24.0 |
| 13 |
* |
| 14 |
* @extends ModelColumn<DonationForm> |
| 15 |
*/ |
| 16 |
class GoalColumn extends ModelColumn |
| 17 |
{ |
| 18 |
/** |
| 19 |
* @since 2.24.0 |
| 20 |
* |
| 21 |
* @inheritDoc |
| 22 |
*/ |
| 23 |
public static function getId(): string |
| 24 |
{ |
| 25 |
return 'goal'; |
| 26 |
} |
| 27 |
|
| 28 |
/** |
| 29 |
* @since 2.24.0 |
| 30 |
* |
| 31 |
* @inheritDoc |
| 32 |
*/ |
| 33 |
public function getLabel(): string |
| 34 |
{ |
| 35 |
return __('Goal', 'give'); |
| 36 |
} |
| 37 |
|
| 38 |
/** |
| 39 |
* @since 4.3.0 use DonationFormDataRepository |
| 40 |
* @since 4.2.0 convert goal data to v3 form format |
| 41 |
* @since 3.16.0 Remove "give_get_form_earnings_stats" filter logic and add filters to change the cell value content |
| 42 |
* @since 3.14.0 Use the "give_get_form_earnings_stats" filter to ensure the correct value will be displayed in the form progress bar |
| 43 |
* @since 2.24.0 |
| 44 |
* |
| 45 |
* @inheritDoc |
| 46 |
* |
| 47 |
* @param DonationForm $model |
| 48 |
*/ |
| 49 |
public function getCellValue($model): string |
| 50 |
{ |
| 51 |
if (! $model->goalSettings->enableDonationGoal) { |
| 52 |
return __('No Goal Set', 'give'); |
| 53 |
} |
| 54 |
|
| 55 |
/** |
| 56 |
* @var DonationFormDataRepository $donationFormData |
| 57 |
*/ |
| 58 |
$donationFormData = $this->getListTableData(); |
| 59 |
|
| 60 |
$goalData = $donationFormData->getGoalData($model); |
| 61 |
|
| 62 |
$stats = apply_filters('give_goal_progress_stats', [ |
| 63 |
'raw_actual' => $goalData['actual'], |
| 64 |
'raw_goal' => $goalData['goal'], |
| 65 |
'progress' => $goalData['percentage'], |
| 66 |
'actual' => $goalData['actualFormatted'] , |
| 67 |
'goal' => $goalData['goalFormatted'], |
| 68 |
'format' => $goalData['typeIsMoney'] ? 'percentage' : 'amount', |
| 69 |
'form_id' => $model->id, |
| 70 |
]); |
| 71 |
|
| 72 |
|
| 73 |
$template = ' |
| 74 |
<div |
| 75 |
role="progressbar" |
| 76 |
aria-labelledby="giveDonationFormsProgressBar-%1$d" |
| 77 |
aria-valuenow="%2$s" |
| 78 |
aria-valuemin="0" |
| 79 |
aria-valuemax="100" |
| 80 |
class="goalProgress" |
| 81 |
> |
| 82 |
<span style="width: %2$s%%"></span> |
| 83 |
</div> |
| 84 |
<div id="giveDonationFormsProgressBar-%1$d"> |
| 85 |
<span class="goal">%3$s</span>%4$s %5$s |
| 86 |
</div> |
| 87 |
'; |
| 88 |
|
| 89 |
return sprintf( |
| 90 |
$template, |
| 91 |
$model->id, |
| 92 |
$stats['progress'], |
| 93 |
$stats['actual'], |
| 94 |
sprintf( |
| 95 |
' %s %s', |
| 96 |
__('of', 'give'), |
| 97 |
$stats['goal'] |
| 98 |
), |
| 99 |
sprintf( |
| 100 |
'<span style="opacity:%1$s" class="goalProgress--achieved"><img src="%2$s" alt="%3$s" />%4$s</span>', |
| 101 |
apply_filters('givewp_list_table_goal_progress_achieved_opacity', $stats['progress'] >= 100 ? 1 : 0), |
| 102 |
GIVE_PLUGIN_URL . 'build/assets/dist/images/list-table/star-icon.svg', |
| 103 |
__('Goal achieved icon', 'give'), |
| 104 |
__('Goal achieved!', 'give') |
| 105 |
) |
| 106 |
); |
| 107 |
} |
| 108 |
} |
| 109 |
|
