File "WPDA_Favourites.php"

Full Path: /home/vantageo/public_html/cache/cache/cache/.wp-cli/wp-content/plugins/wp-data-access/WPDataAccess/Utilities/WPDA_Favourites.php
File size: 2.82 KB
MIME-type: text/x-php
Charset: utf-8

<?php

/**
 * Suppress "error - 0 - No summary was found for this file" on phpdoc generation
 *
 * @package WPDataAccess\Utilities
 */

namespace WPDataAccess\Utilities {

	use WPDataAccess\Data_Dictionary\WPDA_Dictionary_Exist;
	use WPDataAccess\WPDA;

	/**
	 * Class WPDA_Favourites
	 *
	 * @author  Peter Schulz
	 * @since   2.0.13
	 */
	class WPDA_Favourites {

		const FAVOURITES_OPTION_NAME = 'wpda_favourites';

		/**
		 * Database schema name
		 *
		 * @var string|null
		 */
		protected $schema_name = null;

		/**
		 * Database table name
		 *
		 * @var string|null
		 */
		protected $table_name = null;

		/**
		 * WPDA_Favourites constructor
		 *
		 * Checks if the given tables exists.
		 *
		 * @since 1.2.0
		 */
		public function __construct() {
			if ( isset( $_REQUEST['wpdaschema_name'] ) && isset( $_REQUEST['table_name'] ) ) {
				$this->schema_name = sanitize_text_field( wp_unslash( $_REQUEST['wpdaschema_name'] ) ); // input var okay.
				$this->table_name  = sanitize_text_field( wp_unslash( $_REQUEST['table_name'] ) ); // input var okay.
			}
		}

		/**
		 * Add table to favourites
		 *
		 * @return string '0' = failed; '1' = succeeded
		 *
		 * @since 1.2.0
		 */
		public function add() {
			if ( ! $this->check_dictionary() ) {
				echo '0'; // Failed.

				return;
			}

			if ( null === $this->table_name ) {
				echo '0'; // Failed.

				return;
			}

			$option_value = get_option( self::FAVOURITES_OPTION_NAME );

			if ( false === $option_value ) {
				$favourites_array = array();
			} else {
				$favourites_array = $option_value;
			}

			if ( ! isset( $favourites_array[ $this->table_name ] ) ) {
				$favourites_array[ $this->table_name ] = $this->table_name;
				update_option( self::FAVOURITES_OPTION_NAME, $favourites_array );
				echo '1';

				return;
			}

			echo '0'; // Failed.
		}

		/**
		 * Remove table from favourites
		 *
		 * @return string '0' = failed; '1' = succeeded
		 *
		 * @since 1.2.0
		 */
		public function rem() {
			if ( ! $this->check_dictionary() ) {
				echo '0'; // Failed.

				return;
			}

			if ( null === $this->table_name ) {
				echo '0'; // Failed.

				return;
			}
			$option_value = get_option( self::FAVOURITES_OPTION_NAME );

			if ( false !== $option_value ) {
				$favourites_array = $option_value;
				if ( isset( $favourites_array[ $this->table_name ] ) ) {
					unset( $favourites_array[ $this->table_name ] );
					update_option( self::FAVOURITES_OPTION_NAME, $favourites_array );
					echo '1';

					return;
				}
			}

			echo '0'; // Failed.
		}

		private function check_dictionary() {
			if ( ! WPDA::schema_exists( $this->schema_name ) ) {
				return false;
			}

			$wpda_dictionary_exist = new WPDA_Dictionary_Exist( $this->schema_name, $this->table_name );
			if ( ! $wpda_dictionary_exist->table_exists( $this->table_name ) ) {
				return false;
			}

			return true;
		}

	}

}