class-yith-privacy-plugin-abstract.php
73 lines
| 1 | <?php |
| 2 | /** |
| 3 | * YITH Privacy Abstract Class |
| 4 | * abstract class to handle privacy in plugins |
| 5 | * |
| 6 | * @class YITH_Privacy_Plugin_Abstract |
| 7 | * @author YITH <plugins@yithemes.com> |
| 8 | * @package YITH\PluginFramework\Classes |
| 9 | */ |
| 10 | |
| 11 | defined( 'ABSPATH' ) || exit; // Exit if accessed directly. |
| 12 | |
| 13 | if ( ! class_exists( 'YITH_Privacy_Plugin_Abstract' ) ) { |
| 14 | /** |
| 15 | * Class YITH_Privacy_Plugin_Abstract |
| 16 | */ |
| 17 | class YITH_Privacy_Plugin_Abstract { |
| 18 | /** |
| 19 | * The plugin name. |
| 20 | * |
| 21 | * @var string |
| 22 | */ |
| 23 | private $plugin_name; |
| 24 | |
| 25 | /** |
| 26 | * YITH_Privacy_Plugin_Abstract constructor. |
| 27 | * |
| 28 | * @param string $plugin_name The plugin name. |
| 29 | */ |
| 30 | public function __construct( $plugin_name ) { |
| 31 | $this->plugin_name = $plugin_name; |
| 32 | $this->init(); |
| 33 | } |
| 34 | |
| 35 | /** |
| 36 | * Let's initialize the privacy. |
| 37 | */ |
| 38 | protected function init() { |
| 39 | add_filter( 'yith_plugin_fw_privacy_guide_content', array( $this, 'add_message_in_section' ), 10, 2 ); |
| 40 | } |
| 41 | |
| 42 | /** |
| 43 | * Add message in a specific section. |
| 44 | * |
| 45 | * @param string $html The HTML of the section. |
| 46 | * @param string $section The section. |
| 47 | * |
| 48 | * @return string |
| 49 | */ |
| 50 | public function add_message_in_section( $html, $section ) { |
| 51 | $message = $this->get_privacy_message( $section ); |
| 52 | if ( $message ) { |
| 53 | $html .= "<p class='privacy-policy-tutorial'><strong>{$this->plugin_name}</strong></p>"; |
| 54 | $html .= $message; |
| 55 | } |
| 56 | |
| 57 | return $html; |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Retrieve the privacy message. |
| 62 | * Override me to customize the messages for each section. |
| 63 | * |
| 64 | * @param string $section The section. |
| 65 | * |
| 66 | * @return string |
| 67 | */ |
| 68 | public function get_privacy_message( $section ) { |
| 69 | return ''; |
| 70 | } |
| 71 | } |
| 72 | } |
| 73 |