Skip to content

Jeff Balicki / st_joseph

Go to a project
Toggle navigation
Toggle navigation pinning
f1ab8192 by Jeff Balicki
Options

resources fav and style 

Signed-off-by: Jeff <jeff@gotenzing.com>
1 parent f379d0bf
Expand all
Inline Side-by-side
Showing 125 changed files with 4794 additions and 0 deletions
<?php
namespace Favorites\API\Shortcodes;
class ButtonShortcode
{
/**
* Shortcode Options
* @var array
*/
private $options;
public function __construct()
{
add_shortcode('favorite_button', [$this, 'renderView']);
}
/**
* Shortcode Options
*/
private function setOptions($options)
{
$this->options = shortcode_atts([
'post_id' => null,
'site_id' => null,
'group_id' => null
], $options);
}
/**
* Render the Button
* @param $options, array of shortcode options
*/
public function renderView($options)
{
$this->setOptions($options);
return get_favorites_button($this->options['post_id'], $this->options['site_id'], $this->options['group_id']);
}
}
\ No newline at end of file
<?php
namespace Favorites\API\Shortcodes;
class ClearFavoritesShortcode
{
/**
* Shortcode Options
* @var array
*/
private $options;
public function __construct()
{
add_shortcode('clear_favorites_button', [$this, 'renderView']);
}
/**
* Shortcode Options
*/
private function setOptions($options)
{
$this->options = shortcode_atts([
'site_id' => null,
'text' => null
], $options);
}
/**
* Render the Button
* @param $options, array of shortcode options
*/
public function renderView($options)
{
$this->setOptions($options);
return get_clear_favorites_button($this->options['site_id'], $this->options['text']);
}
}
\ No newline at end of file
<?php
namespace Favorites\API\Shortcodes;
class FavoriteCountShortcode
{
/**
* Shortcode Options
* @var array
*/
private $options;
public function __construct()
{
add_shortcode('favorite_count', [$this, 'renderView']);
}
/**
* Shortcode Options
*/
private function setOptions($options)
{
$this->options = shortcode_atts([
'post_id' => '',
'site_id' => ''
], $options);
}
/**
* Render the count
* @param $options, array of shortcode options
*/
public function renderView($options)
{
$this->setOptions($options);
return get_favorites_count($this->options['post_id'], $this->options['site_id']);
}
}
\ No newline at end of file
<?php
namespace Favorites\API\Shortcodes;
class PostFavoritesShortcode
{
/**
* Shortcode Options
* @var array
*/
private $options;
public function __construct()
{
add_shortcode('post_favorites', [$this, 'renderView']);
}
/**
* Shortcode Options
*/
private function setOptions($options)
{
$this->options = shortcode_atts([
'post_id' => '',
'site_id' => '',
'separator' => 'list',
'include_anonymous' => 'true',
'anonymous_label' => __('Anonymous Users', 'favorites'),
'anonymous_label_single' => __('Anonymous User', 'favorites')
], $options);
}
/**
* Render the HTML list
* @param $options, array of shortcode options
*/
public function renderView($options)
{
$this->setOptions($options);
$this->options['include_anonymous'] = ( $this->options['include_anonymous'] == 'true' ) ? true : false;
return the_users_who_favorited_post(
$post_id = $this->options['post_id'],
$site_id = $this->options['site_id'],
$separator = $this->options['separator'],
$include_anonymous = $this->options['include_anonymous'],
$anonymous_label = $this->options['anonymous_label'],
$anonymous_label_single = $this->options['anonymous_label_single']
);
}
}
\ No newline at end of file
<?php
namespace Favorites\API\Shortcodes;
class UserFavoriteCount
{
/**
* Shortcode Options
* @var array
*/
private $options;
/**
* List Filters
* @var array
*/
private $filters;
public function __construct()
{
add_shortcode('user_favorite_count', [$this, 'renderView']);
}
/**
* Shortcode Options
*/
private function setOptions($options)
{
$this->options = shortcode_atts([
'user_id' => '',
'site_id' => '',
'post_types' => ''
], $options);
}
/**
* Parse Post Types
*/
private function parsePostTypes()
{
if ( $this->options['post_types'] == "" ) return;
$post_types = explode(',', $this->options['post_types']);
$this->filters = ['post_type' => $post_types];
}
/**
* Render the HTML list
* @param $options, array of shortcode options
*/
public function renderView($options)
{
$this->setOptions($options);
$this->parsePostTypes();
if ( $this->options['user_id'] == '' ) $this->options['user_id'] = null;
if ( $this->options['site_id'] == '' ) $this->options['site_id'] = get_current_blog_id();
return get_user_favorites_count($this->options['user_id'], $this->options['site_id'], $this->filters, true);
}
}
\ No newline at end of file
<?php
namespace Favorites\API\Shortcodes;
use Favorites\Entities\User\UserFavorites;
class UserFavoritesShortcode
{
/**
* Shortcode Options
* @var array
*/
private $options;
/**
* List Filters
* @var array
*/
private $filters;
public function __construct()
{
add_shortcode('user_favorites', [$this, 'renderView']);
}
/**
* Shortcode Options
*/
private function setOptions($options)
{
$this->options = shortcode_atts([
'user_id' => '',
'site_id' => '',
'include_links' => 'true',
'post_types' => '',
'include_buttons' => 'false',
'include_thumbnails' => 'false',
'thumbnail_size' => 'thumbnail',
'include_excerpts' => 'false',
'no_favorites' => ''
], $options);
}
/**
* Parse Post Types
*/
private function parsePostTypes()
{
if ( $this->options['post_types'] == "" ) return;
$post_types = explode(',', $this->options['post_types']);
$this->filters = ['post_type' => $post_types];
}
/**
* Render the HTML list
* @param $options, array of shortcode options
*/
public function renderView($options)
{
$this->setOptions($options);
$this->parsePostTypes();
if ( $this->options['user_id'] == "" ) $this->options['user_id'] = null;
if ( $this->options['site_id'] == "" ) $this->options['site_id'] = null;
$this->options['include_links'] = ( $this->options['include_links'] == 'true' ) ? true : false;
$this->options['include_buttons'] = ( $this->options['include_buttons'] == 'true' ) ? true : false;
$this->options['include_thumbnails'] = ( $this->options['include_thumbnails'] == 'true' ) ? true : false;
$this->options['include_excerpts'] = ( $this->options['include_excerpts'] == 'true' ) ? true : false;
$favorites = new UserFavorites(
$this->options['user_id'],
$this->options['site_id'],
$this->options['include_links'],
$this->filters
);
return $favorites->getFavoritesList(
$this->options['include_buttons'],
$this->options['include_thumbnails'],
$this->options['thumbnail_size'],
$this->options['include_excerpts'],
$this->options['no_favorites']
);
}
}
\ No newline at end of file
<?php
/**
* Primary plugin API functions
*/
use Favorites\Entities\Favorite\FavoriteButton;
use Favorites\Entities\Post\FavoriteCount;
use Favorites\Entities\User\UserFavorites;
use Favorites\Entities\Post\PostFavorites;
use Favorites\Entities\Favorite\ClearFavoritesButton;
/**
* Get the favorite button
* @param $post_id int, defaults to current post
* @param $site_id int, defaults to current blog/site
* @return html
*/
function get_favorites_button($post_id = null, $site_id = null, $group_id = null)
{
global $blog_id;
if ( !$post_id ) $post_id = get_the_id();
if ( !$group_id ) $group_id = 1;
$site_id = ( is_multisite() && is_null($site_id) ) ? $blog_id : $site_id;
if ( !is_multisite() ) $site_id = 1;
$button = new FavoriteButton($post_id, $site_id);
return $button->display();
}
/**
* Echos the favorite button
* @param $post_id int, defaults to current post
* @param $site_id int, defaults to current blog/site
* @return html
*/
function the_favorites_button($post_id = null, $site_id = null, $group_id = null)
{
echo get_favorites_button($post_id, $site_id, $group_id);
}
/**
* Get the Favorite Total Count for a Post
* @param $post_id int, defaults to current post
* @param $site_id int, defaults to current blog/site
* @param $html bool, whether to return html (returns simple integer if false)
* @return html
*/
function get_favorites_count($post_id = null, $site_id = null, $html = true)
{
global $blog_id;
$site_id = ( is_multisite() && is_null($site_id) ) ? $blog_id : $site_id;
if ( !$post_id ) $post_id = get_the_id();
$count = new FavoriteCount();
$count = $count->getCount($post_id, $site_id);
$out = "";
if ( $html ) $out .= '<span data-favorites-post-count-id="' . $post_id . '" data-siteid="' . $site_id . '">';
$out .= $count;
if ( $html ) $out .= '</span>';
return $out;
}
/**
* Echo the Favorite Count
* @param $post_id int, defaults to current post
* @param $site_id int, defaults to current blog/site
* @return html
*/
function the_favorites_count($post_id = null, $site_id = null, $html = true)
{
echo get_favorites_count($post_id, $site_id, $html);
}
/**
* Get an array of User Favorites
* @param $user_id int, defaults to current user
* @param $site_id int, defaults to current blog/site
* @param $filters array of post types/taxonomies
* @return array
*/
function get_user_favorites($user_id = null, $site_id = null, $filters = null)
{
global $blog_id;
$site_id = ( is_multisite() && is_null($site_id) ) ? $blog_id : $site_id;
if ( !is_multisite() ) $site_id = 1;
$favorites = new UserFavorites($user_id, $site_id, $links = false, $filters);
return $favorites->getFavoritesArray();
}
/**
* HTML List of User Favorites
* @param $user_id int, defaults to current user
* @param $site_id int, defaults to current blog/site
* @param $filters array of post types/taxonomies
* @param $include_button boolean, whether to include the favorite button for each item
* @param $include_thumbnails boolean, whether to include the thumbnail for each item
* @param $thumbnail_size string, the thumbnail size to display
* @param $include_excpert boolean, whether to include the excerpt for each item
* @return html
*/
function get_user_favorites_list($user_id = null, $site_id = null, $include_links = false, $filters = null, $include_button = false, $include_thumbnails = false, $thumbnail_size = 'thumbnail', $include_excerpt = false)
{
global $blog_id;
$site_id = ( is_multisite() && is_null($site_id) ) ? $blog_id : $site_id;
if ( !is_multisite() ) $site_id = 1;
$favorites = new UserFavorites($user_id, $site_id, $include_links, $filters);
return $favorites->getFavoritesList($include_button, $include_thumbnails, $thumbnail_size, $include_excerpt);
}
/**
* Echo HTML List of User Favorites
* @param $user_id int, defaults to current user
* @param $site_id int, defaults to current blog/site
* @param $filters array of post types/taxonomies
* @param $include_button boolean, whether to include the favorite button for each item
* @param $include_thumbnails boolean, whether to include the thumbnail for each item
* @param $thumbnail_size string, the thumbnail size to display
* @param $include_excpert boolean, whether to include the excerpt for each item
* @return html
*/
function the_user_favorites_list($user_id = null, $site_id = null, $include_links = false, $filters = null, $include_button = false, $include_thumbnails = false, $thumbnail_size = 'thumbnail', $include_excerpt = false)
{
echo get_user_favorites_list($user_id, $site_id, $include_links, $filters, $include_button, $include_thumbnails, $thumbnail_size, $include_excerpt);
}
/**
* Get the number of posts a specific user has favorited
* @param $user_id int, defaults to current user
* @param $site_id int, defaults to current blog/site
* @param $filters array of post types/taxonomies
* @param $html boolean, whether to output html (important for AJAX updates). If false, an integer is returned
* @return int
*/
function get_user_favorites_count($user_id = null, $site_id = null, $filters = null, $html = false)
{
$favorites = get_user_favorites($user_id, $site_id, $filters);
$posttypes = ( isset($filters['post_type']) ) ? implode(',', $filters['post_type']) : 'all';
$count = ( isset($favorites[0]['site_id']) ) ? count($favorites[0]['posts']) : count($favorites);
$out = "";
if ( !$site_id ) $site_id = 1;
if ( $html ) $out .= '<span class="simplefavorites-user-count" data-posttypes="' . $posttypes . '" data-siteid="' . $site_id . '">';
$out .= $count;
if ( $html ) $out .= '</span>';
return $out;
}
/**
* Print the number of posts a specific user has favorited
* @param $user_id int, defaults to current user
* @param $site_id int, defaults to current blog/site
* @param $filters array of post types/taxonomies
* @return html
*/
function the_user_favorites_count($user_id = null, $site_id = null, $filters = null)
{
echo get_user_favorites_count($user_id, $site_id, $filters);
}
/**
* Get an array of users who have favorited a post
* @param $post_id int, defaults to current post
* @param $site_id int, defaults to current blog/site
* @param $user_role string, defaults to all
* @return array of user objects
*/
function get_users_who_favorited_post($post_id = null, $site_id = null, $user_role = null)
{
$users = new PostFavorites($post_id, $site_id, $user_role);
return $users->getUsers();
}
/**
* Get a list of users who favorited a post
* @param $post_id int, defaults to current post
* @param $site_id int, defaults to current blog/site
* @param $separator string, custom separator between items (defaults to HTML list)
* @param $include_anonmyous boolean, whether to include anonmyous users
* @param $anonymous_label string, label for anonymous user count
* @param $anonymous_label_single string, singular label for anonymous user count
* @param $user_role string, defaults to all
*/
function the_users_who_favorited_post($post_id = null, $site_id = null, $separator = 'list', $include_anonymous = true, $anonymous_label = 'Anonymous Users', $anonymous_label_single = 'Anonymous User', $user_role = null)
{
$users = new PostFavorites($post_id, $site_id, $user_role);
echo $users->userList($separator, $include_anonymous, $anonymous_label, $anonymous_label_single);
}
/**
* Get the number of anonymous users who favorited a post
* @param $post_id int Defaults to current post
* @return int Just anonymous users
*/
function get_anonymous_users_who_favourited_post( $post_id = null ) {
$user = new PostFavorites( $post_id );
return $users->anonymousCount();
}
/**
* Echo the number of anonymous users who favorited a post
* @param $post_id int Defaults to current post
* @return string Just anonymous users
*/
function the_anonymous_users_who_favourited_post( $post_id = null ) {
echo get_anonymous_users_who_favourited_post( $post_id );
}
/**
* Get the clear favorites button
* @param $site_id int, defaults to current blog/site
* @param $text string, button text - defaults to site setting
* @return html
*/
function get_clear_favorites_button($site_id = null, $text = null)
{
$button = new ClearFavoritesButton($site_id, $text);
return $button->display();
}
/**
* Print the clear favorites button
* @param $site_id int, defaults to current blog/site
* @param $text string, button text - defaults to site setting
* @return html
*/
function the_clear_favorites_button($site_id = null, $text = null)
{
echo get_clear_favorites_button($site_id, $text);
}
/**
* Get the total number of favorites, for all posts and users
* @param $site_id int, defaults to current blog/site
* @return html
*/
function get_total_favorites_count($site_id = null)
{
$count = new FavoriteCount();
return $count->getAllCount($site_id);
}
/**
* Print the total number of favorites, for all posts and users
* @param $site_id int, defaults to current blog/site
* @return html
*/
function the_total_favorites_count($site_id = null)
{
echo get_total_favorites_count($site_id);
}
\ No newline at end of file
<?php
namespace Favorites\Activation;
/**
* Plugin Activation
*/
class Activate
{
public function __construct()
{
$this->setOptions();
}
/**
* Default Plugin Options
*/
private function setOptions()
{
if ( !get_option('simplefavorites_dependencies')
&& get_option('simplefavorites_dependencies') !== "" ){
update_option('simplefavorites_dependencies', [
'css' => 'true',
'js' => 'true'
]);
}
if ( !get_option('simplefavorites_users')
&& get_option('simplefavorites_users') !== "" ){
update_option('simplefavorites_users', [
'anonymous' => [
'display' => 'true',
'save' => 'true'
],
'saveas' => 'cookie'
]);
}
if ( !get_option('simplefavorites_display')
&& get_option('simplefavorites_display') !== "" ){
update_option('simplefavorites_display', [
'buttontext' => __('Favorite <i class="sf-icon-star-empty"></i>', 'favorites'),
'buttontextfavorited' => __('Favorited <i class="sf-icon-star-full"></i>', 'favorites'),
'posttypes' => [
'post' => [
'display' => true,
'after_content' => true,
'postmeta' => true
]
]
]);
}
if ( !get_option('simplefavorites_cache_enabled')
&& get_option('simplefavorites_cache_enabled') !== "" ){
update_option('simplefavorites_cache_enabled', 'true');
}
}
}
\ No newline at end of file
<?php
namespace Favorites\Activation;
use Favorites\Helpers;
use Favorites\Config\SettingsRepository;
/**
* Plugin Dependencies
*/
class Dependencies
{
/**
* Plugin Directory
*/
private $plugin_dir;
/**
* Plugin Version
*/
private $plugin_version;
/**
* Settings Repository
*/
private $settings_repo;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
$this->setPluginVersion();
$this->plugin_dir = Helpers::plugin_url();
add_action( 'admin_enqueue_scripts', [$this, 'adminStyles']);
add_action( 'admin_enqueue_scripts', [$this, 'adminScripts']);
add_action( 'wp_enqueue_scripts', [$this, 'frontendStyles']);
add_action( 'wp_enqueue_scripts', [$this, 'frontendScripts']);
}
/**
* Set the Plugin Version
*/
private function setPluginVersion()
{
global $favorites_version;
$this->plugin_version = $favorites_version;
}
/**
* Admin Styles
*/
public function adminStyles()
{
wp_enqueue_style('wp-color-picker');
wp_enqueue_style(
'simple-favorites-admin',
$this->plugin_dir . '/assets/css/favorites-admin.css',
[],
$this->plugin_version
);
}
/**
* Admin Scripts
*/
public function adminScripts()
{
$screen = get_current_screen();
$settings_page = ( strpos($screen->id, 'simple-favorites') ) ? true : false;
if ( !$settings_page ) return;
wp_enqueue_script(
'simple-favorites-admin',
$this->plugin_dir . '/assets/js/favorites-admin.min.js',
['jquery', 'wp-color-picker'],
$this->plugin_version
);
}
/**
* Front End Styles
*/
public function frontendStyles()
{
if ( !$this->settings_repo->outputDependency('css') ) return;
wp_enqueue_style(
'simple-favorites',
$this->plugin_dir . '/assets/css/favorites.css',
[],
$this->plugin_version
);
}
/**
* Front End Scripts
*/
public function frontendScripts()
{
if ( !$this->settings_repo->outputDependency('js') ) return;
$file = ( $this->settings_repo->devMode() ) ? 'favorites.js' : 'favorites.min.js';
wp_enqueue_script(
'favorites',
$this->plugin_dir . '/assets/js/' . $file,
['jquery'],
$this->plugin_version
);
$localized_data = [
'ajaxurl' => admin_url( 'admin-ajax.php' ),
'nonce' => wp_create_nonce('simple_favorites_nonce'),
'favorite' => apply_filters('favorites/button/html', $this->settings_repo->buttonText(), null, false, null),
'favorited' => apply_filters('favorites/button/html', $this->settings_repo->buttonTextFavorited(), null, true, null),
'includecount' => $this->settings_repo->includeCountInButton(),
'indicate_loading' => $this->settings_repo->includeLoadingIndicator(),
'loading_text' => $this->settings_repo->loadingText(),
'loading_image' => $this->settings_repo->loadingImage(),
'loading_image_active' => $this->settings_repo->loadingImage('active'),
'loading_image_preload' => $this->settings_repo->includeLoadingIndicatorPreload(),
'cache_enabled' => $this->settings_repo->cacheEnabled(),
'button_options' => $this->settings_repo->formattedButtonOptions(),
'authentication_modal_content' => $this->settings_repo->authenticationModalContent(),
'authentication_redirect' => $this->settings_repo->redirectAnonymous(),
'dev_mode' => $this->settings_repo->devMode(),
'logged_in' => is_user_logged_in(),
'user_id' => get_current_user_id()
];
$redirect_url = $this->settings_repo->redirectAnonymousId();
$localized_data['authentication_redirect_url'] = ( $redirect_url ) ? get_the_permalink($redirect_url) : apply_filters( 'favorites/authentication_redirect_url', wp_login_url() );
wp_localize_script(
'favorites',
'favorites_data',
$localized_data
);
}
}
\ No newline at end of file
<?php
namespace Favorites;
use Favorites\Config\SettingsRepository;
/**
* Plugin Bootstrap
*/
class Bootstrap
{
/**
* Settings Repository
* @var object
*/
private $settings_repo;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
add_action( 'init', [$this, 'init']);
add_action( 'admin_init', [$this, 'adminInit']);
add_filter( 'plugin_action_links_' . 'favorites/favorites.php', [$this, 'settingsLink']);
add_action( 'plugins_loaded', [$this, 'addLocalization']);
}
/**
* Initialize
*/
public function init()
{
new Config\Settings;
new Activation\Activate;
new Activation\Dependencies;
new Entities\Post\PostHooks;
new Events\RegisterPublicEvents;
new Entities\Post\PostMeta;
new API\Shortcodes\ButtonShortcode;
new API\Shortcodes\FavoriteCountShortcode;
new API\Shortcodes\UserFavoritesShortcode;
new API\Shortcodes\UserFavoriteCount;
new API\Shortcodes\PostFavoritesShortcode;
new API\Shortcodes\ClearFavoritesShortcode;
$this->startSession();
}
/**
* Admin Init
*/
public function adminInit()
{
new Entities\Post\AdminColumns;
}
/**
* Add a link to the settings on the plugin page
*/
public function settingsLink($links)
{
$settings_link = '<a href="options-general.php?page=simple-favorites">' . __('Settings', 'favorites') . '</a>';
$help_link = '<a href="http://favoriteposts.com">' . __('FAQ', 'favorites') . '</a>';
array_unshift($links, $help_link);
array_unshift($links, $settings_link);
return $links;
}
/**
* Localization Domain
*/
public function addLocalization()
{
load_plugin_textdomain(
'favorites',
false,
dirname( dirname( plugin_basename( __FILE__ ) ) ) . '/languages' );
}
/**
* Initialize a Session
*/
public function startSession()
{
if ( $this->settings_repo->saveType() !== 'session' ) return;
if ( !session_id() ) session_start();
}
}
\ No newline at end of file
<?php
namespace Favorites\Config;
use Favorites\Config\SettingsRepository;
use Favorites\Entities\PostType\PostTypeRepository;
use Favorites\Helpers;
/**
* Plugin Settings
*/
class Settings
{
/**
* Plugin Name
*/
private $plugin_name;
/**
* Settings Repository
*/
private $settings_repo;
/**
* Post Type Repository
*/
private $post_type_repo;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
$this->post_type_repo = new PostTypeRepository;
$this->setName();
add_action( 'admin_init', [$this, 'registerSettings']);
add_action( 'admin_menu', [$this, 'registerSettingsPage']);
}
/**
* Set the plugin name
*/
private function setName()
{
global $favorites_name;
$this->plugin_name = $favorites_name;
}
/**
* Register the settings page
*/
public function registerSettingsPage()
{
add_options_page(
$this->plugin_name . ' ' . __('Settings', 'favorites'),
$this->plugin_name,
'manage_options',
'simple-favorites',
[$this, 'settingsPage']
);
}
/**
* Display the Settings Page
*/
public function settingsPage()
{
$tab = ( isset($_GET['tab']) ) ? sanitize_text_field($_GET['tab']) : 'general';
include( Helpers::view('settings/settings') );
}
/**
* Register the settings
*/
public function registerSettings()
{
register_setting( 'simple-favorites-general', 'simplefavorites_dependencies' );
register_setting( 'simple-favorites-general', 'simplefavorites_cache_enabled' );
register_setting( 'simple-favorites-general', 'simplefavorites_dev_mode');
register_setting( 'simple-favorites-users', 'simplefavorites_users' );
register_setting( 'simple-favorites-display', 'simplefavorites_display' );
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Favorite;
use Favorites\Entities\User\UserRepository;
use Favorites\Config\SettingsRepository;
class ClearFavoritesButton
{
/**
* Site ID
*/
private $site_id;
/**
* User Respository
*/
private $user;
/**
* The Button Text
*/
private $text;
/**
* Settings Repository
*/
private $settings_repo;
public function __construct($site_id, $text)
{
$this->user = new UserRepository;
$this->settings_repo = new SettingsRepository;
$this->site_id = $site_id;
$this->text = $text;
}
/**
* Display the button
*/
public function display()
{
if ( !$this->user->getsButton() ) return false;
if ( !$this->text ) $this->text = html_entity_decode($this->settings_repo->clearFavoritesText());
if ( !$this->site_id ) $this->site_id = 1;
$out = '<button class="simplefavorites-clear" data-siteid="' . $this->site_id . '">' . $this->text . '</button>';
return $out;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Favorite;
use Favorites\Config\SettingsRepository;
use Favorites\Entities\Favorite\SyncSingleFavorite;
use Favorites\Entities\Post\SyncFavoriteCount;
class Favorite
{
/**
* Settings Repository
*/
private $settings_repo;
/**
* Save Type
*/
private $save_type;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
}
/**
* Save the Favorite
*/
public function update($post_id, $status, $site_id, $group_id = 1)
{
$this->save_type = $this->settings_repo->saveType();
$usersync = new SyncSingleFavorite($post_id, $site_id, $group_id);
$saveType = $this->save_type;
$usersync->$saveType();
$postsync = new SyncFavoriteCount($post_id, $status, $site_id);
$postsync->sync();
}
/**
* Get the Save Type
*/
public function saveType()
{
return $this->save_type;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Favorite;
use Favorites\Entities\User\UserRepository;
use Favorites\Entities\Post\FavoriteCount;
use Favorites\Config\SettingsRepository;
class FavoriteButton
{
/**
* The Post ID
*/
private $post_id;
/**
* Site ID
*/
private $site_id;
/**
* Group ID
*/
private $group_id;
/**
* User Respository
*/
private $user;
/**
* Favorite Count Object
*/
private $count;
/**
* Button Options
* @var array
*/
private $button_options;
/**
* Favorited?
* @var bool
*/
private $favorited;
/**
* Settings Repository
*/
private $settings_repo;
public function __construct($post_id, $site_id, $group_id = 1)
{
$this->user = new UserRepository;
$this->settings_repo = new SettingsRepository;
$this->count = new FavoriteCount;
$this->post_id = $post_id;
$this->site_id = $site_id;
$this->group_id = $group_id;
}
/**
* Diplay the Button
* @param boolean loading - whether to include loading class
* @return html
*/
public function display($loading = true)
{
// $cookie = json_decode(stripslashes($_COOKIE['simplefavorites']), true);
// var_dump($cookie[0]);
if ( !$this->settings_repo->cacheEnabled() ) $loading = false;
if ( !$this->user->getsButton() ) return false;
$this->button_options = $this->settings_repo->formattedButtonOptions();
$this->favorited = ( $this->user->isFavorite($this->post_id, $this->site_id, null, $this->group_id) ) ? true : false;
$count = $this->count->getCount($this->post_id, $this->site_id);
$button_html_type = apply_filters('favorites/button/element_type', $this->settings_repo->getButtonHtmlType(), $this->post_id, $this->site_id);
$html = $this->html();
$out = '<' . $button_html_type . ' class="' . $this->cssClasses($loading) . '"';
$out .= ' data-postid="' . $this->post_id . '" data-siteid="' . $this->site_id . '" data-groupid="' . $this->group_id . '" data-favoritecount="' . $count . '" style="' . $this->styleAttributes() . '">';
if ( $this->settings_repo->includeLoadingIndicator() && $this->settings_repo->includeLoadingIndicatorPreload() && $loading){
$out .= $this->settings_repo->loadingText();
$spinner = ( $this->favorited ) ? $this->settings_repo->loadingImage('active') : $this->settings_repo->loadingImage();
if ( $spinner ) $out .= $spinner;
} else {
$out .= $html;
if ( $this->button_options['include_count'] ) $out .= $this->addCount();
}
$out .= '</' . $button_html_type . '>';
return $out;
}
/**
* Add CSS Classes
*/
private function cssClasses($loading)
{
$classes = 'simplefavorite-button';
if ( $this->favorited ) $classes .= ' active';
if ( $this->button_options['include_count'] ) $classes .= ' has-count';
if ( $this->settings_repo->includeLoadingIndicator() && $this->settings_repo->includeLoadingIndicatorPreload() && $loading ) $classes .= ' loading';
if ( is_array($this->button_options['button_type']) ) $classes .= ' preset';
return apply_filters('favorites/button/css_classes', $classes, $this->post_id, $this->site_id);
}
/**
* Add Style Attributes
*/
private function styleAttributes($icon = false)
{
if ( !$this->button_options['custom_colors'] ) return null;
$html = '';
$default_colors = $this->button_options['default'];
$active_colors = $this->button_options['active'];
if ( $icon ){
if ( $this->favorited ){
if ( $active_colors['icon_active'] ) $html .= 'color:' . $active_colors['icon_active'] . ';';
} else {
if ( $default_colors['icon_default'] ) $html .= 'color:' . $default_colors['icon_default'] . ';';
}
return $html;
}
if ( !$this->button_options['box_shadow'] ) $html .= 'box-shadow:none;-webkit-box-shadow:none;-moz-box-shadow:none;';
if ( $this->favorited ) {
if ( $active_colors['background_active'] ) $html .= 'background-color:' . $active_colors['background_active'] . ';';
if ( $active_colors['border_active'] ) $html .= 'border-color:' . $active_colors['border_active'] . ';';
if ( $active_colors['text_active'] ) $html .= 'color:' . $active_colors['text_active'] . ';';
return $html;
}
if ( $default_colors['background_default'] ) $html .= 'background-color:' . $default_colors['background_default'] . ';';
if ( $default_colors['border_default'] ) $html .= 'border-color:' . $default_colors['border_default'] . ';';
if ( $default_colors['text_default'] ) $html .= 'color:' . $default_colors['text_default'] . ';';
return $html;
}
/**
* Build the HTML for the button
*/
private function html()
{
$html = '';
if ( is_array($this->button_options['button_type']) ) {
$html .= '<i class="' . $this->button_options['button_type']['icon_class'] . '" style="' . $this->styleAttributes(true) . '"></i>';
$html .= ( $this->favorited ) ? $this->button_options['button_type']['state_active'] : $this->button_options['button_type']['state_default'];
} else {
$html .= ( $this->favorited ) ? html_entity_decode($this->settings_repo->buttonTextFavorited()) : html_entity_decode($this->settings_repo->buttonText());
}
return apply_filters('favorites/button/html', $html, $this->post_id, $this->favorited, $this->site_id);
}
/**
* Add the favorite count
*/
private function addCount()
{
$default_colors = $this->button_options['default'];
$active_colors = $this->button_options['active'];
$html = '<span class="simplefavorite-button-count" style="';
if ( $this->favorited ){
if ( $active_colors['count_active'] ) $html .= 'color:' . $active_colors['count_active'] . ';';
} else {
if ( $default_colors['count_default'] ) $html .= 'color:' . $default_colors['count_default'] . ';';
}
$html .= '">' . $this->count->getCount($this->post_id, $this->site_id) . '</span>';
return apply_filters('favorites/button/count', $html);
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Favorite;
/**
* Filters an array of favorites using provided array of filters
*/
class FavoriteFilter
{
/**
* Favorites
* @var array of post IDs
*/
private $favorites;
/**
* Filters
* @var array
*
* Example:
*
* array(
* 'post_type' => array('post', 'posttypetwo'),
* 'terms' => array(
* 'category' => array(
* 'termone', 'termtwo', 'termthree'
* ),
* 'other-taxonomy' => array(
* 'termone', 'termtwo', 'termthree'
* )
* )
* );
*
*/
private $filters;
public function __construct($favorites, $filters)
{
$this->favorites = $favorites;
$this->filters = $filters;
}
public function filter()
{
if ( isset($this->filters['post_type']) && is_array($this->filters['post_type']) ) $this->filterByPostType();
if ( isset($this->filters['terms']) && is_array($this->filters['terms']) ) $this->filterByTerm();
if ( isset($this->filters['status']) && is_array($this->filters['status']) ) $this->filterByStatus();
return $this->favorites;
}
/**
* Filter favorites by post type
* @since 1.1.1
* @param array $favorites
*/
private function filterByPostType()
{
foreach($this->favorites as $key => $favorite){
$post_type = get_post_type($favorite);
if ( !in_array($post_type, $this->filters['post_type']) ) unset($this->favorites[$key]);
}
}
/**
* Filter favorites by status
* @since 2.1.4
*/
private function filterByStatus()
{
foreach($this->favorites as $key => $favorite){
$status = get_post_status($favorite);
if ( !in_array($status, $this->filters['status']) ) unset($this->favorites[$key]);
}
}
/**
* Filter favorites by terms
* @since 1.1.1
* @param array $favorites
*/
private function filterByTerm()
{
$taxonomies = $this->filters['terms'];
$favorites = $this->favorites;
foreach ( $favorites as $key => $favorite ) :
$all_terms = [];
$all_filters = [];
foreach ( $taxonomies as $taxonomy => $terms ){
if ( !isset($terms) || !is_array($terms) ) continue;
$post_terms = wp_get_post_terms($favorite, $taxonomy, array("fields" => "slugs"));
if ( !empty($post_terms) ) $all_terms = array_merge($all_terms, $post_terms);
$all_filters = array_merge($all_filters, $terms);
}
$dif = array_diff($all_filters, $all_terms);
if ( !empty($dif) ) unset($favorites[$key]);
endforeach;
$this->favorites = $favorites;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Favorite;
use Favorites\Entities\Post\FavoriteCount;
use Favorites\Entities\Favorite\FavoriteButton;
use Favorites\Entities\FavoriteList\FavoriteList;
/**
* Format the user's favorite array to include additional post data
*/
class FavoritesArrayFormatter
{
/**
* Formatted favorites array
*/
private $formatted_favorites;
/**
* Total Favorites Counter
*/
private $counter;
/**
* Post ID to add to return array
* For adding/removing session/cookie favorites for current request
* @var int
*/
private $post_id;
/**
* Site ID for post to add to array
* For adding/removing session/cookie favorites for current request
* @var int
*/
private $site_id;
/**
* Site ID for post to add to array
* For adding/removing session/cookie favorites for current request
* @var string
*/
private $status;
public function __construct()
{
$this->counter = new FavoriteCount;
}
public function format($favorites, $post_id = null, $site_id = null, $status = null)
{
$this->formatted_favorites = $favorites;
$this->post_id = $post_id;
$this->site_id = $site_id;
$this->status = $status;
$this->resetIndexes();
$this->addPostData();
return $this->formatted_favorites;
}
/**
* Reset the favorite indexes
*/
private function resetIndexes()
{
foreach ( $this->formatted_favorites as $site => $site_favorites ){
// Make older posts compatible with new name
if ( !isset($site_favorites['posts']) ) {
$site_favorites['posts'] = $site_favorites['site_favorites'];
unset($this->formatted_favorites[$site]['site_favorites']);
}
foreach ( $site_favorites['posts'] as $key => $favorite ){
unset($this->formatted_favorites[$site]['posts'][$key]);
$this->formatted_favorites[$site]['posts'][$favorite]['post_id'] = $favorite;
}
}
}
/**
* Add the post type to each favorite
*/
private function addPostData()
{
$this->checkCurrentPost();
foreach ( $this->formatted_favorites as $site => $site_favorites ){
foreach ( $site_favorites['posts'] as $key => $favorite ){
$site_id = $this->formatted_favorites[$site]['site_id'];
$this->formatted_favorites[$site]['posts'][$key]['post_type'] = get_post_type($key);
$this->formatted_favorites[$site]['posts'][$key]['title'] = get_the_title($key);
$this->formatted_favorites[$site]['posts'][$key]['permalink'] = get_the_permalink($key);
$this->formatted_favorites[$site]['posts'][$key]['total'] = $this->counter->getCount($key, $site_id);
$this->formatted_favorites[$site]['posts'][$key]['thumbnails'] = $this->getThumbnails($key);
$this->formatted_favorites[$site]['posts'][$key]['excerpt'] = apply_filters('the_excerpt', get_post_field('post_excerpt', $key));
$button = new FavoriteButton($key, $site_id);
$this->formatted_favorites[$site]['posts'][$key]['button'] = $button->display(false);
}
$this->formatted_favorites[$site] = array_reverse($this->formatted_favorites[$site]);
}
}
/**
* Make sure the current post is updated in the array
* (for cookie/session favorites, so AJAX response returns array with correct posts without page refresh)
*/
private function checkCurrentPost()
{
if ( !isset($this->post_id) || !isset($this->site_id) ) return;
if ( is_user_logged_in() ) return;
foreach ( $this->formatted_favorites as $site => $site_favorites ){
if ( $site_favorites['site_id'] == $this->site_id ) {
if ( isset($site_favorites['posts'][$this->post_id]) && $this->status == 'inactive' ){
unset($this->formatted_favorites[$site]['posts'][$this->post_id]);
} else {
$this->formatted_favorites[$site]['posts'][$this->post_id] = array('post_id' => $this->post_id);
}
}
}
}
/**
* Add thumbnail urls to the array
*/
private function getThumbnails($post_id)
{
if ( !has_post_thumbnail($post_id) ) return false;
$sizes = get_intermediate_image_sizes();
$thumbnails = [];
foreach ( $sizes as $size ){
$url = get_the_post_thumbnail_url($post_id, $size);
$img = '<img src="' . $url . '" alt="' . get_the_title($post_id) . '" class="favorites-list-thumbnail" />';
$thumbnails[$size] = apply_filters('favorites/list/thumbnail', $img, $post_id, $size);
}
return $thumbnails;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Favorite;
use Favorites\Config\SettingsRepository;
/**
* Sync all favorites for a specific site
*/
class SyncAllFavorites
{
/**
* Favorites to Save
* @var array
*/
private $favorites;
/**
* Settings Repository
*/
private $settings_repo;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
}
/**
* Sync the favorites
*/
public function sync($favorites)
{
$this->favorites = $favorites;
$saveType = $this->settings_repo->saveType();
$this->$saveType();
$this->updateUserMeta();
}
/**
* Sync Session Favorites
*/
private function session()
{
return $_SESSION['simplefavorites'] = $this->favorites;
}
/**
* Sync a Cookie Favorite
*/
public function cookie()
{
setcookie( 'simplefavorites', json_encode( $this->favorites ), time() + apply_filters( 'simplefavorites_cookie_expiration_interval', 31556926 ), '/' );
return;
}
/**
* Update User Meta (logged in only)
*/
private function updateUserMeta()
{
if ( !is_user_logged_in() ) return false;
return update_user_meta( intval(get_current_user_id()), 'simplefavorites', $this->favorites );
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Favorite;
use Favorites\Entities\User\UserRepository;
use Favorites\Helpers;
/**
* Sync a single favorite to a given save type
*/
class SyncSingleFavorite
{
/**
* The Post ID
*/
private $post_id;
/**
* The Site ID
*/
private $site_id;
/**
* The Group ID
*/
private $group_id;
/**
* User Repository
*/
private $user;
public function __construct($post_id, $site_id, $group_id = 1)
{
$this->user = new UserRepository;
$this->post_id = $post_id;
$this->site_id = $site_id;
$this->group_id = $group_id;
}
/**
* Sync a Session Favorite
*/
public function session()
{
if ( $this->user->isFavorite($this->post_id, $this->site_id) ) return $_SESSION['simplefavorites'] = $this->removeFavorite();
return $_SESSION['simplefavorites'] = $this->addFavorite();
}
/**
* Sync a Cookie Favorite
*/
public function cookie()
{
if ( $this->user->isFavorite($this->post_id, $this->site_id) ){
$favorites = $this->removeFavorite();
setcookie( 'simplefavorites', json_encode( $favorites ), time() + apply_filters( 'simplefavorites_cookie_expiration_interval', 31556926 ), '/' );
return;
}
$favorites = $this->addFavorite();
setcookie( 'simplefavorites', json_encode( $favorites ), time() + apply_filters( 'simplefavorites_cookie_expiration_interval', 31556926 ), '/' );
return;
}
/**
* Update User Meta (logged in only)
*/
public function updateUserMeta($favorites)
{
if ( !is_user_logged_in() ) return;
update_user_meta( intval(get_current_user_id()), 'simplefavorites', $favorites );
}
/**
* Remove a Favorite
*/
private function removeFavorite()
{
$favorites = $this->user->getAllFavorites($this->site_id);
foreach($favorites as $key => $site_favorites){
if ( $site_favorites['site_id'] !== $this->site_id ) continue;
foreach($site_favorites['posts'] as $k => $fav){
if ( $fav == $this->post_id ) unset($favorites[$key]['posts'][$k]);
}
if ( !Helpers::groupsExist($site_favorites) ) return;
foreach( $site_favorites['groups'] as $group_key => $group){
if ( $group['group_id'] !== $this->group_id ) continue;
foreach ( $group['posts'] as $k => $g_post_id ){
if ( $g_post_id == $this->post_id ) unset($favorites[$key]['groups'][$group_key]['posts'][$k]);
}
}
}
$this->updateUserMeta($favorites);
return $favorites;
}
/**
* Add a Favorite
*/
private function addFavorite()
{
$favorites = $this->user->getAllFavorites($this->site_id);
if ( !Helpers::siteExists($this->site_id, $favorites) ){
$favorites[] = [
'site_id' => $this->site_id,
'posts' => []
];
}
// Loop through each site's favorites, continue if not the correct site id
foreach($favorites as $key => $site_favorites){
if ( $site_favorites['site_id'] !== $this->site_id ) continue;
$favorites[$key]['posts'][] = $this->post_id;
// Add the default group if it doesn't exist yet
if ( !Helpers::groupsExist($site_favorites) ){
$favorites[$key]['groups'] = [
[
'group_id' => 1,
'site_id' => $this->site_id,
'group_name' => __('Default List', 'favorites'),
'posts' => array()
]
];
}
foreach( $favorites[$key]['groups'] as $group_key => $group){
if ( $group['group_id'] == $this->group_id )
$favorites[$key]['groups'][$group_key]['posts'][] = $this->post_id;
}
}
$this->updateUserMeta($favorites);
return $favorites;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\FavoriteList;
/**
* Get a full list of user favorites
* @param array of options from shortcode/api function
*/
class FavoriteList extends FavoriteListBase
{
public function __construct($options)
{
parent::__construct($options);
}
/**
* Get the list
*/
public function getList()
{
$list = ( !$this->list_options->customize_markup || !$this->list_options->custom_markup_html )
? new FavoriteListTypeDefault($this->list_options)
: new FavoriteListTypeCustom($this->list_options);
return $list->getListMarkup();
}
/**
* Get a single listing
*/
public function getListing($post_id)
{
$list = ( !$this->list_options->customize_markup || !$this->list_options->custom_markup_html )
? new FavoriteListTypeDefault($this->list_options)
: new FavoriteListTypeCustom($this->list_options);
return $list->listing($post_id);
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\FavoriteList;
use Favorites\Config\SettingsRepository;
use Favorites\Entities\FavoriteList\FavoriteListDefault;
use Favorites\Entities\FavoriteList\FavoriteListCustom;
abstract class FavoriteListBase
{
/**
* List Options
* @var object
*/
protected $list_options;
/**
* Settings Repository
*/
protected $settings_repo;
public function __construct($list_options)
{
$this->list_options = $list_options;
$this->settings_repo = new SettingsRepository;
$this->setOptions();
}
/**
* Set the list default options
*/
protected function setOptions()
{
$options = $this->list_options;
$this->list_options = new \stdClass;
$this->list_options->user_id = ( isset($options['user_id']) ) ? $options['user_id'] : null;
if ( ($this->list_options->user_id && isset($options['include_button'])) && ( get_current_user_id() !== $this->list_options->user_id ) ) unset($options['include_button']);
$this->list_options->site_id = ( isset($options['site_id']) ) ? $options['site_id'] : null;
$this->list_options->filters = ( isset($options['filters']) ) ? $options['filters'] : null;
$this->list_options->include_button = ( isset($options['include_button']) ) ? $options['include_button'] : false;
$this->list_options->include_thumbnails = ( isset($options['include_thumbnails']) ) ? $options['include_thumbnails'] : false;
$this->list_options->thumbnail_size = ( isset($options['thumbnail_size']) ) ? $options['thumbnail_size'] : 'thumbnail';
$this->list_options->include_excerpt = ( isset($options['include_excerpt']) ) ? $options['include_excerpt'] : false;
$this->list_options->include_links = ( isset($options['include_links']) ) ? $options['include_links'] : false;
$this->list_options->customized = $this->settings_repo->listCustomization('customize');
$this->list_options->wrapper_type = 'ul';
$this->list_options->wrapper_css = '';
$this->list_options->listing_type = 'li';
$this->list_options->listing_css = '';
$this->list_options->no_favorites = ( isset($options['no_favorites']) ) ? $options['no_favorites'] : '';
$this->setCustomOptions();
if ( !property_exists($this->list_options, 'customize_markup') ) $this->list_options->customize_markup = false;
if ( !property_exists($this->list_options, 'custom_markup_html') ) $this->list_options->custom_markup_html = false;
}
/**
* Set the list customized options
*/
protected function setCustomOptions()
{
$options = $this->settings_repo->listCustomization('all');
if ( !$options ) return;
foreach ( $options as $option => $val ){
if ( $option == 'customize' ) continue;
if ( $val == '' ) continue;
$this->list_options->$option = ( $val == 'true' ) ? true : sanitize_text_field($val);
if ( $option == 'custom_markup_html' ) $this->list_options->custom_markup_html = $val;
}
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\FavoriteList;
use Favorites\Entities\User\UserFavorites;
use Favorites\Config\SettingsRepository;
use Favorites\Entities\FavoriteList\FavoriteListingPresenter;
use Favorites\Entities\PostType\PostTypeRepository;
/**
* Base class for favorite lists
*/
abstract class FavoriteListTypeBase
{
/**
* List options
* @var object
*/
protected $list_options;
/**
* User favorites object
*/
protected $user_favorites;
/**
* Settings Repo
*/
protected $settings_repo;
/**
* Post Type Repo
*/
protected $post_type_repo;
/**
* User's Favorites
*/
protected $favorites;
/**
* Listing Presenter
*/
protected $listing_presenter;
public function __construct($list_options)
{
$this->settings_repo = new SettingsRepository;
$this->post_type_repo = new PostTypeRepository;
$this->user_favorites = new UserFavorites;
$this->listing_presenter = new FavoriteListingPresenter;
$this->list_options = $list_options;
$this->setApiOptions();
$this->setFavorites();
$this->setNoFavoritesText();
$this->setPostTypes();
}
/**
* Set the API options (defined in shortcode and api functions)
*/
protected function setApiOptions()
{
$this->list_options->site_id = ( is_null($this->list_options->site_id) || $this->list_options->site_id == '' )
? get_current_blog_id() : $this->list_options->site_id;
$this->list_options->user_id = ( is_null($this->list_options->user_id) || $this->list_options->user_id == '' )
? null : $this->list_options->user_id;
$this->list_options->filters = ( is_null($this->list_options->filters) || $this->list_options->filters == '' )
? null : $this->list_options->filters;
}
/**
* Set the favorites
*/
protected function setFavorites()
{
$favorites = $this->user_favorites->getFavoritesArray($this->list_options->user_id, $this->list_options->site_id, $this->list_options->filters);
$this->favorites = ( isset($favorites[0]['site_id']) ) ? $favorites[0]['posts'] : $favorites;
}
/**
* Set the no favorites text
*/
protected function setNoFavoritesText()
{
if ( $this->list_options->no_favorites == '' )
$this->list_options->no_favorites = $this->settings_repo->noFavoritesText();
}
/**
* Set the post types
*/
protected function setPostTypes()
{
$this->list_options->post_types = implode(',', $this->post_type_repo->getAllPostTypes('names', true));
if ( isset($this->list_options->filters['post_type']) )
$this->list_options->post_types = implode(',', $this->list_options->filters['post_type']);
}
/**
* Generate the list opening
*/
protected function listOpening()
{
$css = apply_filters('favorites/list/wrapper/css', $this->list_options->wrapper_css, $this->list_options);
$out = '<' . $this->list_options->wrapper_type;
$out .= ' class="favorites-list ' . $css . '" data-userid="' . $this->list_options->user_id . '" data-siteid="' . $this->list_options->site_id . '" ';
$out .= ( $this->list_options->include_button ) ? 'data-includebuttons="true"' : 'data-includebuttons="false"';
$out .= ( $this->list_options->include_links ) ? ' data-includelinks="true"' : ' data-includelinks="false"';
$out .= ( $this->list_options->include_thumbnails ) ? ' data-includethumbnails="true"' : ' data-includethumbnails="false"';
$out .= ( $this->list_options->include_excerpt ) ? ' data-includeexcerpts="true"' : ' data-includeexcerpts="false"';
$out .= ' data-thumbnailsize="' . $this->list_options->thumbnail_size . '"';
$out .= ' data-nofavoritestext="' . $this->list_options->no_favorites . '"';
$out .= ' data-posttypes="' . $this->list_options->post_types . '"';
$out .= '>';
return $out;
}
/**
* Generate the list closing
*/
protected function listClosing()
{
return '</' . $this->list_options->wrapper_type . '>';
}
/**
* Generates the no favorites item
*/
protected function noFavorites()
{
if ( !empty($this->favorites) ) return;
$out = $this->listOpening();
$out .= '<' . $this->list_options->wrapper_type;
$out .= ' data-postid="0" data-nofavorites class="no-favorites">' . $this->list_options->no_favorites;
$out .= '</' . $this->list_options->wrapper_type . '>';
$out .= $this->listClosing();
return $out;
}
/**
* Get the markup for a full list
*/
public function getListMarkup()
{
if ( is_multisite() ) switch_to_blog($this->list_options->site_id);
if ( empty($this->favorites) ) return $this->noFavorites();
$out = $this->listOpening();
foreach ( $this->favorites as $key => $favorite ){
$out .= $this->listing($favorite);
}
$out .= $this->listClosing();
if ( is_multisite() ) restore_current_blog();
return $out;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\FavoriteList;
use Favorites\Entities\User\UserFavorites;
use Favorites\Config\SettingsRepository;
/**
* Generate the list for custom markup list
*/
class FavoriteListTypeCustom extends FavoriteListTypeBase
{
public function __construct($list_options)
{
parent::__construct($list_options);
}
public function listing($favorite)
{
return $this->listing_presenter->present($this->list_options, $this->list_options->custom_markup_html, $favorite);
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\FavoriteList;
use Favorites\Entities\Favorite\FavoriteButton;
/**
* Create a favorites list using the default markup
*/
class FavoriteListTypeDefault extends FavoriteListTypeBase
{
public function __construct($list_options)
{
parent::__construct($list_options);
}
private function setTemplate()
{
$template = '';
if ( $this->list_options->include_thumbnails ) $template .= '[post_thumbnail_' . $this->list_options->thumbnail_size . ']';
$template .= "\n\n";
if ( $this->list_options->include_links ) $template .= '<a href="[post_permalink]">';
$template .= '[post_title]';
if ( $this->list_options->include_links ) $template .= '</a>';
$template .= "\n\n";
if ( $this->list_options->include_excerpt ) $template .= "[post_excerpt]\n\n";
if ( $this->list_options->include_button )$template .= "[favorites_button]";
return $template;
}
/**
* Generate a single listing
* @param int favorite post id
*/
public function listing($favorite)
{
return $this->listing_presenter->present($this->list_options, $this->setTemplate(), $favorite);
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\FavoriteList;
/*
* Filters the favorites listing markup
*/
class FavoriteListingPresenter
{
/**
* The list options
* @var object
*/
private $list_options;
/**
* The Favorite Post ID
* @var int
*/
private $favorite;
/**
* The custom markup
* @var str
*/
private $markup;
/**
* The return html
* @var str
*/
private $html;
/**
* Primary API Method
* @param str markup
* @param int favorite
*/
public function present($list_options, $markup, $favorite)
{
$this->list_options = $list_options;
$this->markup = $markup;
$this->favorite = $favorite;
$this->listingOpening();
$this->filterMarkup();
$this->listingClosing();
return apply_filters('favorites/list/listing/html', $this->html, $this->markup, $this->favorite, $this->list_options);
}
/**
* Create the listing opening
*/
private function listingOpening()
{
$css = apply_filters('favorites/list/listing/css', $this->list_options->listing_css, $this->list_options);
$this->html = '<' . $this->list_options->listing_type;
$this->html .= ' data-postid="' . $this->favorite . '" class="' . $css . '">';
}
/**
* Create the listing closing
*/
private function listingClosing()
{
$this->html .= '</' . $this->list_options->listing_type . '>';
}
/**
* Filter the markup
*/
private function filterMarkup()
{
$this->html .= apply_filters('the_content', $this->markup);
$this->replacePostFields();
$this->replaceFavoritesFields();
$this->replaceThumbnails();
$this->replaceCustomFields();
}
/**
* Replace Post Fields
*/
private function replacePostFields()
{
$this->html = str_replace('[post_title]', get_the_title($this->favorite), $this->html);
$this->html = str_replace('[post_permalink]', get_permalink($this->favorite), $this->html);
$this->html = str_replace('[permalink]', '<a href="' . get_permalink($this->favorite) . '">', $this->html);
$this->html = str_replace('[/permalink]', '</a>', $this->html);
$this->html = str_replace('[post_excerpt]', $this->getPostExcerpt(), $this->html);
$this->html = str_replace('[post_content]', get_the_content($this->favorite), $this->html);
}
/**
* Replace Favorites Fields
*/
private function replaceFavoritesFields()
{
$this->html = str_replace(
'[favorites_count]',
'<span class="simplefavorites-user-count" data-posttypes="' . $this->list_options->post_types . '" data-siteid="' . $this->list_options->site_id . '">' . get_favorites_count($this->favorite, $this->list_options->site_id) . '</span>',
$this->html
);
$this->html = str_replace('[favorites_button]', get_favorites_button($this->favorite, $this->list_options->site_id), $this->html);
}
/**
* Replace Thumbnails
*/
private function replaceThumbnails()
{
$sizes = get_intermediate_image_sizes();
foreach ( $sizes as $size ){
if ( strpos($this->html, '[post_thumbnail_' . $size) !== false ){
$thumb = apply_filters('favorites/list/thumbnail', $this->getThumbnail($size), $this->favorite, $this->list_options->thumbnail_size);
$this->html = str_replace('[post_thumbnail_' . $size . ']', $thumb, $this->html);
}
}
}
/**
* Get a thumbnail
*/
private function getThumbnail($size)
{
return ( has_post_thumbnail($this->favorite) ) ? get_the_post_thumbnail($this->favorite, $size) : ' ';
}
/**
* Replace custom fields
*/
private function replaceCustomFields()
{
preg_match_all("/\[[^\]]*\]/", $this->html, $out);
if ( empty($out) ) return;
foreach($out[0] as $field){
$field_bracketed = $field;
$key = str_replace('[', '', $field);
$key = str_replace('custom_field:', '', $key);
$key = str_replace(']', '', $key);
$meta = get_post_meta($this->favorite, $key, true);
if ( !$meta ) $meta = '';
if ( is_array($meta) ) $meta = '';
$this->html = str_replace($field_bracketed, $meta, $this->html);
}
}
/**
* Get the post excerpt
*/
private function getPostExcerpt()
{
$post_id = $this->favorite;
$custom_excerpt = get_post_field('post_excerpt', $this->favorite);
if ( $custom_excerpt ) return $custom_excerpt;
$the_post = get_post($post_id);
$the_excerpt = $the_post->post_content;
$excerpt_length = 35;
$the_excerpt = strip_tags(strip_shortcodes($the_excerpt));
$words = explode(' ', $the_excerpt, $excerpt_length + 1);
if ( count($words) > $excerpt_length ) :
array_pop($words);
array_push($words, '…');
$the_excerpt = implode(' ', $words);
endif;
return $the_excerpt;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Post;
use Favorites\Config\SettingsRepository;
use Favorites\Entities\PostType\PostTypeRepository;
/**
* Add Post Favorite Counts to Admin Columns
*/
class AdminColumns
{
/**
* Settings Repository
*/
private $settings_repo;
/**
* Post Type Repository
*/
private $post_type_repo;
/**
* Post Type
*/
private $post_types;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
$this->post_type_repo = new PostTypeRepository;
$this->setPostTypes();
$this->addHooks();
}
/**
* Set the Post Types
*/
private function setPostTypes()
{
$this->post_types = [];
foreach ( $this->post_type_repo->getAllPostTypes() as $key => $posttype ) :
$display = $this->settings_repo->displayInPostType($posttype);
if ( isset($display['admincolumns']) ) array_push($this->post_types, $key);
endforeach;
}
/**
* Add Hooks
*/
private function addHooks()
{
foreach($this->post_types as $type){
add_filter('manage_' . $type . '_posts_columns', [$this, 'addColumn']);
add_action('manage_' . $type . '_posts_custom_column', [$this, 'addColumnData'], 10, 2);
}
}
/**
* Add the column
*/
public function addColumn($columns)
{
$new_column = ['favorites' => __('Favorites', 'favorites')];
return array_merge($columns, $new_column);
}
/**
* Add the column data
*/
public function addColumnData($column, $post_id)
{
if ( $column !== 'favorites' ) return;
echo get_favorites_count($post_id);
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Post;
/**
* Returns the total number of favorites for a post
*/
class FavoriteCount
{
/**
* Get the favorite count for a post
*/
public function getCount($post_id, $site_id = null)
{
if ( (is_multisite()) && (isset($site_id)) && ($site_id !== "") ) switch_to_blog(intval($site_id));
$count = get_post_meta($post_id, 'simplefavorites_count', true);
if ( $count == '' ) $count = 0;
if ( (is_multisite()) && (isset($site_id) && ($site_id !== "")) ) restore_current_blog();
return intval($count);
}
/**
* Get the favorite count for all posts in a site
*/
public function getAllCount($site_id = null)
{
if ( (is_multisite()) && (isset($site_id)) && ($site_id !== "") ) switch_to_blog(intval($site_id));
global $wpdb;
$query = "SELECT SUM(meta_value) AS favorites_count FROM {$wpdb->prefix}postmeta WHERE meta_key = 'simplefavorites_count'";
$count = $wpdb->get_var( $query );
if ( (is_multisite()) && (isset($site_id) && ($site_id !== "")) ) restore_current_blog();
return intval($count);
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Post;
use Favorites\Entities\User\UserRepository;
use Favorites\Entities\Post\FavoriteCount;
/**
* Get the users who have favorited a specific post
*/
class PostFavorites
{
/**
* Post ID
*/
private $post_id;
/**
* Site ID
*/
private $site_id;
/**
* User Role
*/
private $user_role;
/**
* User Repository
* @var Favorites\Entities\User\UserRepository;
*/
private $user_repo;
/**
* Favorite Count
* @var Favorites\Entities\Post\FavoriteCount
*/
private $favorite_count;
public function __construct($post_id, $site_id, $user_role)
{
$this->post_id = ( $post_id ) ? $post_id : get_the_id();
$this->site_id = ( $site_id ) ? $site_id : get_current_blog_id();
$this->user_role = ( $user_role ) ? $user_role : '';
$this->user_repo = new UserRepository;
$this->favorite_count = new FavoriteCount;
}
/**
* Get an array of users who favorited the post
* @return array of user objects
*/
public function getUsers()
{
$users = $this->getAllUsers();
foreach($users as $key => $user){
if ( !$this->user_repo->isFavorite($this->post_id, $this->site_id, $user->ID) ){
unset($users[$key]);
}
}
return $users;
}
/**
* Get all Users
*/
private function getAllUsers()
{
$user_query = new \WP_User_Query([
'blog_id' => ( $this->site_id ) ? $this->site_id : get_current_blog_id(),
'role' => $this->user_role
]);
$users = $user_query->get_results();
return $users;
}
/**
* Get the number of Anonymous Users who have favorited the post
*/
public function anonymousCount()
{
$total_count = $this->favorite_count->getCount($this->post_id, $this->site_id);
$registered_count = count($this->getUsers());
return $total_count - $registered_count;
}
/**
* Get an HTML formatted list of users who have favorited the post
* @param string $separator (list, or string to separate each item)
* @param boolean $include_anonymous
* @param string $anonymous_label
* @param string $anonymous_label_single
*/
public function userList($separator, $include_anonymous, $anonymous_label, $anonymous_label_single)
{
$users = $this->getUsers();
$total = ( $include_anonymous ) ? count($users) + 1 : count($users);
$anonymous_count = $this->anonymousCount();
$out = ( $separator == 'list' ) ? '<ul>' : '';
foreach($users as $key => $user){
if ( $separator == 'list' ) $out .= '<li>';
$out .= $user->display_name;
if ( $separator == 'list' ) {
$out .= '</li>';
} else {
if ( $key + 1 < $total ) $out .= $separator;
}
}
if ( $include_anonymous ){
$label = ( $anonymous_count == 1 ) ? $anonymous_label_single : $anonymous_label;
if ( $separator == 'list' ){
$out .= '<li>' . $anonymous_count . ' ' . $label . '</li>';
} else {
$out .= $anonymous_count . ' ' . $label;
}
}
if ( $separator == 'list' ) $out .= '</ul>';
return apply_filters('simplefavorites_user_list', $out, $users, $anonymous_count);
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Post;
use Favorites\Config\SettingsRepository;
use Favorites\Entities\Favorite\FavoriteButton;
/**
* Post Actions and Filters
*/
class PostHooks
{
/**
* Settings Repository
*/
private $settings_repo;
/**
* The Content
*/
private $content;
/**
* The Post Object
*/
private $post;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
add_filter('the_content', [$this, 'filterContent']);
}
/**
* Filter the Content
*/
public function filterContent($content)
{
global $post;
if ( !$post ) return $content;
$this->post = $post;
$this->content = $content;
$display = $this->settings_repo->displayInPostType($post->post_type);
if ( !$display ) return $content;
return $this->addFavoriteButton($display);
}
/**
* Add the Favorite Button
* @todo add favorite button html
*/
private function addFavoriteButton($display_in)
{
$output = '';
if ( isset($display_in['before_content']) && $display_in['before_content'] == 'true' ){
$output .= get_favorites_button();
}
$output .= $this->content;
if ( isset($display_in['after_content']) && $display_in['after_content'] == 'true' ){
$output .= get_favorites_button();
}
return $output;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Post;
use Favorites\Config\SettingsRepository;
use Favorites\Entities\Post\FavoriteCount;
class PostMeta
{
/**
* Settings Repository
*/
private $settings_repo;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
add_action( 'add_meta_boxes', [$this, 'favoriteCountBox']);
}
/**
* Add the Favorite Count Meta Box for enabled Types
*/
public function favoriteCountBox()
{
foreach ( $this->settings_repo->metaEnabled() as $type ){
add_meta_box(
'favorites',
__( 'Favorites', 'favorites' ),
[$this, 'favoriteCount'],
$type,
'side',
'low'
);
}
}
/**
* The favorite count
*/
public function favoriteCount()
{
global $post;
$count = new FavoriteCount;
echo '<strong>' . __('Total Favorites', 'favorites') . ':</strong> ';
echo $count->getCount($post->ID);
echo '<input type="hidden" name="simplefavorites_count" value="' . $count->getCount($post->ID) . '">';
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\Post;
use Favorites\Entities\Post\FavoriteCount;
use Favorites\Entities\User\UserRepository;
/**
* Updates the favorite count for a given post
*/
class SyncFavoriteCount
{
/**
* Post ID
* @var int
*/
private $post_id;
/**
* Site ID
* @var int
*/
private $site_id;
/**
* Status
* @var string
*/
private $status;
/**
* Favorite Count
* @var object
*/
private $favorite_count;
/**
* User Repository
*/
private $user;
public function __construct($post_id, $status, $site_id)
{
$this->post_id = $post_id;
$this->status = $status;
$this->site_id = $site_id;
$this->favorite_count = new FavoriteCount;
$this->user = new UserRepository;
}
/**
* Sync the Post Total Favorites
*/
public function sync()
{
if ( !$this->user->countsInTotal() ) return false;
$count = $this->favorite_count->getCount($this->post_id, $this->site_id);
$count = ( $this->status == 'active' ) ? $count + 1 : max(0, $count - 1);
return update_post_meta($this->post_id, 'simplefavorites_count', $count);
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\PostType;
class PostTypeRepository
{
/**
* Get all registered post types
* @since 1.0
* @return array
*/
public function getAllPostTypes($return = 'names', $flat_array = false)
{
$args = [
'public' => true,
'show_ui' => true
];
$post_types = get_post_types($args, $return);
if ( !$flat_array ) return $post_types;
$post_types_flat = [];
foreach ($post_types as $key => $value) {
$post_types_flat[] = $value;
}
return $post_types_flat;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\User;
use Favorites\Entities\User\UserRepository;
use Favorites\Entities\Favorite\FavoriteFilter;
use Favorites\Entities\FavoriteList\FavoriteList;
class UserFavorites
{
/**
* User ID
* @var int
*/
private $user_id;
/**
* Site ID
* @var int
*/
private $site_id;
/**
* Display Links
* @var boolean
*/
private $links;
/**
* Filters
* @var array
*/
private $filters;
/**
* User Repository
*/
private $user_repo;
public function __construct($user_id = null, $site_id = null, $links = false, $filters = null)
{
$this->user_id = $user_id;
$this->site_id = $site_id;
$this->links = $links;
$this->filters = $filters;
$this->user_repo = new UserRepository;
}
/**
* Get an array of favorites for specified user
*/
public function getFavoritesArray($user_id = null, $site_id = null, $filters = null)
{
$user_id = ( isset($user_id) ) ? $user_id : $this->user_id;
$site_id = ( isset($site_id) ) ? $site_id : $this->site_id;
$favorites = $this->user_repo->getFavorites($user_id, $site_id);
if ( isset($filters) ) $this->filters = $filters;
if ( isset($this->filters) && is_array($this->filters) ) $favorites = $this->filterFavorites($favorites);
return $this->removeInvalidFavorites($favorites);
}
/**
* Remove non-existent or non-published favorites
* @param array $favorites
*/
private function removeInvalidFavorites($favorites)
{
foreach($favorites as $key => $favorite){
if ( !$this->postExists($favorite) ) unset($favorites[$key]);
}
return $favorites;
}
/**
* Filter the favorites
* @since 1.1.1
* @param array $favorites
*/
private function filterFavorites($favorites)
{
$favorites = new FavoriteFilter($favorites, $this->filters);
return $favorites->filter();
}
/**
* Return an HTML list of favorites for specified user
* @param $include_button boolean - whether to include the favorite button
* @param $include_thumbnails boolean - whether to include post thumbnails
* @param $thumbnail_size string - thumbnail size to display
* @param $include_excerpt boolean - whether to include the post excerpt
*/
public function getFavoritesList($include_button = false, $include_thumbnails = false, $thumbnail_size = 'thumbnail', $include_excerpt = false, $no_favorites = '')
{
$list_args = [
'include_button' => $include_button,
'include_thumbnails' => $include_thumbnails,
'thumbnail_size' => $thumbnail_size,
'include_excerpt' => $include_excerpt,
'include_links' => $this->links,
'site_id' => $this->site_id,
'user_id' => $this->user_id,
'no_favorites' => $no_favorites,
'filters' => $this->filters,
];
$list = new FavoriteList($list_args);
return $list->getList();
}
/**
* Check if post exists and is published
*/
private function postExists($id)
{
$allowed_statuses = ( isset($this->filters['status']) && is_array($this->filters['status']) ) ? $this->filters['status'] : array('publish');
$status = get_post_status($id);
if ( !$status ) return false;
if ( !in_array($status, $allowed_statuses) ) return false;
return true;
}
}
\ No newline at end of file
<?php
namespace Favorites\Entities\User;
use Favorites\Config\SettingsRepository;
use Favorites\Helpers;
use Favorites\Entities\Favorite\FavoritesArrayFormatter;
class UserRepository
{
/**
* Settings Repository
*/
private $settings_repo;
public function __construct()
{
$this->settings_repo = new SettingsRepository;
}
/**
* Display button for current user
* @return boolean
*/
public function getsButton()
{
if ( is_user_logged_in() ) return true;
if ( $this->settings_repo->anonymous('display') ) return true;
if ( $this->settings_repo->requireLogin() ) return true;
if ( $this->settings_repo->redirectAnonymous() ) return true;
return false;
}
/**
* Get All of current user's favorites (includes all sites)
* @return array (multidimensional)
*/
public function getAllFavorites()
{
if ( is_user_logged_in() ) {
$all_favorites = $this->getLoggedInFavorites();
} else {
$saveType = $this->settings_repo->saveType();
$favorites = ( $saveType == 'cookie' ) ? $this->getCookieFavorites() : $this->getSessionFavorites();
$all_favorites = $this->favoritesWithSiteID($favorites);
}
/**
* Filter All of current user's favorites.
*
* @since 1.3.0
* @param array The original current user's favorites.
*/
$all_favorites = apply_filters('favorites/user/favorites/all', $all_favorites);
return $all_favorites;
}
/**
* Get User's Favorites by Site ID (includes a single site)
* @return array (flat)
*/
public function getFavorites($user_id = null, $site_id = null, $group_id = null)
{
if ( is_user_logged_in() && !$user_id ) $user_id = get_current_user_id();
if ( is_user_logged_in() || $user_id ) {
$favorites = $this->getLoggedInFavorites($user_id, $site_id, $group_id);
} else {
$saveType = $this->settings_repo->saveType();
$favorites = ( $saveType == 'cookie' )
? $this->getCookieFavorites($site_id, $group_id)
: $this->getSessionFavorites($site_id, $group_id);
}
/**
* Filter a User's Favorites.
*
* @since 1.3.0
* @param array The original User's Favorites.
*/
$favorites = apply_filters('favorites/user/favorites', $favorites);
return $favorites;
}
/**
* Check for Site ID in user's favorites
* Multisite Compatibility for >1.1
* 1.2 compatibility with new naming structure
* @since 1.1
*/
private function favoritesWithSiteID($favorites)
{
if ( Helpers::keyExists('site_favorites', $favorites) ){
foreach($favorites as $key => $site_favorites){
if ( !isset($favorites[$key]['site_favorites']) ) continue;
$favorites[$key]['posts'] = $favorites[$key]['site_favorites'];
unset($favorites[$key]['site_favorites']);
if ( isset($favorites[$key]['total']) ) unset($favorites[$key]['total']);
}
}
if ( Helpers::keyExists('site_id', $favorites) ) return $favorites;
$new_favorites = [
[
'site_id' => 1,
'posts' => $favorites
]
];
return $new_favorites;
}
/**
* Check for Groups array in user's favorites
* Add all favorites to the default group if it doesn't exist
* Compatibility for < 2.2
* @since 2.2
*/
private function favoritesWithGroups($favorites)
{
if ( Helpers::groupsExist($favorites[0]) ) return $favorites;
$data = [
'group_id' => 1,
'site_id' => $favorites[0]['site_id'],
'group_name' => __('Default List', 'favorites'),
'posts' => $favorites[0]['posts']
];
$favorites[0]['groups'] = [
$data
];
return $favorites;
}
/**
* Get Logged In User Favorites
*/
private function getLoggedInFavorites($user_id = null, $site_id = null, $group_id = null)
{
$user_id = ( is_null($user_id) ) ? get_current_user_id() : $user_id;
$favorites = get_user_meta($user_id, 'simplefavorites');
if ( empty($favorites) ) return array(array('site_id'=> 1, 'posts' => [], 'groups' => [] ));
$favorites = $this->favoritesWithSiteID($favorites[0]);
$favorites = $this->favoritesWithGroups($favorites);
if ( !is_null($site_id) && is_null($group_id) ) $favorites = Helpers::pluckSiteFavorites($site_id, $favorites);
if ( !is_null($group_id) ) $favorites = Helpers::pluckGroupFavorites($group_id, $site_id, $favorites);
return $favorites;
}
/**
* Get Session Favorites
*/
private function getSessionFavorites($site_id = null, $group_id = null)
{
if ( !isset($_SESSION['simplefavorites']) ) $_SESSION['simplefavorites'] = [];
$favorites = $_SESSION['simplefavorites'];
$favorites = $this->favoritesWithSiteID($favorites);
$favorites = $this->favoritesWithGroups($favorites);
if ( !is_null($site_id) && is_null($group_id) ) $favorites = Helpers::pluckSiteFavorites($site_id, $favorites);
if ( !is_null($group_id) ) $favorites = Helpers::pluckGroupFavorites($group_id, $site_id, $favorites);
return $favorites;
}
/**
* Get Cookie Favorites
*/
private function getCookieFavorites($site_id = null, $group_id = null)
{
if ( !isset($_COOKIE['simplefavorites']) ) $_COOKIE['simplefavorites'] = json_encode([]);
$favorites = json_decode(stripslashes($_COOKIE['simplefavorites']), true);
$favorites = $this->favoritesWithSiteID($favorites);
$favorites = $this->favoritesWithGroups($favorites);
if ( isset($_POST['user_consent_accepted']) && $_POST['user_consent_accepted'] == 'true' ) $favorites[0]['consent_provided'] = time();
if ( !is_null($site_id) && is_null($group_id) ) $favorites = Helpers::pluckSiteFavorites($site_id, $favorites);
if ( !is_null($group_id) ) $favorites = Helpers::pluckGroupFavorites($group_id, $site_id, $favorites);
return $favorites;
}
/**
* Has the user favorited a specified post?
* @param int $post_id
* @param int $site_id
* @param int $user_id
* @param int $group_id
*/
public function isFavorite($post_id, $site_id = 1, $user_id = null, $group_id = null)
{
$favorites = $this->getFavorites($user_id, $site_id, $group_id);
if ( in_array($post_id, $favorites) ) return true;
return false;
}
/**
* Does the user count in total favorites?
* @return boolean
*/
public function countsInTotal()
{
if ( is_user_logged_in() ) return true;
return $this->settings_repo->anonymous('save');
}
/**
* Format an array of favorites
* @param $post_id - int, post to add to array (for session/cookie favorites)
* @param $site_id - int, site id for post_id
*/
public function formattedFavorites($post_id = null, $site_id = null, $status = null)
{
$favorites = $this->getAllFavorites();
$formatter = new FavoritesArrayFormatter;
return $formatter->format($favorites, $post_id, $site_id, $status);
}
/**
* Has the user consented to cookies (if applicable)
*/
public function consentedToCookies()
{
if ( $this->settings_repo->saveType() !== 'cookie' ) return true;
if ( isset($_POST['user_consent_accepted']) && $_POST['user_consent_accepted'] == 'true' ) return true;
if ( !$this->settings_repo->consent('require') ) return true;
if ( isset($_COOKIE['simplefavorites']) ){
$cookie = json_decode(stripslashes($_COOKIE['simplefavorites']), true);
if ( isset($cookie[0]['consent_provided']) ) return true;
if ( isset($cookie[0]['consent_denied']) ) return false;
}
return false;
}
/**
* Has the user denied consent to cookies explicitly
*/
public function deniedCookies()
{
if ( $this->settings_repo->saveType() !== 'cookie' ) return false;
if ( !$this->settings_repo->consent('require') ) return false;
if ( isset($_COOKIE['simplefavorites']) ){
$cookie = json_decode(stripslashes($_COOKIE['simplefavorites']), true);
if ( isset($cookie[0]['consent_denied']) ) return true;
}
return false;
}
}
\ No newline at end of file
<?php
namespace Favorites\Events;
use Favorites\Listeners\FavoriteButton;
use Favorites\Listeners\FavoritesArray;
use Favorites\Listeners\ClearFavorites;
use Favorites\Listeners\FavoriteCount;
use Favorites\Listeners\FavoriteList;
use Favorites\Listeners\CookieConsent;
class RegisterPublicEvents
{
public function __construct()
{
// Front End Favorite Button
add_action( 'wp_ajax_nopriv_favorites_favorite', [$this, 'favoriteButton']);
add_action( 'wp_ajax_favorites_favorite', [$this, 'favoriteButton']);
// User's Favorited Posts (array of IDs)
add_action( 'wp_ajax_nopriv_favorites_array', [$this, 'favoritesArray']);
add_action( 'wp_ajax_favorites_array', [$this, 'favoritesArray']);
// Clear Favorites
add_action( 'wp_ajax_nopriv_favorites_clear', [$this, 'clearFavorites']);
add_action( 'wp_ajax_favorites_clear', [$this, 'clearFavorites']);
// Total Favorite Count
add_action( 'wp_ajax_nopriv_favorites_totalcount', [$this, 'favoriteCount']);
add_action( 'wp_ajax_favorites_totalcount', [$this, 'favoriteCount']);
// Single Favorite List
add_action( 'wp_ajax_nopriv_favorites_list', [$this, 'favoriteList']);
add_action( 'wp_ajax_favorites_list', [$this, 'favoriteList']);
// Accept/Deny Cookies
add_action( 'wp_ajax_nopriv_favorites_cookie_consent', [$this, 'cookiesConsented']);
add_action( 'wp_ajax_favorites_cookie_consent', [$this, 'cookiesConsented']);
}
/**
* Favorite Button
*/
public function favoriteButton()
{
new FavoriteButton;
}
/**
* Generate a Nonce
*/
public function nonce()
{
new NonceHandler;
}
/**
* Get an array of current user's favorites
*/
public function favoritesArray()
{
new FavoritesArray;
}
/**
* Clear all Favorites
*/
public function clearFavorites()
{
new ClearFavorites;
}
/**
* Favorite Count for a single post
*/
public function favoriteCount()
{
new FavoriteCount;
}
/**
* Single Favorite List for a Specific User
*/
public function favoriteList()
{
new FavoriteList;
}
/**
* Cookies were either accepted or denied
*/
public function cookiesConsented()
{
new CookieConsent;
}
}
\ No newline at end of file
<?php
/**
* Static Wrapper for Bootstrap Class
* Prevents T_STRING error when checking for 5.3.2
*/
class Favorites
{
public static function init()
{
// dev/live
global $favorites_env;
$favorites_env = 'live';
global $favorites_version;
$favorites_version = '2.3.2';
global $favorites_name;
$favorites_name = __('Favorites', 'favorites');
$app = new Favorites\Bootstrap;
}
}
\ No newline at end of file
<?php
namespace Favorites;
/**
* Static Helper Methods
*/
class Helpers
{
/**
* Plugin Root Directory
*/
public static function plugin_url()
{
return plugins_url() . '/' . dirname( plugin_basename( FAVORITES_PLUGIN_FILE ) );
}
/**
* Views
*/
public static function view($file)
{
return dirname(__FILE__) . '/Views/' . $file . '.php';
}
/**
* Plugin Version
*/
public static function version()
{
global $favorites_version;
return $favorites_version;
}
/**
* Get File Contents
*/
public static function getFileContents($file)
{
return file_get_contents( dirname( dirname(__FILE__) ) . '/' . $file);
}
/**
* Multidemensional array key search
* @since 1.1
* @return boolean
*/
public static function keyExists($needle, $haystack)
{
if ( array_key_exists($needle, $haystack) || in_array($needle, $haystack) ){
return true;
} else {
$return = false;
foreach ( array_values($haystack) as $value ){
if ( is_array($value) && !$return ) $return = self::keyExists($needle, $value);
}
return $return;
}
}
/**
* Site ID Exists
* checks if site id is in favorites array yet
* @since 1.1
* @return boolean
*/
public static function siteExists($site_id, $meta)
{
foreach ( $meta as $key => $site ){
if ( $site['site_id'] == $site_id ) return true;
}
return false;
}
/**
* Groups Exists
* checks if groups array is in favorites array yet
* @since 2.2
* @return boolean
*/
public static function groupsExist($site_favorites)
{
if ( isset($site_favorites['groups']) && !empty($site_favorites['groups']) ) return true;
return false;
}
/**
* Pluck the site favorites from saved meta array
* @since 1.1
* @param int $site_id
* @param array $favorites (user meta)
* @return array
*/
public static function pluckSiteFavorites($site_id, $all_favorites)
{
foreach($all_favorites as $site_favorites){
if ( $site_favorites['site_id'] == $site_id && isset($site_favorites['posts']) ) return $site_favorites['posts'];
}
return array();
}
/**
* Pluck the site favorites from saved meta array
* @since 1.1
* @param int $site_id
* @param array $favorites (user meta)
* @return array
*/
public static function pluckGroupFavorites($group_id, $site_id, $all_favorites)
{
foreach($all_favorites as $key => $site_favorites){
if ( $site_favorites['site_id'] !== $site_id ) continue;
foreach ( $all_favorites[$key]['groups'] as $group ){
if ( $group['group_id'] == $group_id ){
return $group['posts'];
}
}
}
return array();
}
}
\ No newline at end of file
<?php
namespace Favorites\Listeners;
use Favorites\Config\SettingsRepository;
use Favorites\Entities\User\UserRepository;
/**
* Base AJAX class
*/
abstract class AJAXListenerBase
{
/**
* Form Data
*/
protected $data;
/**
* Settings Repo
*/
protected $settings_repo;
/**
* User Repo
*/
protected $user_repo;
public function __construct($check_nonce = true)
{
$this->settings_repo = new SettingsRepository;
$this->user_repo = new UserRepository;
$this->checkLogIn();
$this->checkConsent();
}
/**
* Send an Error Response
* @param $error string
*/
protected function sendError($error = null)
{
$error = ( $error ) ? $error : __('There was an error processing the request.', 'favorites');
return wp_send_json([
'status' => 'error',
'message' => $error
]);
}
/**
* Check if logged in
*/
protected function checkLogIn()
{
if ( is_user_logged_in() ) return true;
if ( $this->settings_repo->anonymous('display') ) return true;
if ( $this->settings_repo->requireLogin() ) return $this->response(['status' => 'unauthenticated']);
if ( $this->settings_repo->redirectAnonymous() ) return $this->response(['status' => 'unauthenticated']);
}
/**
* Check if consent is required and received
*/
protected function checkConsent()
{
if ( $this->user_repo->consentedToCookies() ) return;
return $this->response([
'status' => 'consent_required',
'message' => $this->settings_repo->consent('modal'),
'accept_text' => $this->settings_repo->consent('consent_button_text'),
'deny_text' => $this->settings_repo->consent('deny_button_text'),
'post_data' => $_POST
]);
}
/**
* Send a response
*/
protected function response($response)
{
return wp_send_json($response);
}
}
\ No newline at end of file
<?php
namespace Favorites\Listeners;
use Favorites\Entities\Favorite\Favorite;
use Favorites\Entities\Favorite\SyncAllFavorites;
use Favorites\Entities\Post\SyncFavoriteCount;
class ClearFavorites extends AJAXListenerBase
{
/**
* Favorites Sync
*/
private $favorites_sync;
public function __construct()
{
parent::__construct();
$this->favorites_sync = new SyncAllFavorites;
$this->setFormData();
$this->clearFavorites();
$this->sendResponse();
}
/**
* Set Form Data
*/
private function setFormData()
{
$this->data['siteid'] = intval(sanitize_text_field($_POST['siteid']));
$this->data['old_favorites'] = $this->user_repo->formattedFavorites();
}
/**
* Remove all user's favorites from the specified site
*/
private function clearFavorites()
{
$user = ( is_user_logged_in() ) ? get_current_user_id() : null;
do_action('favorites_before_clear', $this->data['siteid'], $user);
$favorites = $this->user_repo->getAllFavorites();
foreach($favorites as $key => $site_favorites){
if ( $site_favorites['site_id'] == $this->data['siteid'] ) {
$this->updateFavoriteCounts($site_favorites);
unset($favorites[$key]);
}
}
$this->favorites_sync->sync($favorites);
do_action('favorites_after_clear', $this->data['siteid'], $user);
}
/**
* Update all the cleared post favorite counts
*/
private function updateFavoriteCounts($site_favorites)
{
foreach($site_favorites['posts'] as $favorite){
$count_sync = new SyncFavoriteCount($favorite, 'inactive', $this->data['siteid']);
$count_sync->sync();
}
}
/**
* Set and send the response
*/
private function sendResponse()
{
$favorites = $this->user_repo->formattedFavorites();
$this->response([
'status' => 'success',
'old_favorites' => $this->data['old_favorites'],
'favorites' => $favorites
]);
}
}
\ No newline at end of file
<?php
namespace Favorites\Listeners;
use Favorites\Entities\User\UserRepository;
class CookieConsent
{
/**
* Consented?
* @var bool
*/
private $consent;
/**
* User Repo
*/
private $user_repo;
public function __construct()
{
$this->user_repo = new UserRepository;
$this->setConsent();
$this->respond();
}
private function setConsent()
{
$this->consent = ( isset($_POST['consent']) && $_POST['consent'] == 'true' ) ? true : false;
if ( $this->consent ){
$this->setApprove();
return;
}
$this->setDeny();
}
private function setApprove()
{
$cookie = [];
if ( isset($_COOKIE['simplefavorites']) ) {
$cookie = json_decode(stripslashes($_COOKIE['simplefavorites']), true);
} else {
$cookie = $this->user_repo->getAllFavorites();
}
$cookie[0]['consent_provided'] = time();
setcookie( 'simplefavorites', json_encode( $cookie ), time() + apply_filters( 'simplefavorites_cookie_expiration_interval', 31556926 ), '/' );
}
private function setDeny()
{
$cookie = [];
$cookie[0]['consent_denied'] = time();
setcookie( 'simplefavorites', json_encode( $cookie ), time() + apply_filters( 'simplefavorites_cookie_expiration_interval', 31556926 ), '/' );
}
private function respond()
{
wp_send_json([
'status' => 'success',
'consent' => $this->consent
]);
}
}
\ No newline at end of file
<?php
namespace Favorites\Listeners;
use Favorites\Entities\Favorite\Favorite;
class FavoriteButton extends AJAXListenerBase
{
public function __construct()
{
parent::__construct();
$this->setFormData();
$this->updateFavorite();
}
/**
* Set Form Data
*/
private function setFormData()
{
$this->data['postid'] = intval(sanitize_text_field($_POST['postid']));
$this->data['siteid'] = intval(sanitize_text_field($_POST['siteid']));
$this->data['status'] = ( $_POST['status'] == 'active') ? 'active' : 'inactive';
$this->data['groupid'] = ( isset($_POST['groupid']) && $_POST['groupid'] !== '' ) ? intval($_POST['groupid']) : 1;
}
/**
* Update the Favorite
*/
private function updateFavorite()
{
try {
$this->beforeUpdateAction();
if ( !$this->validates() ) throw new \Exception(__('Invalid post.', 'favorites'));
$favorite = new Favorite;
$favorite->update($this->data['postid'], $this->data['status'], $this->data['siteid'], $this->data['groupid']);
$this->afterUpdateAction();
$this->response([
'status' => 'success',
'favorite_data' => [
'id' => $this->data['postid'],
'siteid' => $this->data['siteid'],
'status' => $this->data['status'],
'groupid' => $this->data['groupid'],
'save_type' => $favorite->saveType()
],
'favorites' => $this->user_repo->formattedFavorites($this->data['postid'], $this->data['siteid'], $this->data['status'])
]);
} catch ( \Exception $e ){
return $this->sendError($e->getMessage());
}
}
/**
* Before Update Action
* Provides hook for performing actions before a favorite
*/
private function beforeUpdateAction()
{
$user = ( is_user_logged_in() ) ? get_current_user_id() : null;
do_action('favorites_before_favorite', $this->data['postid'], $this->data['status'], $this->data['siteid'], $user);
}
/**
* After Update Action
* Provides hook for performing actions after a favorite
*/
private function afterUpdateAction()
{
$user = ( is_user_logged_in() ) ? get_current_user_id() : null;
do_action('favorites_after_favorite', $this->data['postid'], $this->data['status'], $this->data['siteid'], $user);
}
/**
* Validate the Favorite
*/
private function validates()
{
$post_type = get_post_type($this->data['postid']);
$enabled = $this->settings_repo->displayInPostType($post_type);
$post_type_object = get_post_type_object(get_post_type($this->data['postid']));
if ( !$post_type_object ) return false;
if ( !$post_type_object->public || !$enabled ) return false;
return true;
}
}
\ No newline at end of file
<?php
namespace Favorites\Listeners;
use Favorites\Entities\Post\FavoriteCount as FavoriteCounter;
/**
* Return the total number of favorites for a specified post
*/
class FavoriteCount extends AJAXListenerBase
{
/**
* Favorite Counter
*/
private $favorite_counter;
public function __construct()
{
parent::__construct();
$this->favorite_counter = new FavoriteCounter;
$this->setData();
$this->sendCount();
}
private function setData()
{
$this->data['postid'] = ( isset($_POST['postid']) ) ? intval($_POST['postid']) : null;
$this->data['siteid'] = ( isset($_POST['siteid']) ) ? intval($_POST['siteid']) : null;
}
private function sendCount()
{
$this->response([
'status' => 'success',
'count' => $this->favorite_counter->getCount($this->data['postid'], $this->data['siteid'])
]);
}
}
\ No newline at end of file
<?php
namespace Favorites\Listeners;
use Favorites\Entities\User\UserFavorites;
class FavoriteList extends AJAXListenerBase
{
/**
* Form Data
* @var array
*/
protected $data;
/**
* List HTML
*/
private $list;
public function __construct()
{
parent::__construct();
$this->setData();
$this->getList();
wp_send_json(['status' => 'success', 'list' => $this->list, 'data' => $this->data]);
}
/**
* Set the User ID & Site ID
*/
private function setData()
{
$this->data['user_id'] = ( isset($_POST['userid']) ) ? intval($_POST['userid']) : null;
$this->data['site_id'] = ( isset($_POST['siteid']) ) ? intval($_POST['siteid']) : null;
$this->data['include_links'] = ( isset($_POST['include_links']) && $_POST['include_links'] == 'true' ) ? true : false;
$this->data['include_buttons'] = ( isset($_POST['include_buttons']) && $_POST['include_buttons'] == 'true' ) ? true : false;
$this->data['include_thumbnails'] = ( isset($_POST['include_thumbnails']) && $_POST['include_thumbnails'] == 'true' ) ? true : false;
$this->data['thumbnail_size'] = ( isset($_POST['thumbnail_size']) && $_POST['thumbnail_size'] != '' ) ? sanitize_text_field($_POST['thumbnail_size']) : 'thumbnail';
$this->data['include_excerpt'] = ( isset($_POST['include_excerpt']) && $_POST['include_excerpt'] == 'true' ) ? true : false;
$this->data['no_favorites'] = ( isset($_POST['no_favorites']) ) ? sanitize_text_field($_POST['no_favorites']) : '';
$this->data['post_types'] = ( isset($_POST['post_types']) ) ? explode(',', $_POST['post_types']) : array();
}
/**
* Get the favorites list
*/
private function getList()
{
global $blog_id;
$site_id = ( is_multisite() && is_null($site_id) ) ? $blog_id : $site_id;
if ( !is_multisite() ) $site_id = 1;
$filters = ( !empty($this->data['post_types']) ) ? ['post_type' => $this->data['post_types']] : null;
$favorites = new UserFavorites(
$this->data['user_id'],
$this->data['site_id'],
$this->data['include_links'],
$filters
);
$this->list = $favorites->getFavoritesList(
$include_button = $this->data['include_buttons'],
$this->data['include_thumbnails'],
$this->data['thumbnail_size'],
$this->data['include_excerpt'],
$this->data['no_favorites']
);
}
}
\ No newline at end of file
<?php
namespace Favorites\Listeners;
/**
* Return an array of user's favorited posts
*/
class FavoritesArray extends AJAXListenerBase
{
/**
* User Favorites
* @var array
*/
private $favorites;
public function __construct()
{
parent::__construct(false);
$this->setFavorites();
$this->response(['status'=>'success', 'favorites' => $this->favorites]);
}
/**
* Get the Favorites
*/
private function setFavorites()
{
$favorites = $this->user_repo->formattedFavorites();
$this->favorites = $favorites;
}
}
\ No newline at end of file
<?php settings_fields( 'simple-favorites-general' ); ?>
<h3><?php _e('Page Cache', 'favorites'); ?></h3>
<div class="simple-favorites-post-types">
<div class="post-type-row">
<div class="post-type-checkbox">
<input type="checkbox" name="simplefavorites_cache_enabled" value="true" <?php if ( $this->settings_repo->cacheEnabled() ) echo 'checked'; ?> />
</div>
<div class="post-type-name">
<?php _e('Cache Enabled on Site (Favorites content is injected on page load with AJAX request)', 'favorites'); ?>
</div>
</div><!-- .post-type-row -->
</div><!-- .simple-favorites-post-types -->
<h3><?php _e('Development Mode', 'favorites'); ?></h3>
<div class="simple-favorites-post-types">
<div class="post-type-row">
<div class="post-type-checkbox">
<input type="checkbox" name="simplefavorites_dev_mode" value="true" <?php if ( $this->settings_repo->devMode() ) echo 'checked'; ?> />
</div>
<div class="post-type-name">
<?php _e('Enable Development Mode (logs JS responses in the console for debugging)'); ?>
</div>
</div><!-- .post-type-row -->
</div><!-- .simple-favorites-post-types -->
<h3><?php _e('Dependencies', 'favorites'); ?></h3>
<div class="simple-favorites-display-settings">
<div class="row">
<div class="description">
<h5><?php _e('Enqueue Plugin CSS', 'favorites'); ?></h5>
</div>
<div class="field">
<label class="block"><input type="checkbox" name="simplefavorites_dependencies[css]" value="true" data-favorites-dependency-checkbox <?php if ( $this->settings_repo->outputDependency('css') ) echo 'checked'; ?> /><?php _e('Output Plugin CSS', 'favorites'); ?>
</label>
<div class="simplefavorites-dependency-content" data-favorites-dependency-content>
<p><em><?php _e('If you are compiling your own minified CSS, include the CSS below:', 'favorites'); ?></em></p>
<textarea><?php echo Favorites\Helpers::getFileContents('assets/css/styles-uncompressed.css'); ?></textarea>
</div>
</div>
</div><!-- .row -->
<div class="row">
<div class="description">
<h5><?php _e('Enqueue Plugin Javascript', 'favorites'); ?></h5>
<p><?php _e('Important: The plugin JavaScript is required for core functions. If this is disabled, the plugin JS <strong>must</strong> be included with the theme along with the global JS variables.', 'favorites'); ?></p>
</div>
<div class="field">
<label class="block">
<input type="checkbox" name="simplefavorites_dependencies[js]" value="true" data-favorites-dependency-checkbox <?php if ( $this->settings_repo->outputDependency('js') ) echo 'checked'; ?> /><?php _e('Output Plugin JavaScript', 'favorites'); ?>
</label>
<div class="simplefavorites-dependency-content" data-favorites-dependency-content>
<p><em><?php _e('If you are compiling your own minified Javascript, include the below (required for plugin functionality):', 'favorites'); ?></em></p>
<textarea><?php echo Favorites\Helpers::getFileContents('assets/js/favorites.js'); ?></textarea>
</div>
</div>
</div><!-- .row -->
</div><!-- .favorites-display-settings -->
<div class="favorites-alert">
<p><strong><?php _e('Favorites Version', 'favorites'); ?>:</strong> <?php echo Favorites\Helpers::version(); ?></p>
</div>
\ No newline at end of file
<?php settings_fields( 'simple-favorites-users' ); ?>
<h3><?php _e('User Settings', 'favorites'); ?></h3>
<div class="simple-favorites-display-settings">
<div class="row">
<div class="description">
<h5><?php _e('Anonymous Users', 'favorites'); ?></h5>
<p><?php _e('Enable favoriting functionality for unauthenticated users.', 'favorites'); ?></p>
</div>
<div class="field">
<label class="block"><input type="checkbox" name="simplefavorites_users[anonymous][display]" value="true" <?php if ( $this->settings_repo->anonymous('display') ) echo ' checked'; ?> data-favorites-anonymous-checkbox /><?php _e('Enable Anonymous Users', 'favorites'); ?>
</label>
<label class="block" data-favorites-anonymous-count><input type="checkbox" name="simplefavorites_users[anonymous][save]" value="true" <?php if ( $this->settings_repo->anonymous('save') ) echo ' checked'; ?> /><?php _e('Include in Post Favorite Count', 'favorites'); ?>
</label>
</div>
</div><!-- .row -->
<div class="row">
<div class="description">
<h5><?php _e('User Cookie Consent', 'favorites'); ?></h5>
<p><?php _e('Require user consent for saving cookies before allowing favorites to be saved.', 'favorites'); ?></p><p><strong><?php _e('Important:', 'favorites'); ?></strong> <?php _e('If using this option for GDPR compliance, please consult an attorney for appropriate legal terms to display in the modal consent.', 'favorites'); ?></p>
</div>
<div class="field">
<label class="block"><input type="checkbox" name="simplefavorites_users[consent][require]" value="true" <?php if ( $this->settings_repo->consent('require') ) echo ' checked'; ?> data-favorites-require-consent-checkbox /><?php _e('Require User Consent', 'favorites'); ?>
</label>
<div class="require-consent-modal-content" data-favorites-require-consent-modal-content>
<h3><?php _e('Content to Display in Modal Agreement', 'favorites'); ?></h3>
<?php
wp_editor($this->settings_repo->consent('modal'), 'simplefavorites_users_authentication_modal',
array(
'textarea_name' => 'simplefavorites_users[consent][modal]',
'tabindex' => 1,
'wpautop' => true
)
);
?>
<p>
<label class="block"><?php _e('Consent Button Text', 'favorites'); ?></label>
<input type="text" name="simplefavorites_users[consent][consent_button_text]" value="<?php echo $this->settings_repo->consent('consent_button_text'); ?>" />
</p>
<p>
<label class="block"><?php _e('Deny Button Text', 'favorites'); ?></label>
<input type="text" name="simplefavorites_users[consent][deny_button_text]" value="<?php echo $this->settings_repo->consent('deny_button_text'); ?>" />
</p>
</div>
</div>
</div><!-- .row -->
<div class="row" data-favorites-require-login>
<div class="description">
<h5><?php _e('Anonymous Favoriting Behavior', 'favorites'); ?></h5>
<p><?php _e('By default, favorite buttons are hidden from unauthenticated users if anonymous users are disabled.', 'favorites'); ?></p>
</div>
<div class="field">
<label class="block"><input type="checkbox" name="simplefavorites_users[require_login]" value="true" <?php if ( $this->settings_repo->requireLogin() ) echo ' checked'; ?> data-favorites-require-login-checkbox data-favorites-anonymous-settings="modal" /><?php _e('Show Buttons and Display Modal for Anonymous Users', 'favorites'); ?>
</label>
<label class="block"><input type="checkbox" name="simplefavorites_users[redirect_anonymous]" value="true" <?php if ( $this->settings_repo->redirectAnonymous() ) echo ' checked'; ?> data-favorites-redirect-anonymous-checkbox data-favorites-anonymous-settings="redirect" /><?php _e('Redirect Anonymous Users to a Page', 'favorites'); ?>
</label>
<div class="authentication-modal-content" data-favorites-authentication-modal-content>
<h3><?php _e('Edit the Modal Content Below', 'favorites'); ?></h3>
<p><strong><?php _e('Important: ', 'favorites'); ?></strong> <?php _e('If plugin css or javascript has been disabled, the modal window will not display correctly.', 'favorites'); ?></p>
<p><?php _e('To add "close" button or link, give it a data attribute of "data-favorites-modal-close".', 'favorites'); ?></p>
<?php
wp_editor($this->settings_repo->authenticationModalContent(true), 'simplefavorites_users_authentication_modal',
array(
'textarea_name' => 'simplefavorites_users[authentication_modal]',
'tabindex' => 1,
'wpautop' => true
)
);
?>
</div>
<div class="anonymous-redirect-content" data-favorites-anonymous-redirect-content>
<label><?php _e('Enter the Page/Post ID to redirect to (defaults to the site url)', 'sscblog'); ?></label>
<input type="text" name="simplefavorites_users[anonymous_redirect_id]" value="<?php echo $this->settings_repo->redirectAnonymousId(); ?>" />
</div>
</div>
</div><!-- .row -->
<div class="row">
<div class="description">
<h5><?php _e('Save Unauthenticated Favorites as', 'favorites'); ?></h5>
<p><?php _e('Unauthenticated users\' favorites may be saved in either cookies or session. Authenticated users\' favorites are saved as user meta.', 'favorites'); ?></p>
</div>
<div class="field">
<label class="block"><input type="radio" name="simplefavorites_users[anonymous][saveas]" value="cookie" <?php if ( $this->settings_repo->saveType() == 'cookie' ) echo 'checked'; ?>/><?php _e('Cookie', 'favorites'); ?>
</label>
<label>
<input type="radio" name="simplefavorites_users[anonymous][saveas]" value="session" <?php if ( $this->settings_repo->saveType() == 'session' ) echo 'checked'; ?>/><?php _e('Session', 'favorites'); ?>
</label>
</div>
</div><!-- .row -->
</div><!-- .favorites-display-settings -->
\ No newline at end of file
<div class="wrap">
<h1><?php echo $this->plugin_name . ' '; _e('Settings', 'favorites'); ?></h1>
<h2 class="nav-tab-wrapper">
<a class="nav-tab <?php if ( $tab == 'general' ) echo 'nav-tab-active'; ?>" href="options-general.php?page=simple-favorites">
<?php _e('General', 'favorites'); ?>
</a>
<a class="nav-tab <?php if ( $tab == 'users' ) echo 'nav-tab-active'; ?>" href="options-general.php?page=simple-favorites&tab=users">
<?php _e('Users', 'favorites'); ?>
</a>
<a class="nav-tab <?php if ( $tab == 'display' ) echo 'nav-tab-active'; ?>" href="options-general.php?page=simple-favorites&tab=display">
<?php _e('Display & Post Types', 'favorites'); ?>
</a>
</h2>
<form method="post" enctype="multipart/form-data" action="options.php">
<?php include(Favorites\Helpers::view('settings/settings-' . $tab)); ?>
<?php submit_button(); ?>
</form>
</div><!-- .wrap -->
\ No newline at end of file
.simplefavorite-button.active{opacity:.7}.simplefavorite-button.has-count{position:relative}.simplefavorite-button.preset{display:inline-block;-webkit-appearance:none;-moz-appearance:none;appearance:none;border:0;background:transparent;background-color:#fff;border:1px solid #ccc;-webkit-box-shadow:0px 0px 2px 0px rgba(0,0,0,0.1),1px 1px 1px 0px rgba(0,0,0,0.1);box-shadow:0px 0px 2px 0px rgba(0,0,0,0.1),1px 1px 1px 0px rgba(0,0,0,0.1);padding:.5em 1em .5em 2em;position:relative;-webkit-border-radius:2px;border-radius:2px;cursor:pointer;-webkit-transition:all 200ms ease;-o-transition:all 200ms ease;transition:all 200ms ease}.simplefavorite-button.preset:active,.simplefavorite-button.preset:focus{outline:none}.simplefavorite-button.preset i{position:absolute;font-size:1.3em;left:.3em}.simplefavorite-button.preset:hover{background-color:#333;border-color:#333;color:#fff;-webkit-transition:all 200ms ease;-o-transition:all 200ms ease;transition:all 200ms ease}.simplefavorite-button.preset.active{background-color:#333;color:#fff;border-color:#333;opacity:1}.simplefavorites-loading{margin-left:8px}.sf-icon-spinner-wrapper{display:inline-block;position:relative;min-width:1em;min-height:1em}.sf-icon-spinner{-webkit-animation:sf_rotate linear 2s infinite;animation:sf_rotate linear 2s infinite;position:absolute;top:.15em;left:0}@-webkit-keyframes sf_rotate{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg);-webkit-transform-origin:center center;transform-origin:center center}50%{-webkit-transform:rotate(180deg);transform:rotate(180deg);-webkit-transform-origin:center center;transform-origin:center center}100%{-webkit-transform:rotate(360deg);transform:rotate(360deg);-webkit-transform-origin:center center;transform-origin:center center}}@keyframes sf_rotate{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg);-webkit-transform-origin:center center;transform-origin:center center}50%{-webkit-transform:rotate(180deg);transform:rotate(180deg);-webkit-transform-origin:center center;transform-origin:center center}100%{-webkit-transform:rotate(360deg);transform:rotate(360deg);-webkit-transform-origin:center center;transform-origin:center center}}.favorites-list{list-style:none}.favorites-list li{zoom:1;border-top:1px solid rgba(0,0,0,0.2);padding:.75em 0;margin:0}.favorites-list li:before,.favorites-list li:after{content:" ";display:table}.favorites-list li:after{clear:both}.favorites-list li img{float:left;margin-right:1em}.simplefavorites-modal-backdrop{position:fixed;width:0;height:0;background-color:rgba(0,0,0,0.85);top:0;left:50%;z-index:998;opacity:0;-webkit-transition:opacity 200ms ease;-o-transition:opacity 200ms ease;transition:opacity 200ms ease}.simplefavorites-modal-backdrop.active{width:100%;height:100%;left:0;opacity:1;-webkit-transition:opacity 200ms ease;-o-transition:opacity 200ms ease;transition:opacity 200ms ease}.simplefavorites-modal-content{z-index:999;position:fixed;top:-200%;left:50%;width:50%;background-color:#fff;-webkit-border-radius:2px;border-radius:2px;-webkit-transform:translateX(-50%);-ms-transform:translateX(-50%);transform:translateX(-50%);-webkit-transition:all 200ms ease;-o-transition:all 200ms ease;transition:all 200ms ease;-webkit-box-shadow:2px 2px 20px 0px rgba(51,51,51,0.5);box-shadow:2px 2px 20px 0px rgba(51,51,51,0.5)}.simplefavorites-modal-content.small{width:400px}.simplefavorites-modal-content.active{top:50px;-webkit-transition:all 200ms ease;-o-transition:all 200ms ease;transition:all 200ms ease}.simplefavorites-modal-content.loading .modal-content-body{display:none}.simplefavorites-modal-content.loading .modal-content-loading{display:block}.simplefavorites-modal-content-body{padding:1em;max-height:300px;overflow:auto;zoom:1}.simplefavorites-modal-content-body:before,.simplefavorites-modal-content-body:after{content:" ";display:table}.simplefavorites-modal-content-body:after{clear:both}.simplefavorites-modal-content-body.no-padding{padding:0}.simplefavorites-modal-content-body.has-footer{padding-bottom:0}.simplefavorites-modal-content-interior{padding:1em;padding-bottom:0}.simplefavorites-modal-content-footer{zoom:1;padding:.7em;-webkit-border-radius:0 0 2px 2px;border-radius:0 0 2px 2px;background-color:rgba(51,51,51,0.1)}.simplefavorites-modal-content-footer:before,.simplefavorites-modal-content-footer:after{content:" ";display:table}.simplefavorites-modal-content-footer:after{clear:both}.simplefavorites-button-consent-deny{float:left;opacity:.7}.simplefavorites-button-consent-accept{float:right}@media (max-width: 767px){.simplefavorites-modal-content{width:90%}.simplefavorites-modal-content.active{top:20px}.simplefavorites-modal-content-body{height:300px;overflow-y:scroll;-webkit-overflow-scrolling:touch;overflow-x:hidden}}@media print{.simplefavorites-modal-backdrop,.simplefavorites-modal-content{display:none}}@font-face{font-family:'favorites';src:url("fonts/favorites.eot")}@font-face{font-family:'favorites';src:url("data:application/x-font-ttf;charset=utf-8;base64,AAEAAAALAIAAAwAwT1MvMg8SBwcAAAC8AAAAYGNtYXClTaJoAAABHAAAAIxnYXNwAAAAEAAAAagAAAAIZ2x5Ztq6v+MAAAGwAAAEVGhlYWQN7PEkAAAGBAAAADZoaGVhB8IDzgAABjwAAAAkaG10eCoAAgwAAAZgAAAANGxvY2EE9AZcAAAGlAAAABxtYXhwABEAdQAABrAAAAAgbmFtZWwpt2EAAAbQAAABnnBvc3QAAwAAAAAIcAAAACAAAwPNAZAABQAAApkCzAAAAI8CmQLMAAAB6wAzAQkAAAAAAAAAAAAAAAAAAAABEAAAAAAAAAAAAAAAAAAAAABAAADqEAPA/8AAQAPAAEAAAAABAAAAAAAAAAAAAAAgAAAAAAADAAAAAwAAABwAAQADAAAAHAADAAEAAAAcAAQAcAAAABgAEAADAAgAAQAg5gHofeia6Nzo5ul76dnqEP/9//8AAAAAACDmAOh96Jro3Ojm6Xvp2eoQ//3//wAB/+MaBBeJF20XLBcjFo8WMhX8AAMAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAPAAEAAAAAAAAAAAACAAA3OQEAAAAAAQAAAAAAAAAAAAIAADc5AQAAAAABAAAAAAAAAAAAAgAANzkBAAAAAAIAIP/2A+ADigARABsAAAEfATMPAR8BLwEPAT8BLwEzNxMDIQUDJQUDLQECADMN1oknDTOJJyaKNw0nidYQQHP+kwEmcAEqASZwASr+kwK9oy1jGi2jYxoaY6MtHWYtAWr+o9r+o9fXAV3XAwAAAAABACD/9gPgA4oACQAAAQ0BEyUFEyUhEwJzAW3+1nD+2v7WcP7aAW1zAi0D1/6j19MBXNcBXQAAAAEAVgAdA6oDKwAbAAAlJy4DNTQ+AjMyFhc+ATMyHgIVFA4CBwIAPlKHXzQkP1UyN2YjImY4MVY/JDRfhlMdOEt/dHE9MVY/JDIoKDIkP1YxPXF2f0sAAAADAFYAAQOqA1UAFQAhADsAAAE+ATU0JiMiBg8BJy4BIyIGFRQWHwEBMjY1NCYjIgYVFBYFHgEVFAYHAQ4BIyImJwEuATURNDYzITIWFwLgDxE+LBYnDyAeDyYXKz8PD7b+wBslJRsbJSUCwwwMDAz+1AweEhIeDP6ADAwxIwEsEh4MAR8PJhcrPw8PICAPDz8rFyYPtgIYJRsbJSUbGyXEDB4SEh4M/tQMDAwMAYAMHhIBLCIyDAwAAgAqACsD1gOBABwAIAAAAQczFRQGBwMOASMhIiY1ETQ2NwEXHgEdAQchMhYBETMRA9YCAgMDggkqG/6AIjQODAEYLgkJKgEOIjT8VKwCAQRSCRAH/tQXHTMjAaoSHgwBGi4JFg0OxDL+CAIA/gAAAAEA1gArAyoDKwAKAAABMhYVESUFETQ2MwLWIjL+1v7WMSMDKzQi/VaAgAKqIjQAAAIAIP/wBAADsAA6AHIAAAEuAScuAScuAScuAQcOAQcOAQcOAQcOARceARceARceARceATc+ATc+ATc+ATc+ATc6ATMyNjU8ATUxBw4BBw4BBw4BJy4BJy4BJy4BJy4BNz4BNz4BNz4BNz4BFx4BFx4BFx4BFx4BBzEcARUUFhcOAQcEAAEVFRQ5JCNULi1hMTFfLC1PISE0ERIQAQEUExM2ISJOKytaLi5ZKSlLHh8xEAkOAwECARslZhEzHx9JKChVKipTJyZFHR0sDw8OAQESEBEuHR5DJSVPJydNJCNAGhspDg0NASEYBQ8LAcAyYy0uUiIjNRISEQEBFRMUNyMiUS0sXi8vXCsrTSAgMhAREAEBFBISNCEgTCkZNBslGwEDAaooRx4eLhAPDwEBEhERMR4eRyYnUSkpUCUlQhwbKw4PDQEBERAQLRwcQSQjSyYBAwEZJAMaMxgAAAEAAP/ZBAADpwAKAAABJQsBDQEDJQUDJQQA/p6env6eAQA8ATwBPDwBAAIzMwFB/r8z+v6gpqYBYPoAAAEAAAAgBAADQAAFAAAJAScHCQEDYP4g4KABgAKAA0D+IOCg/oACgAABAAAAAQAAvj/AY18PPPUACwQAAAAAANVm1k8AAAAA1WbWTwAA/9kEAAOwAAAACAACAAAAAAAAAAEAAAPA/8AAAAQAAAAAAAQAAAEAAAAAAAAAAAAAAAAAAAANBAAAAAAAAAAAAAAAAgAAAAQAACAEAAAgBAAAVgQAAFYEAAAqBAAA1gQAACAEAAAABAAAAAAAAAAACgAUAB4AVgByAJ4A+gEyAUoB+AIWAioAAQAAAA0AcwADAAAAAAACAAAAAAAAAAAAAAAAAAAAAAAAAA4ArgABAAAAAAABAAkAAAABAAAAAAACAAcAcgABAAAAAAADAAkAPAABAAAAAAAEAAkAhwABAAAAAAAFAAsAGwABAAAAAAAGAAkAVwABAAAAAAAKABoAogADAAEECQABABIACQADAAEECQACAA4AeQADAAEECQADABIARQADAAEECQAEABIAkAADAAEECQAFABYAJgADAAEECQAGABIAYAADAAEECQAKADQAvGZhdm9yaXRlcwBmAGEAdgBvAHIAaQB0AGUAc1ZlcnNpb24gMS4wAFYAZQByAHMAaQBvAG4AIAAxAC4AMGZhdm9yaXRlcwBmAGEAdgBvAHIAaQB0AGUAc2Zhdm9yaXRlcwBmAGEAdgBvAHIAaQB0AGUAc1JlZ3VsYXIAUgBlAGcAdQBsAGEAcmZhdm9yaXRlcwBmAGEAdgBvAHIAaQB0AGUAc0ZvbnQgZ2VuZXJhdGVkIGJ5IEljb01vb24uAEYAbwBuAHQAIABnAGUAbgBlAHIAYQB0AGUAZAAgAGIAeQAgAEkAYwBvAE0AbwBvAG4ALgAAAAMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=") format("truetype");font-weight:normal;font-style:normal}[class^="sf-icon-"],[class*=" sf-icon-"]{font-family:'favorites' !important;speak:none;font-style:normal;font-weight:normal;font-variant:normal;text-transform:none;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.sf-icon-spinner:before{content:"\e97b"}.sf-icon-favorite:before{content:"\e9d9"}.sf-icon-checkmark:before{content:"\ea10"}.sf-icon-bookmark:before{content:"\e8e6"}.sf-icon-love:before{content:"\e87d"}.sf-icon-wishlist:before{content:"\e89a"}.sf-icon-like:before{content:"\e8dc"}.sf-icon-star-empty:before{content:"\e600"}.sf-icon-star-full:before{content:"\e601"}
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" >
<svg xmlns="http://www.w3.org/2000/svg">
<metadata>Generated by IcoMoon</metadata>
<defs>
<font id="favorites" horiz-adv-x="1024">
<font-face units-per-em="1024" ascent="960" descent="-64" />
<missing-glyph horiz-adv-x="1024" />
<glyph unicode="&#x20;" horiz-adv-x="512" d="" />
<glyph unicode="&#xe600;" glyph-name="star-empty" d="M512 700.8l51.2-163.2 12.8-44.8h214.4l-137.6-99.2-38.4-25.6 12.8-44.8 51.2-163.2-137.6 99.2-38.4 25.6-38.4-25.6-137.6-99.2 54.4 163.2 12.8 44.8-38.4 28.8-137.6 102.4h214.4l16 44.8 64 156.8zM512 905.6l-115.2-348.8h-364.8l294.4-217.6-112-348.8 297.6 214.4 294.4-214.4-112 348.8 297.6 214.4-364.8 3.2-115.2 348.8z" />
<glyph unicode="&#xe601;" glyph-name="star-full" d="M627.2 556.8l364.8-3.2-297.6-214.4 112-348.8-294.4 214.4-297.6-211.2 112 348.8-294.4 214.4h364.8l115.2 348.8z" />
<glyph unicode="&#xe87d;" glyph-name="love" d="M512 28.667l-62 56c-220 200-364 330-364 492 0 132 102 234 234 234 74 0 146-36 192-90 46 54 118 90 192 90 132 0 234-102 234-234 0-162-144-294-364-494z" />
<glyph unicode="&#xe89a;" glyph-name="wishlist" d="M736 286.667c20 20 32 46 32 76 0 58-48 106-106 106-30 0-56-10-76-30l-32-32-30 32c-20 20-46 30-76 30-58 0-106-48-106-106 0-30 10-56 30-76l182-182zM234 640.667c36 0 64 28 64 64s-28 64-64 64-64-28-64-64 28-64 64-64zM914 444.667c16-16 24-36 24-60s-8-44-24-60l-300-300c-16-16-36-24-60-24s-44 8-60 24l-384 384c-16 16-24 36-24 60v300c0 46 38 84 84 84h300c24 0 44-8 60-24z" />
<glyph unicode="&#xe8dc;" glyph-name="like" d="M982 512.667l-2-4h2v-82c0-12-2-22-6-32l-130-300c-12-30-42-52-78-52h-384c-46 0-86 40-86 86v426c0 24 10 44 26 60l280 282 46-46c12-12 18-26 18-44v-14l-42-196h270c46 0 86-38 86-84zM42 42.667v512h172v-512h-172z" />
<glyph unicode="&#xe8e6;" glyph-name="bookmark" d="M726 810.667c46 0 84-40 84-86v-682l-298 128-298-128v682c0 46 38 86 84 86h428z" />
<glyph unicode="&#xe97b;" glyph-name="spinner" d="M1024 448c-1.278 66.862-15.784 133.516-42.576 194.462-26.704 61-65.462 116.258-113.042 161.92-47.552 45.696-103.944 81.82-164.984 105.652-61.004 23.924-126.596 35.352-191.398 33.966-64.81-1.282-129.332-15.374-188.334-41.356-59.048-25.896-112.542-63.47-156.734-109.576-44.224-46.082-79.16-100.708-102.186-159.798-23.114-59.062-34.128-122.52-32.746-185.27 1.286-62.76 14.964-125.148 40.134-182.206 25.088-57.1 61.476-108.828 106.11-151.548 44.61-42.754 97.472-76.504 154.614-98.72 57.118-22.304 118.446-32.902 179.142-31.526 60.708 1.29 120.962 14.554 176.076 38.914 55.15 24.282 105.116 59.48 146.366 102.644 41.282 43.14 73.844 94.236 95.254 149.43 13.034 33.458 21.88 68.4 26.542 103.798 1.246-0.072 2.498-0.12 3.762-0.12 35.346 0 64 28.652 64 64 0 1.796-0.094 3.572-0.238 5.332h0.238zM922.306 278.052c-23.472-53.202-57.484-101.4-99.178-141.18-41.67-39.81-91-71.186-144.244-91.79-53.228-20.678-110.29-30.452-166.884-29.082-56.604 1.298-112.596 13.736-163.82 36.474-51.25 22.666-97.684 55.49-135.994 95.712-38.338 40.198-68.528 87.764-88.322 139.058-19.87 51.284-29.228 106.214-27.864 160.756 1.302 54.552 13.328 108.412 35.254 157.69 21.858 49.3 53.498 93.97 92.246 130.81 38.73 36.868 84.53 65.87 133.874 84.856 49.338 19.060 102.136 28.006 154.626 26.644 52.5-1.306 104.228-12.918 151.562-34.034 47.352-21.050 90.256-51.502 125.624-88.782 35.396-37.258 63.21-81.294 81.39-128.688 18.248-47.392 26.782-98.058 25.424-148.496h0.238c-0.144-1.76-0.238-3.536-0.238-5.332 0-33.012 24.992-60.174 57.086-63.624-6.224-34.822-16.53-68.818-30.78-100.992z" />
<glyph unicode="&#xe9d9;" glyph-name="favorite" d="M1024 562.95l-353.78 51.408-158.22 320.582-158.216-320.582-353.784-51.408 256-249.538-60.432-352.352 316.432 166.358 316.432-166.358-60.434 352.352 256.002 249.538z" />
<glyph unicode="&#xea10;" glyph-name="checkmark" d="M864 832l-480-480-224 224-160-160 384-384 640 640z" />
</font></defs></svg>
\ No newline at end of file
.simplefavorite-button.active {
opacity: .7;
}
.simplefavorite-button.has-count {
position: relative;
}
.simplefavorite-button.preset {
display: inline-block;
-webkit-appearance: none;
-moz-appearance: none;
appearance: none;
border: 0;
background: transparent;
background-color: #ffffff;
border: 1px solid #cccccc;
-webkit-box-shadow: 0px 0px 2px 0px rgba(0, 0, 0, 0.1), 1px 1px 1px 0px rgba(0, 0, 0, 0.1);
box-shadow: 0px 0px 2px 0px rgba(0, 0, 0, 0.1), 1px 1px 1px 0px rgba(0, 0, 0, 0.1);
padding: .5em 1em .5em 2em;
position: relative;
-webkit-border-radius: 2px;
border-radius: 2px;
cursor: pointer;
-webkit-transition: all 200ms ease;
-o-transition: all 200ms ease;
transition: all 200ms ease;
}
.simplefavorite-button.preset:active, .simplefavorite-button.preset:focus {
outline: none;
}
.simplefavorite-button.preset i {
position: absolute;
font-size: 1.3em;
left: .3em;
}
.simplefavorite-button.preset:hover {
background-color: #333;
border-color: #333;
color: #ffffff;
-webkit-transition: all 200ms ease;
-o-transition: all 200ms ease;
transition: all 200ms ease;
}
.simplefavorite-button.preset.active {
background-color: #333;
color: #ffffff;
border-color: #333;
opacity: 1;
}
.simplefavorites-loading {
margin-left: 8px;
}
.sf-icon-spinner-wrapper {
display: inline-block;
position: relative;
min-width: 1em;
min-height: 1em;
}
.sf-icon-spinner {
-webkit-animation: sf_rotate linear 2s infinite;
animation: sf_rotate linear 2s infinite;
position: absolute;
top: .15em;
left: 0;
}
@-webkit-keyframes sf_rotate {
0% {
-webkit-transform: rotate(0deg);
transform: rotate(0deg);
-webkit-transform-origin: center center;
transform-origin: center center;
}
50% {
-webkit-transform: rotate(180deg);
transform: rotate(180deg);
-webkit-transform-origin: center center;
transform-origin: center center;
}
100% {
-webkit-transform: rotate(360deg);
transform: rotate(360deg);
-webkit-transform-origin: center center;
transform-origin: center center;
}
}
@keyframes sf_rotate {
0% {
-webkit-transform: rotate(0deg);
transform: rotate(0deg);
-webkit-transform-origin: center center;
transform-origin: center center;
}
50% {
-webkit-transform: rotate(180deg);
transform: rotate(180deg);
-webkit-transform-origin: center center;
transform-origin: center center;
}
100% {
-webkit-transform: rotate(360deg);
transform: rotate(360deg);
-webkit-transform-origin: center center;
transform-origin: center center;
}
}
.favorites-list {
list-style: none;
}
.favorites-list li {
zoom: 1;
border-top: 1px solid rgba(0, 0, 0, 0.2);
padding: .75em 0;
margin: 0;
}
.favorites-list li:before, .favorites-list li:after {
content: " ";
/* 1 */
display: table;
/* 2 */
}
.favorites-list li:after {
clear: both;
}
.favorites-list li img {
float: left;
margin-right: 1em;
}
.simplefavorites-modal-backdrop {
position: fixed;
width: 0;
height: 0;
background-color: rgba(0, 0, 0, 0.85);
top: 0;
left: 50%;
z-index: 998;
opacity: 0;
-webkit-transition: opacity 200ms ease;
-o-transition: opacity 200ms ease;
transition: opacity 200ms ease;
}
.simplefavorites-modal-backdrop.active {
width: 100%;
height: 100%;
left: 0;
opacity: 1;
-webkit-transition: opacity 200ms ease;
-o-transition: opacity 200ms ease;
transition: opacity 200ms ease;
}
.simplefavorites-modal-content {
z-index: 999;
position: fixed;
top: -200%;
left: 50%;
width: 50%;
background-color: #ffffff;
-webkit-border-radius: 2px;
border-radius: 2px;
-webkit-transform: translateX(-50%);
-ms-transform: translateX(-50%);
transform: translateX(-50%);
-webkit-transition: all 200ms ease;
-o-transition: all 200ms ease;
transition: all 200ms ease;
-webkit-box-shadow: 2px 2px 20px 0px rgba(51, 51, 51, 0.5);
box-shadow: 2px 2px 20px 0px rgba(51, 51, 51, 0.5);
}
.simplefavorites-modal-content.small {
width: 400px;
}
.simplefavorites-modal-content.active {
top: 50px;
-webkit-transition: all 200ms ease;
-o-transition: all 200ms ease;
transition: all 200ms ease;
}
.simplefavorites-modal-content.loading .modal-content-body {
display: none;
}
.simplefavorites-modal-content.loading .modal-content-loading {
display: block;
}
.simplefavorites-modal-content-body {
padding: 1em;
max-height: 300px;
overflow: auto;
zoom: 1;
}
.simplefavorites-modal-content-body:before, .simplefavorites-modal-content-body:after {
content: " ";
/* 1 */
display: table;
/* 2 */
}
.simplefavorites-modal-content-body:after {
clear: both;
}
.simplefavorites-modal-content-body.no-padding {
padding: 0;
}
.simplefavorites-modal-content-body.has-footer {
padding-bottom: 0;
}
.simplefavorites-modal-content-interior {
padding: 1em;
padding-bottom: 0;
}
.simplefavorites-modal-content-footer {
zoom: 1;
padding: .7em;
-webkit-border-radius: 0 0 2px 2px;
border-radius: 0 0 2px 2px;
background-color: rgba(51, 51, 51, 0.1);
}
.simplefavorites-modal-content-footer:before, .simplefavorites-modal-content-footer:after {
content: " ";
/* 1 */
display: table;
/* 2 */
}
.simplefavorites-modal-content-footer:after {
clear: both;
}
.simplefavorites-button-consent-deny {
float: left;
opacity: .7;
}
.simplefavorites-button-consent-accept {
float: right;
}
@media (max-width: 767px) {
.simplefavorites-modal-content {
width: 90%;
}
.simplefavorites-modal-content.active {
top: 20px;
}
.simplefavorites-modal-content-body {
height: 300px;
overflow-y: scroll;
-webkit-overflow-scrolling: touch;
overflow-x: hidden;
}
}
@media print {
.simplefavorites-modal-backdrop,
.simplefavorites-modal-content {
display: none;
}
}
@font-face {
font-family: 'favorites';
src: url("fonts/favorites.eot");
}
@font-face {
font-family: 'favorites';
src: url("data:application/x-font-ttf;charset=utf-8;base64,AAEAAAALAIAAAwAwT1MvMg8SBwcAAAC8AAAAYGNtYXClTaJoAAABHAAAAIxnYXNwAAAAEAAAAagAAAAIZ2x5Ztq6v+MAAAGwAAAEVGhlYWQN7PEkAAAGBAAAADZoaGVhB8IDzgAABjwAAAAkaG10eCoAAgwAAAZgAAAANGxvY2EE9AZcAAAGlAAAABxtYXhwABEAdQAABrAAAAAgbmFtZWwpt2EAAAbQAAABnnBvc3QAAwAAAAAIcAAAACAAAwPNAZAABQAAApkCzAAAAI8CmQLMAAAB6wAzAQkAAAAAAAAAAAAAAAAAAAABEAAAAAAAAAAAAAAAAAAAAABAAADqEAPA/8AAQAPAAEAAAAABAAAAAAAAAAAAAAAgAAAAAAADAAAAAwAAABwAAQADAAAAHAADAAEAAAAcAAQAcAAAABgAEAADAAgAAQAg5gHofeia6Nzo5ul76dnqEP/9//8AAAAAACDmAOh96Jro3Ojm6Xvp2eoQ//3//wAB/+MaBBeJF20XLBcjFo8WMhX8AAMAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAPAAEAAAAAAAAAAAACAAA3OQEAAAAAAQAAAAAAAAAAAAIAADc5AQAAAAABAAAAAAAAAAAAAgAANzkBAAAAAAIAIP/2A+ADigARABsAAAEfATMPAR8BLwEPAT8BLwEzNxMDIQUDJQUDLQECADMN1oknDTOJJyaKNw0nidYQQHP+kwEmcAEqASZwASr+kwK9oy1jGi2jYxoaY6MtHWYtAWr+o9r+o9fXAV3XAwAAAAABACD/9gPgA4oACQAAAQ0BEyUFEyUhEwJzAW3+1nD+2v7WcP7aAW1zAi0D1/6j19MBXNcBXQAAAAEAVgAdA6oDKwAbAAAlJy4DNTQ+AjMyFhc+ATMyHgIVFA4CBwIAPlKHXzQkP1UyN2YjImY4MVY/JDRfhlMdOEt/dHE9MVY/JDIoKDIkP1YxPXF2f0sAAAADAFYAAQOqA1UAFQAhADsAAAE+ATU0JiMiBg8BJy4BIyIGFRQWHwEBMjY1NCYjIgYVFBYFHgEVFAYHAQ4BIyImJwEuATURNDYzITIWFwLgDxE+LBYnDyAeDyYXKz8PD7b+wBslJRsbJSUCwwwMDAz+1AweEhIeDP6ADAwxIwEsEh4MAR8PJhcrPw8PICAPDz8rFyYPtgIYJRsbJSUbGyXEDB4SEh4M/tQMDAwMAYAMHhIBLCIyDAwAAgAqACsD1gOBABwAIAAAAQczFRQGBwMOASMhIiY1ETQ2NwEXHgEdAQchMhYBETMRA9YCAgMDggkqG/6AIjQODAEYLgkJKgEOIjT8VKwCAQRSCRAH/tQXHTMjAaoSHgwBGi4JFg0OxDL+CAIA/gAAAAEA1gArAyoDKwAKAAABMhYVESUFETQ2MwLWIjL+1v7WMSMDKzQi/VaAgAKqIjQAAAIAIP/wBAADsAA6AHIAAAEuAScuAScuAScuAQcOAQcOAQcOAQcOARceARceARceARceATc+ATc+ATc+ATc+ATc6ATMyNjU8ATUxBw4BBw4BBw4BJy4BJy4BJy4BJy4BNz4BNz4BNz4BNz4BFx4BFx4BFx4BFx4BBzEcARUUFhcOAQcEAAEVFRQ5JCNULi1hMTFfLC1PISE0ERIQAQEUExM2ISJOKytaLi5ZKSlLHh8xEAkOAwECARslZhEzHx9JKChVKipTJyZFHR0sDw8OAQESEBEuHR5DJSVPJydNJCNAGhspDg0NASEYBQ8LAcAyYy0uUiIjNRISEQEBFRMUNyMiUS0sXi8vXCsrTSAgMhAREAEBFBISNCEgTCkZNBslGwEDAaooRx4eLhAPDwEBEhERMR4eRyYnUSkpUCUlQhwbKw4PDQEBERAQLRwcQSQjSyYBAwEZJAMaMxgAAAEAAP/ZBAADpwAKAAABJQsBDQEDJQUDJQQA/p6env6eAQA8ATwBPDwBAAIzMwFB/r8z+v6gpqYBYPoAAAEAAAAgBAADQAAFAAAJAScHCQEDYP4g4KABgAKAA0D+IOCg/oACgAABAAAAAQAAvj/AY18PPPUACwQAAAAAANVm1k8AAAAA1WbWTwAA/9kEAAOwAAAACAACAAAAAAAAAAEAAAPA/8AAAAQAAAAAAAQAAAEAAAAAAAAAAAAAAAAAAAANBAAAAAAAAAAAAAAAAgAAAAQAACAEAAAgBAAAVgQAAFYEAAAqBAAA1gQAACAEAAAABAAAAAAAAAAACgAUAB4AVgByAJ4A+gEyAUoB+AIWAioAAQAAAA0AcwADAAAAAAACAAAAAAAAAAAAAAAAAAAAAAAAAA4ArgABAAAAAAABAAkAAAABAAAAAAACAAcAcgABAAAAAAADAAkAPAABAAAAAAAEAAkAhwABAAAAAAAFAAsAGwABAAAAAAAGAAkAVwABAAAAAAAKABoAogADAAEECQABABIACQADAAEECQACAA4AeQADAAEECQADABIARQADAAEECQAEABIAkAADAAEECQAFABYAJgADAAEECQAGABIAYAADAAEECQAKADQAvGZhdm9yaXRlcwBmAGEAdgBvAHIAaQB0AGUAc1ZlcnNpb24gMS4wAFYAZQByAHMAaQBvAG4AIAAxAC4AMGZhdm9yaXRlcwBmAGEAdgBvAHIAaQB0AGUAc2Zhdm9yaXRlcwBmAGEAdgBvAHIAaQB0AGUAc1JlZ3VsYXIAUgBlAGcAdQBsAGEAcmZhdm9yaXRlcwBmAGEAdgBvAHIAaQB0AGUAc0ZvbnQgZ2VuZXJhdGVkIGJ5IEljb01vb24uAEYAbwBuAHQAIABnAGUAbgBlAHIAYQB0AGUAZAAgAGIAeQAgAEkAYwBvAE0AbwBvAG4ALgAAAAMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=") format("truetype");
font-weight: normal;
font-style: normal;
}
[class^="sf-icon-"], [class*=" sf-icon-"] {
/* use !important to prevent issues with browser extensions that change fonts */
font-family: 'favorites' !important;
speak: none;
font-style: normal;
font-weight: normal;
font-variant: normal;
text-transform: none;
line-height: 1;
/* Better Font Rendering =========== */
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
.sf-icon-spinner:before {
content: "\e97b";
}
.sf-icon-favorite:before {
content: "\e9d9";
}
.sf-icon-checkmark:before {
content: "\ea10";
}
.sf-icon-bookmark:before {
content: "\e8e6";
}
.sf-icon-love:before {
content: "\e87d";
}
.sf-icon-wishlist:before {
content: "\e89a";
}
.sf-icon-like:before {
content: "\e8dc";
}
.sf-icon-star-empty:before {
content: "\e600";
}
.sf-icon-star-full:before {
content: "\e601";
}
{
"name": "kylephillips/favorites",
"description": "Favorites for WordPress",
"keywords": ["wordpress", "plugin", "favorite", "bookmark"],
"homepage": "https://favoriteposts.com",
"license": "GPL",
"authors": [
{
"name": "Kyle Phillips",
"email": "kylephillipsdesign@gmail.com",
"homepage": "https://github.com/kylephillips"
}
],
"type": "wordpress-plugin",
"require": {
"php": ">=5.3.2",
"composer/installers": "v1.0.6"
},
"autoload": {
"psr-4" : {
"Favorites\\" : "app/"
}
}
}
<?php
/*
Plugin Name: Favorites
Plugin URI: http://favoriteposts.com
Description: Simple and flexible favorite buttons for any post type.
Version: 2.3.2
Author: Kyle Phillips
Author URI: https://github.com/kylephillips
Text Domain: favorites
Domain Path: /languages/
License: GPLv2 or later.
Copyright: Kyle Phillips
*/
/* Copyright 2019 Kyle Phillips
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2, as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* Check Wordpress and PHP versions before instantiating plugin
*/
register_activation_hook( __FILE__, 'favorites_check_versions' );
define( 'FAVORITES_PLUGIN_FILE', __FILE__ );
function favorites_check_versions( $wp = '3.9', $php = '5.3.2' ) {
global $wp_version;
if ( version_compare( PHP_VERSION, $php, '<' ) ) $flag = 'PHP';
elseif ( version_compare( $wp_version, $wp, '<' ) ) $flag = 'WordPress';
else return;
$version = 'PHP' == $flag ? $php : $wp;
if (function_exists('deactivate_plugins')){
deactivate_plugins( basename( __FILE__ ) );
}
wp_die('<p>The <strong>Favorites</strong> plugin requires'.$flag.' version '.$version.' or greater.</p>','Plugin Activation Error', array( 'response'=>200, 'back_link'=>TRUE ) );
}
if( !class_exists('Bootstrap') ) :
favorites_check_versions();
require_once(__DIR__ . '/vendor/autoload.php');
require_once(__DIR__ . '/app/Favorites.php');
require_once(__DIR__ . '/app/API/functions.php');
Favorites::init();
endif;
\ No newline at end of file
<?php
//Nothing to see here
\ No newline at end of file
<?php
// autoload.php @generated by Composer
require_once __DIR__ . '/composer' . '/autoload_real.php';
return ComposerAutoloaderInit1fc0bf97587a64ee48e6c213b25ab21b::getLoader();
<?php
// autoload_classmap.php @generated by Composer
$vendorDir = dirname(dirname(__FILE__));
$baseDir = dirname($vendorDir);
return array(
);
<?php
// autoload_namespaces.php @generated by Composer
$vendorDir = dirname(dirname(__FILE__));
$baseDir = dirname($vendorDir);
return array(
'Composer\\Installers\\' => array($vendorDir . '/composer/installers/src'),
);
<?php
// autoload_psr4.php @generated by Composer
$vendorDir = dirname(dirname(__FILE__));
$baseDir = dirname($vendorDir);
return array(
'Favorites\\' => array($baseDir . '/app'),
);
<?php
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit1fc0bf97587a64ee48e6c213b25ab21b
{
private static $loader;
public static function loadClassLoader($class)
{
if ('Composer\Autoload\ClassLoader' === $class) {
require __DIR__ . '/ClassLoader.php';
}
}
public static function getLoader()
{
if (null !== self::$loader) {
return self::$loader;
}
spl_autoload_register(array('ComposerAutoloaderInit1fc0bf97587a64ee48e6c213b25ab21b', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader();
spl_autoload_unregister(array('ComposerAutoloaderInit1fc0bf97587a64ee48e6c213b25ab21b', 'loadClassLoader'));
$map = require __DIR__ . '/autoload_namespaces.php';
foreach ($map as $namespace => $path) {
$loader->set($namespace, $path);
}
$map = require __DIR__ . '/autoload_psr4.php';
foreach ($map as $namespace => $path) {
$loader->setPsr4($namespace, $path);
}
$classMap = require __DIR__ . '/autoload_classmap.php';
if ($classMap) {
$loader->addClassMap($classMap);
}
$loader->register(true);
return $loader;
}
}
function composerRequire1fc0bf97587a64ee48e6c213b25ab21b($file)
{
require $file;
}
[
{
"name": "composer/installers",
"version": "v1.0.6",
"version_normalized": "1.0.6.0",
"source": {
"type": "git",
"url": "https://github.com/composer/installers.git",
"reference": "b3bd071ea114a57212c75aa6a2eef5cfe0cc798f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/composer/installers/zipball/b3bd071ea114a57212c75aa6a2eef5cfe0cc798f",
"reference": "b3bd071ea114a57212c75aa6a2eef5cfe0cc798f",
"shasum": ""
},
"replace": {
"shama/baton": "*"
},
"require-dev": {
"composer/composer": "1.0.*@dev",
"phpunit/phpunit": "3.7.*"
},
"time": "2013-08-20 04:37:09",
"type": "composer-installer",
"extra": {
"class": "Composer\\Installers\\Installer",
"branch-alias": {
"dev-master": "1.0-dev"
}
},
"installation-source": "dist",
"autoload": {
"psr-0": {
"Composer\\Installers\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Kyle Robinson Young",
"email": "kyle@dontkry.com",
"homepage": "https://github.com/shama",
"role": "Developer"
}
],
"description": "A multi-framework Composer library installer",
"homepage": "http://composer.github.com/installers/",
"keywords": [
"TYPO3 CMS",
"TYPO3 Flow",
"TYPO3 Neos",
"agl",
"cakephp",
"codeigniter",
"drupal",
"fuelphp",
"installer",
"joomla",
"kohana",
"laravel",
"li3",
"lithium",
"mako",
"modulework",
"phpbb",
"ppi",
"silverstripe",
"symfony",
"wordpress",
"zend"
]
}
]
; top-most EditorConfig file
root = true
; Unix-style newlines
[*]
end_of_line = LF
[*.php]
indent_style = space
indent_size = 4
language: php
php:
- 5.3
- 5.4
before_script:
- curl -s http://getcomposer.org/installer | php -- --quiet
- php composer.phar install --dev
script: phpunit
Copyright (c) 2012 Kyle Robinson Young
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
\ No newline at end of file
# A Multi-Framework [Composer](http://getcomposer.org) Library Installer
[![Build Status](https://secure.travis-ci.org/composer/installers.png)](http://travis-ci.org/composer/installers)
This is for PHP package authors to require in their `composer.json`. It will
install their package to the correct location based on the specified package
type.
The goal of `installers` is to be a simple package type to install path map.
Users can also customize the install path per package and package authors can
modify the package name upon installing.
`installers` isn't intended on replacing all custom installers. If your
package requires special installation handling then by all means, create a
custom installer to handle it.
**Natively Supported Frameworks**:
The following frameworks natively work with Composer and will be
installed to the default `vendor` directory. `composer/installers`
is not needed to install packages with these frameworks:
* Aura
* Symfony2
* Yii
**Current Supported Package Types**:
> Stable types are marked as **bold**, this means that installation paths
> for those type will not be change. Any adjustment for those types would
> require creation of brand new type that will cover required changes.
| Framework | Types
| --------- | -----
| AGL | `agl-module`
| AnnotateCms | `annotatecms-module`<br>`annotatecms-component`<br>`annotatecms-service`
| CakePHP 2+ | **`cakephp-plugin`**
| CodeIgniter | `codeigniter-library`<br>`codeigniter-third-party`<br>`codeigniter-module`
| Croogo | `croogo-plugin`<br>`croogo-theme`
| Drupal | <b>`drupal-module`<br>`drupal-theme`</b><br>`drupal-profile`<br>`drupal-drush`
| FuelPHP v1.x | `fuel-module`<br>`fuel-package`
| Joomla | `joomla-component`<br>`joomla-module`<br>`joomla-template`<br>`joomla-plugin`<br>`joomla-library`
| Kohana | **`kohana-module`**
| Laravel | `laravel-library`
| Lithium | **`lithium-library`<br>`lithium-source`**
| Magento | `magento-library`<br>`magento-skin`<br>`magento-theme`
| Mako | `mako-package`
| MediaWiki | `mediawiki-extension`
| OXID | `oxid-module`
| MODULEWork | `modulework-module`
| phpBB | `phpbb-extension`<br>`phpbb-style`<br>`phpbb-language`
| PPI | **`ppi-module`**
| SilverStripe | `silverstripe-module`<br>`silverstripe-theme`
| symfony1 | **`symfony1-plugin`**
| TYPO3 Flow | `typo3-flow-package`<br>`typo3-flow-framework`<br>`typo3-flow-plugin`<br>`typo3-flow-site`<br>`typo3-flow-boilerplate`<br>`typo3-flow-build`
| TYPO3 CMS | `typo3-cms-extension`
| WordPress | <b>`wordpress-plugin`<br>`wordpress-theme`</b><br>`wordpress-muplugin`
| Zend | `zend-library`<br>`zend-extra`
## Example `composer.json` File
This is an example for a CakePHP plugin. The only important parts to set in your
composer.json file are `"type": "cakephp-plugin"` which describes what your
package is and `"require": { "composer/installers": "~1.0" }` which tells composer
to load the custom installers.
```json
{
"name": "you/ftp",
"type": "cakephp-plugin",
"require": {
"composer/installers": "~1.0"
}
}
```
This would install your package to the `Plugin/Ftp/` folder of a CakePHP app
when a user runs `php composer.phar install`.
So submit your packages to [packagist.org](http://packagist.org)!
## Custom Install Paths
If you are consuming a package that uses the `composer/installers` you can
override the install path with the following extra in your `composer.json`:
```json
{
"extra": {
"installer-paths": {
"your/custom/path/{$name}/": ["shama/ftp", "vendor/package"]
}
}
}
```
A package type can have a custom installation path with a `type:` prefix.
``` json
{
"extra": {
"installer-paths": {
"your/custom/path/{$name}/": ["type:wordpress-plugin"]
}
}
}
```
This would use your custom path for each of the listed packages. The available
variables to use in your paths are: `{$name}`, `{$vendor}`, `{$type}`.
## Custom Install Names
If you're a package author and need your package to be named differently when
installed consider using the `installer-name` extra.
For example you have a package named `shama/cakephp-ftp` with the type
`cakephp-plugin`. Installing with `composer/installers` would install to the
path `Plugin/CakephpFtp`. Due to the strict naming conventions, you as a
package author actually need the package to be named and installed to
`Plugin/Ftp`. Using the following config within your **package** `composer.json`
will allow this:
```json
{
"name": "shama/cakephp-ftp",
"type": "cakephp-plugin",
"extra": {
"installer-name": "Ftp"
}
}
```
Please note the name entered into `installer-name` will be the final and will
not be inflected.
## Contribute!
* [Fork and clone](https://help.github.com/articles/fork-a-repo).
* Run the command `php composer.phar install --dev` to install the dev
dependencies. See [Composer](https://github.com/composer/composer#installation--usage).
* Use the command `phpunit` to run the tests. See [PHPUnit](http://phpunit.de).
* Create a branch, commit, push and send us a
[pull request](https://help.github.com/articles/using-pull-requests).
To ensure a consistent code base, you should make sure the code follows the
[Coding Standards](http://symfony.com/doc/2.0/contributing/code/standards.html)
which we borrowed from Symfony.
If you would like to help, please take a look at the list of
[issues](https://github.com/composer/installers/issues).
### Should we allow dynamic package types or paths? No.
What are they? The ability for a package author to determine where a package
will be installed either through setting the path directly in their
`composer.json` or through a dynamic package type: `"type":
"framework-install-here"`.
It has been proposed many times. Even implemented once early on and then
removed. `installers` won't do this because it would allow a single package
author to wipe out entire folders without the user's consent. That user would
then come here to yell at us.
{
"name": "composer/installers",
"type": "composer-installer",
"license": "MIT",
"description": "A multi-framework Composer library installer",
"keywords": [
"installer", "cakephp", "laravel", "kohana",
"li3", "lithium", "mako","fuelphp",
"codeigniter", "symfony", "phpbb", "ppi",
"joomla", "wordpress", "drupal", "zend",
"silverstripe", "agl", "TYPO3 Flow", "TYPO3 Neos", "modulework",
"TYPO3 CMS"
],
"homepage": "http://composer.github.com/installers/",
"authors": [
{
"name": "Kyle Robinson Young",
"email": "kyle@dontkry.com",
"homepage": "https://github.com/shama"
}
],
"autoload": {
"psr-0": { "Composer\\Installers\\": "src/" }
},
"extra": {
"class": "Composer\\Installers\\Installer",
"branch-alias": {
"dev-master": "1.0-dev"
}
},
"replace": {
"shama/baton": "*"
},
"require-dev": {
"composer/composer": "1.0.*@dev",
"phpunit/phpunit": "3.7.*"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false"
backupStaticAttributes="false"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false"
bootstrap="tests/bootstrap.php"
>
<testsuites>
<testsuite name="Installers Test Suite">
<directory>tests/Composer/Installers</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory>src/Composer/Installers</directory>
</whitelist>
</filter>
</phpunit>
\ No newline at end of file
<?php
namespace Composer\Installers;
class AglInstaller extends BaseInstaller
{
protected $locations = array(
'module' => 'More/{$name}/',
);
/**
* Format package name to CamelCase
*/
public function inflectPackageVars($vars)
{
$vars['name'] = preg_replace_callback('/(?:^|_|-)(.?)/', function($matches) {
return strtoupper($matches[1]);
}, $vars['name']);
return $vars;
}
}
<?php
namespace Composer\Installers;
class AnnotateCmsInstaller extends BaseInstaller
{
protected $locations = array(
'module' => 'addons/modules/{$name}/',
'component' => 'addons/components/{$name}/',
'service' => 'addons/services/{$name}/',
);
}
\ No newline at end of file
<?php
namespace Composer\Installers;
use Composer\Composer;
use Composer\Package\PackageInterface;
abstract class BaseInstaller
{
protected $locations = array();
protected $composer;
protected $package;
/**
* Initializes base installer.
*
* @param PackageInterface $package
* @param Composer $composer
*/
public function __construct(PackageInterface $package = null, Composer $composer = null)
{
$this->composer = $composer;
$this->package = $package;
}
/**
* Return the install path based on package type.
*
* @param PackageInterface $package
* @param string $frameworkType
* @return string
*/
public function getInstallPath(PackageInterface $package, $frameworkType = '')
{
$type = $this->package->getType();
$prettyName = $this->package->getPrettyName();
if (strpos($prettyName, '/') !== false) {
list($vendor, $name) = explode('/', $prettyName);
} else {
$vendor = '';
$name = $prettyName;
}
$availableVars = $this->inflectPackageVars(compact('name', 'vendor', 'type'));
$extra = $package->getExtra();
if (!empty($extra['installer-name'])) {
$availableVars['name'] = $extra['installer-name'];
}
if ($this->composer->getPackage()) {
$extra = $this->composer->getPackage()->getExtra();
if (!empty($extra['installer-paths'])) {
$customPath = $this->mapCustomInstallPaths($extra['installer-paths'], $prettyName, $type);
if ($customPath !== false) {
return $this->templatePath($customPath, $availableVars);
}
}
}
$packageType = substr($type, strlen($frameworkType) + 1);
if (!isset($this->locations[$packageType])) {
throw new \InvalidArgumentException(sprintf('Package type "%s" is not supported', $type));
}
return $this->templatePath($this->locations[$packageType], $availableVars);
}
/**
* For an installer to override to modify the vars per installer.
*
* @param array $vars
* @return array
*/
public function inflectPackageVars($vars)
{
return $vars;
}
/**
* Gets the installer's locations
*
* @return array
*/
public function getLocations()
{
return $this->locations;
}
/**
* Replace vars in a path
*
* @param string $path
* @param array $vars
* @return string
*/
protected function templatePath($path, array $vars = array())
{
if (strpos($path, '{') !== false) {
extract($vars);
preg_match_all('@\{\$([A-Za-z0-9_]*)\}@i', $path, $matches);
if (!empty($matches[1])) {
foreach ($matches[1] as $var) {
$path = str_replace('{$' . $var . '}', $$var, $path);
}
}
}
return $path;
}
/**
* Search through a passed paths array for a custom install path.
*
* @param array $paths
* @param string $name
* @param string $type
* @return string
*/
protected function mapCustomInstallPaths(array $paths, $name, $type)
{
foreach ($paths as $path => $names) {
if (in_array($name, $names) || in_array('type:' . $type, $names)) {
return $path;
}
}
return false;
}
}
This diff could not be displayed because it is too large.
This diff could not be displayed because it is too large.
This diff could not be displayed because it is too large.
This diff could not be displayed because it is too large.
This diff could not be displayed because it is too large.
This diff could not be displayed because it is too large.