plugin updates
This commit is contained in:
Tony Volpe
@@ -1,115 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Yoast\WP\SEO\Introductions\Infrastructure;
|
||||
|
||||
use Yoast\WP\SEO\Helpers\User_Helper;
|
||||
use Yoast\WP\SEO\Introductions\Domain\Invalid_User_Id_Exception;
|
||||
|
||||
/**
|
||||
* Stores and retrieves whether the user has seen certain introductions.
|
||||
*/
|
||||
class Introductions_Seen_Repository {
|
||||
|
||||
public const USER_META_KEY = '_yoast_wpseo_introductions';
|
||||
|
||||
public const DEFAULT_VALUE = [];
|
||||
|
||||
/**
|
||||
* Holds the User_Helper instance.
|
||||
*
|
||||
* @var User_Helper
|
||||
*/
|
||||
private $user_helper;
|
||||
|
||||
/**
|
||||
* Constructs the class.
|
||||
*
|
||||
* @param User_Helper $user_helper The User_Helper.
|
||||
*/
|
||||
public function __construct( User_Helper $user_helper ) {
|
||||
$this->user_helper = $user_helper;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the introductions.
|
||||
*
|
||||
* @param int $user_id User ID.
|
||||
*
|
||||
* @return array The introductions.
|
||||
*
|
||||
* @throws Invalid_User_Id_Exception If an invalid user ID is supplied.
|
||||
*/
|
||||
public function get_all_introductions( $user_id ): array {
|
||||
$seen_introductions = $this->user_helper->get_meta( $user_id, self::USER_META_KEY, true );
|
||||
if ( $seen_introductions === false ) {
|
||||
throw new Invalid_User_Id_Exception();
|
||||
}
|
||||
|
||||
if ( \is_array( $seen_introductions ) ) {
|
||||
return $seen_introductions;
|
||||
}
|
||||
|
||||
/**
|
||||
* Why could $value be invalid?
|
||||
* - When the database row does not exist yet, $value can be an empty string.
|
||||
* - Faulty data was stored?
|
||||
*/
|
||||
return self::DEFAULT_VALUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the introductions.
|
||||
*
|
||||
* @param int $user_id The user ID.
|
||||
* @param array $introductions The introductions.
|
||||
*
|
||||
* @return bool True on successful update, false on failure or if the value passed to the function is the same as
|
||||
* the one that is already in the database.
|
||||
*/
|
||||
public function set_all_introductions( $user_id, array $introductions ): bool {
|
||||
return $this->user_helper->update_meta( $user_id, self::USER_META_KEY, $introductions ) !== false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves whether an introduction is seen.
|
||||
*
|
||||
* @param int $user_id User ID.
|
||||
* @param string $introduction_id The introduction ID.
|
||||
*
|
||||
* @return bool Whether the introduction is seen.
|
||||
*
|
||||
* @throws Invalid_User_Id_Exception If an invalid user ID is supplied.
|
||||
*/
|
||||
public function is_introduction_seen( $user_id, string $introduction_id ): bool {
|
||||
$introductions = $this->get_all_introductions( $user_id );
|
||||
|
||||
if ( \array_key_exists( $introduction_id, $introductions ) ) {
|
||||
return (bool) $introductions[ $introduction_id ];
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the introduction as seen.
|
||||
*
|
||||
* @param int $user_id The user ID.
|
||||
* @param string $introduction_id The introduction ID.
|
||||
* @param bool $is_seen Whether the introduction is seen. Defaults to true.
|
||||
*
|
||||
* @return bool False on failure. Not having to update is a success.
|
||||
*
|
||||
* @throws Invalid_User_Id_Exception If an invalid user ID is supplied.
|
||||
*/
|
||||
public function set_introduction( $user_id, string $introduction_id, bool $is_seen = true ): bool {
|
||||
$introductions = $this->get_all_introductions( $user_id );
|
||||
|
||||
// Check if the wanted value is already set.
|
||||
if ( \array_key_exists( $introduction_id, $introductions ) && $introductions[ $introduction_id ] === $is_seen ) {
|
||||
return true;
|
||||
}
|
||||
$introductions[ $introduction_id ] = $is_seen;
|
||||
|
||||
return $this->set_all_introductions( $user_id, $introductions );
|
||||
}
|
||||
}
|
||||
@@ -1,80 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Yoast\WP\SEO\Introductions\Infrastructure;
|
||||
|
||||
use Exception;
|
||||
use Yoast\WP\SEO\Helpers\User_Helper;
|
||||
|
||||
/**
|
||||
* Takes care of the get/set in the WP user meta.
|
||||
*
|
||||
* @makePublic
|
||||
*/
|
||||
class Wistia_Embed_Permission_Repository {
|
||||
|
||||
public const USER_META_KEY = '_yoast_wpseo_wistia_embed_permission';
|
||||
|
||||
public const DEFAULT_VALUE = false;
|
||||
|
||||
/**
|
||||
* Holds the User_Helper instance.
|
||||
*
|
||||
* @var User_Helper
|
||||
*/
|
||||
private $user_helper;
|
||||
|
||||
/**
|
||||
* Constructs the class.
|
||||
*
|
||||
* @param User_Helper $user_helper The User_Helper.
|
||||
*/
|
||||
public function __construct( User_Helper $user_helper ) {
|
||||
$this->user_helper = $user_helper;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the current value for a user.
|
||||
*
|
||||
* @param int $user_id User ID.
|
||||
*
|
||||
* @return bool The current value.
|
||||
*
|
||||
* @throws Exception If an invalid user ID is supplied.
|
||||
*/
|
||||
public function get_value_for_user( $user_id ) {
|
||||
$value = $this->user_helper->get_meta( $user_id, self::USER_META_KEY, true );
|
||||
if ( $value === false ) {
|
||||
throw new Exception( 'Invalid User ID' );
|
||||
}
|
||||
|
||||
if ( $value === '0' || $value === '1' ) {
|
||||
// The value is stored as a string because otherwise we can not see the difference between false and an invalid user ID.
|
||||
return $value === '1';
|
||||
}
|
||||
|
||||
/**
|
||||
* Why could $value be invalid?
|
||||
* - When the database row does not exist yet, $value can be an empty string.
|
||||
* - Faulty data was stored?
|
||||
*/
|
||||
return self::DEFAULT_VALUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the Wistia embed permission value for the current user.
|
||||
*
|
||||
* @param int $user_id The user ID.
|
||||
* @param bool $value The value.
|
||||
*
|
||||
* @return bool Whether the update was successful.
|
||||
*
|
||||
* @throws Exception If an invalid user ID is supplied.
|
||||
*/
|
||||
public function set_value_for_user( $user_id, $value ) {
|
||||
// The value is stored as a string because otherwise we can not see the difference between false and an invalid user ID.
|
||||
$value_as_string = ( $value === true ) ? '1' : '0';
|
||||
|
||||
// Checking for only false, not interested in not having to update.
|
||||
return $this->user_helper->update_meta( $user_id, self::USER_META_KEY, $value_as_string ) !== false;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user