| 1 |
<?php |
| 2 |
/** |
| 3 |
* Toggle_Gcm_Ability class. |
| 4 |
* |
| 5 |
* @package cookiebot |
| 6 |
* @subpackage abilities |
| 7 |
*/ |
| 8 |
|
| 9 |
namespace cybot\cookiebot\abilities; |
| 10 |
|
| 11 |
/** |
| 12 |
* Ability to toggle Google Consent Mode v2. |
| 13 |
* |
| 14 |
* @since 4.8.0 |
| 15 |
*/ |
| 16 |
class Toggle_Gcm_Ability implements Cookiebot_Ability_Interface { |
| 17 |
|
| 18 |
/** |
| 19 |
* Audit logger instance. |
| 20 |
* |
| 21 |
* @var Ability_Audit_Logger |
| 22 |
*/ |
| 23 |
private $logger; |
| 24 |
|
| 25 |
/** |
| 26 |
* Constructor. |
| 27 |
* |
| 28 |
* @param Ability_Audit_Logger $logger Audit logger instance. |
| 29 |
* |
| 30 |
* @since 4.8.0 |
| 31 |
*/ |
| 32 |
public function __construct( Ability_Audit_Logger $logger ) { |
| 33 |
$this->logger = $logger; |
| 34 |
} |
| 35 |
|
| 36 |
/** |
| 37 |
* Returns the ability name. |
| 38 |
* |
| 39 |
* @return string |
| 40 |
* |
| 41 |
* @since 4.8.0 |
| 42 |
*/ |
| 43 |
public function get_name() { |
| 44 |
return 'cookiebot/toggle-gcm'; |
| 45 |
} |
| 46 |
|
| 47 |
/** |
| 48 |
* Returns the ability arguments. |
| 49 |
* |
| 50 |
* @return array |
| 51 |
* |
| 52 |
* @since 4.8.0 |
| 53 |
*/ |
| 54 |
public function get_args() { |
| 55 |
$logger = $this->logger; |
| 56 |
|
| 57 |
return array( |
| 58 |
'label' => __( 'Toggle Google Consent Mode v2', 'cookiebot' ), |
| 59 |
'description' => __( 'Enables or disables Google Consent Mode v2. GCM v2 is required for Google Ads and Analytics in the EU/EEA and is enabled by default. Only disable if explicitly requested by the user.', 'cookiebot' ), |
| 60 |
'category' => 'cookiebot', |
| 61 |
'input_schema' => array( |
| 62 |
'type' => 'object', |
| 63 |
'properties' => array( |
| 64 |
'enabled' => array( |
| 65 |
'type' => 'boolean', |
| 66 |
'description' => __( 'True to enable Google Consent Mode v2, false to disable.', 'cookiebot' ), |
| 67 |
), |
| 68 |
), |
| 69 |
'required' => array( 'enabled' ), |
| 70 |
'additionalProperties' => false, |
| 71 |
), |
| 72 |
'output_schema' => array( |
| 73 |
'type' => 'object', |
| 74 |
'properties' => array( |
| 75 |
'old_value' => array( 'type' => 'boolean', 'description' => 'Previous GCM enabled state.' ), |
| 76 |
'new_value' => array( 'type' => 'boolean', 'description' => 'New GCM enabled state.' ), |
| 77 |
'success' => array( 'type' => 'boolean', 'description' => 'Whether the update succeeded.' ), |
| 78 |
), |
| 79 |
'additionalProperties' => false, |
| 80 |
), |
| 81 |
'execute_callback' => function( $input ) use ( $logger ) { |
| 82 |
$enabled = isset( $input['enabled'] ) ? (bool) $input['enabled'] : true; |
| 83 |
$old_value = get_option( 'cookiebot-gcm', '1' ) === '1'; |
| 84 |
update_option( 'cookiebot-gcm', $enabled ? '1' : '0' ); |
| 85 |
$logger->log( 'cookiebot/toggle-gcm', $old_value, $enabled ); |
| 86 |
return array( |
| 87 |
'old_value' => $old_value, |
| 88 |
'new_value' => $enabled, |
| 89 |
'success' => true, |
| 90 |
); |
| 91 |
}, |
| 92 |
'permission_callback' => function() { |
| 93 |
return current_user_can( 'manage_options' ); |
| 94 |
}, |
| 95 |
'meta' => array( |
| 96 |
'annotations' => array( 'readonly' => false, 'destructive' => false, 'idempotent' => true ), |
| 97 |
'show_in_rest' => true, |
| 98 |
), |
| 99 |
); |
| 100 |
} |
| 101 |
} |
| 102 |
|
