File classes/controllers/UserPanel.php | HJI WP Membership Code Reference

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

<?php
namespace hji\users\controllers;

use \hji\users\entities\User as UserEntity;

/**
 * Class UserPanel
 *
 * @since 1.0
 *
 * @package hji\users\controllers
 */

class UserPanel
{
    /**
     * @var UserEntity - user entity object
     */
    private $user;

    /**
     * @var string Sign Up call to action message
     */
    protected $signUpMessage;

    /**
     * @var string Sign Up/Login action link - triggers sign up/login modal window
     */
    protected $signUpLink;

    /**
     * @var string Logged-in user welcome message
     */
    protected $welcomeMessage;

    /**
     * @var string User Favorites - account link
     */
    protected $favoritesLink;
    protected $favoritesLinkText; // WP Admin bar needs text separately from url

    /**
     * @vars string User Saved Searches - account link
     */
    protected $savedSearchesLink;
    protected $savedSearchesLinkText;  // WP Admin bar needs text separately from url

    /**
     * @var string Logout action link
     */
    protected $logoutLink;


    function __construct(UserEntity $user = null)
    {
        $this->user = $user;

        $this->setUp();
        $this->registerPublicActions();

        if (!current_theme_supports('hji-twitter-bootstrap'))
        {
            // Activate Admin Bar for hji purposes

            add_filter('show_admin_bar', '__return_true');
            add_action('wp_before_admin_bar_render', array($this, 'useWPAdminBar'), 999);
        }
    }


    /**
     * Magic method returns class properties for do_action() hooks.
     *
     * @param      $name
     * @param null $args
     */
    function __call($name, $args = null)
    {
        // check if property exists

        if ($this->$name)
        {
            echo $this->$name;
        }
    }


    /**
     * Sets default values with WP filters for User Panel properties
     */
    protected function setUp()
    {
        // These user panel properties are only available for logged in users
        // Note: keep the condition for logged in user, because rendering
        // these items on the page regardless if user is logged in or not can cause issues
        // like clicking on "Sign Up" link while use is logged in, will actually log user out.

        if ($this->user)
        {
            // Welcome message

            $welcomeMessage = apply_filters('hji_user_panel_welcome_message', 'Welcome back%s!');
            $this->welcomeMessage = $this->user->name ? sprintf($welcomeMessage, ', ' .  $this->user->name) : sprintf($welcomeMessage, '');

            // User Favorites Link

            $this->favoritesLinkText = '<span class="hji-user-favorites">' .
                apply_filters(
                    'hji_user_panel_favorites_link',
                    // Note that round brackets are outside of the span wrapper
                    // because we're using the raw value inside the tag
                    // to make calculation sin JS
                    'Favorite Listings (<span data-type="total-favorites"' .
                    '>' . $this->user->totalFavorites . '</span>)') .
                '</span>';

            $this->favoritesLink = '<a class="hji-user-favorites" ' .
                                    'href="' . site_url() . '/idxuser/' . $this->user->uid . '/">' .
                                    $this->favoritesLinkText .
                                    '</a>';

            // User Saved Searches Link

            $this->savedSearchesLinkText = '<span class="hji-user-saved-searches">' .
                                        apply_filters('hji_user_panel_saved_searches_link',
                                            'Saved Searches (<span data-type="total-saved-searches">' .
                                            $this->user->totalSearches . '</span>)') .
                                        '</span>';

            $this->savedSearchesLink = '<a class="hji-user-saved-searches" ' .
                                        'href="' . site_url() . '/idxuser/' . $this->user->uid . '/searches/' . '">' .
                                        $this->savedSearchesLinkText .
                                        '</a>';

            // Logout Link

            $this->logoutLinkText = '<span class="hji-user-logout">' .
                                apply_filters('hji_user_panel_logout_link', 'Sign Out') .
                                '</span>';

            $this->logoutLink = '<a href="#" class="hji-user-logout">' .
                apply_filters('hji_user_panel_logout_link', 'Sign Out') .
                '</a>';
        }
        else
        {
            // Sign up message

            $signUpMessage = '<i style="font-style: italic;">Start keeping track of listings that you like - no passwords to remember! =></i>';
            // TODO: Deprecated filter 'hji_user_toolbar_calltoaction' - use hji_user_panel_signup_message
            $signUpMessage = apply_filters('hji_user_toolbar_calltoaction', $signUpMessage);
            $this->signUpMessage = apply_filters('hji_user_panel_signup_message', $signUpMessage);

            // Sign up link

            $this->signUpLinkText = '<span class="hji-user-signup">' .
                apply_filters('hji_user_panel_signup_link', 'Sign In') .
                '</span>';

            $this->signUpLink = '<a class="hji-user-signup" href="#">' .
                apply_filters('hji_user_panel_signup_link', 'Sign In') .
                '</a>';
        }
    }


    /**
     * Registers WP Actions accessible via do_action() hook.
     */
    function registerPublicActions()
    {
        add_action('hjiUserGetSignUpMessage',       array($this, 'signUpMessage'));
        add_action('hjiUserGetSignUpLink',          array($this, 'signUpLink'));
        add_action('hjiUserGetWelcomeMessage',      array($this, 'welcomeMessage'));
        add_action('hjiUserGetFavoritesLink',       array($this, 'favoritesLink'));
        add_action('hjiUserGetSavedSearchesLink',   array($this, 'savedSearchesLink'));
        add_action('hjiUserGetLogoutLink',          array($this, 'logoutLink'));
    }


    /**
     * Adds user panel items to the WP-core admin bar:
     *      - welcome message + favorites + saved searches
     *      - login/register or logout
     *
     * wp_before_admin_bar_render hook implementation
     */
    public function useWPAdminBar()
    {
        global $wp_admin_bar;

        $wp_admin_bar->initialize();
        $wp_admin_bar->add_menus();
        $wp_admin_bar->remove_menu('wp-logo');

        if ($this->user)
        {
            $user_group = array(
                'id'     => 'hji-user-group',
                'parent' => 'parent_node',
                'meta'   => array( 'class' => 'hji-user-group' )
            );
            $wp_admin_bar->add_group( $user_group );

            $welcome = array(
                'id'     => 'hji-user-welcome',
                'title'  => $this->welcomeMessage,
            );

            $favorites = array(
                'id'     => 'hji-user-favorites',
                'title'  => $this->favoritesLinkText,
                // TODO: URLs should be retrieved form a URL handling class
                'href'   => site_url() . '/idxuser/' . $this->user->uid . '/',
            );

            $searches = array(
                'id'     => 'hji-user-searches',
                'title'  => $this->savedSearchesLinkText,
                // TODO: URLs should be retrieved form a URL handling class
                'href'   => site_url() . '/idxuser/' . $this->user->uid . '/searches/',
            );

            $logout = array(
                'id'     => 'hji-user-logout',
                'title'  => $this->logoutLinkText,
                'href'   => '#',
                'parent' => 'top-secondary',
            );

            $wp_admin_bar->add_menu($welcome);
            $wp_admin_bar->add_menu($favorites);
            $wp_admin_bar->add_menu($searches);
            $wp_admin_bar->add_node($logout);
        }
        else
        {
            $calltoaction = array(
                'id'     => 'hji-user-calltoaction',
                'title'  => $this->signUpMessage,
            );

            $signin = array(
                'id'     => 'hji-user-login',
                'title'  => $this->signUpLinkText,
                'href'   => '#',
            );

            $wp_admin_bar->add_menu($calltoaction);
            $wp_admin_bar->add_menu($signin);
        }
    }



}

Namespaces

Classes

Interfaces

Functions