File App/App.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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386

<?php
namespace hji\construction;


use hji\construction\core\Component;


class App extends Component
{
    public static $name = 'New Construction';
    public static $slug = 'hji-new-construction';
    public static $textdomain = 'hji-nc';


    function __construct()
    {
        $this->_setDiRules();
    }


    public function run()
    {
        $this->setPaths();

        $this->setupRouting();

        $this->setActionsHooks();

        $this->registerWidgets();
    }


    /**
     * @codeCoverageIgnore
     */
    public function doOnPluginActivation()
    {
        $this->setPaths();
        $router = $this->services()->getRouter();
        $this->setupRouting();
        $router->registerRewriteRules();
        $this->registerPostType();

        flush_rewrite_rules();
    }


    /**
     * Sets APP paths, so they can be accessed throughout the application
     *
     * @codeCoverageIgnore
     */
    protected function setPaths()
    {
        $paths = $this->services()->getPaths();

        $paths->setPath('styles',           'resources/styles');
        $paths->setPath('images',           'resources/images');
        $paths->setPath('scripts',          'resources/scripts/src');
        $paths->setPath('templates',        'App/templates');
        $paths->setPath('templates/twig',   'App/templates/twig');
        $paths->setPath('languages',        'App/languages');
        $paths->setPath('forms',            'resources/forms');
    }


    /**
     * @codeCoverageIgnore
     */
    protected function setActionsHooks()
    {
        add_action('init',                  array($this, 'registerPostType'));
        add_action('init',                  array($this, 'registerSettings'));
        add_action('parse_request',         array($this, 'handleFront'));
        add_action('admin_enqueue_scripts', array($this, 'loadAdminScripts'));

        if (is_admin())
        {
            $this->adminController = $this->di()->create('hji\\construction\\admin\\AdminController');
            $this->adminController->setup();
        }

        // Load text domain

        $paths = $this->services()->getPaths();
        load_plugin_textdomain(self::$textdomain, false, $paths->getPath('languages'));
    }


    /**
     * @codeCoverageIngore
     */
    public function setupRouting()
    {
        $router = $this->services()->getRouter();

        // Listings default

        $router->add(
            'hji\construction\models\listings\ListingsModel',
            'hji\construction\views\ListingsView',
            'hji\construction\front\controllers\ListingsController',
            array('^new-construction/listings/page/([^/]+)/?$',
                  'index.php?post_type=nc-listing&hji-controller=ListingsController&hji-view=ListingsView&hji-action=search&hji-params[pageNumber]=$matches[1]&paged=$matches[1]')
        );

        // Listings default paginated

        $router->add(
            'hji\construction\models\listings\ListingsModel',
            'hji\construction\views\ListingsView',
            'hji\construction\front\controllers\ListingsController',
            array('^new-construction/listings/?$',
                  'index.php?post_type=nc-listing&hji-controller=ListingsController&hji-view=ListingsView&hji-action=search')
        );


        // Single subdivision with paginated listings

        $router->add(
            'hji\construction\models\subdivisions\SubdivisionsModel',
            'hji\construction\views\SubdivisionsView',
            'hji\construction\front\controllers\SubdivisionsController',
            array('^new-construction/subdivision/([^-]+)-([^/]+)/page/([^/]+)?$',
                  'index.php?post_type=nc-subdivision&hji-controller=SubdivisionsController&hji-view=SubdivisionsView&hji-action=showSubdivision&hji-params[id]=$matches[1]&name=$matches[1]&hji-params[listingsPageNumber]=$matches[3]')
        );


        // Single listing by ID

        $router->add(
            'hji\construction\models\listings\ListingsModel',
            'hji\construction\views\ListingsView',
            'hji\construction\front\controllers\ListingsController',
            array('^new-construction/listing/([^/]+)/?$',
                  'index.php?post_type=nc-listing&hji-controller=ListingsController&hji-action=ShowListing&hji-params[id]=$matches[1]&name=$matches[1]')
        );



        // Single subdivision by ID

        $router->add(
            'hji\construction\models\subdivisions\SubdivisionsModel',
            'hji\construction\views\SubdivisionsView',
            'hji\construction\front\controllers\SubdivisionsController',
            array('^new-construction/subdivision/([^-]+)-([^/]+)/?$',
                  'index.php?post_type=nc-subdivision&hji-controller=SubdivisionsController&hji-view=SubdivisionsView&hji-action=showSubdivision&hji-params[id]=$matches[1]&name=$matches[1]')
        );

        $router->add(
            'hji\construction\models\subdivisions\SubdivisionsModel',
            'hji\construction\views\SubdivisionsView',
            'hji\construction\front\controllers\SubdivisionsController',
            array('^new-construction/subdivision/([^/]+)/?$',
                  'index.php?post_type=nc-subdivision&hji-controller=SubdivisionsController&hji-view=SubdivisionsView&hji-action=search&hji-params[id]=$matches[1]&name=$matches[1]')
        );

        // Subdivisions default

        $router->add(
            'hji\construction\models\subdivisions\SubdivisionsModel',
            'hji\construction\views\SubdivisionsView',
            'hji\construction\front\controllers\SubdivisionsController',
            array('^new-construction/subdivisions/?$',
                  'index.php?post_type=nc-subdivision&hji-controller=SubdivisionsController&hji-view=SubdivisionsView&hji-action=search')
        );

        // Subdivisions default paginated

        $router->add(
            'hji\construction\models\subdivisions\SubdivisionsModel',
            'hji\construction\views\SubdivisionsView',
            'hji\construction\front\controllers\SubdivisionsController',
            array('^new-construction/subdivisions/page/([^/]+)/?$',
                  'index.php?post_type=nc-subdivision&hji-controller=SubdivisionsController&hji-view=SubdivisionsView&hji-action=search&hji-params[pageNumber]=$matches[1]&paged=$matches[1]')
        );

        // Subdivisions by city and state

        $router->add(
            'hji\construction\models\subdivisions\SubdivisionsModel',
            'hji\construction\views\SubdivisionsView',
            'hji\construction\front\controllers\SubdivisionsController',
            array('^new-construction/subdivisions/([^/]+)/([^/]+)/?$',
                  'index.php?post_type=nc-subdivision&hji-controller=SubdivisionsController&hji-view=SubdivisionsView&hji-action=searchByCityState&hji-params[state]=$matches[1]&hji-params[city]=$matches[2]'),
            false
        );

        // Subdivisions by city and state paginated

        $router->add(
            'hji\construction\models\subdivisions\SubdivisionsModel',
            'hji\construction\views\SubdivisionsView',
            'hji\construction\front\controllers\SubdivisionsController',
            array('^new-construction/subdivisions/([^/]+)/([^/]+)/page/([^/]+)/?$',
                  'index.php?post_type=nc-subdivision&hji-controller=SubdivisionsController&hji-view=SubdivisionsView&hji-action=searchByCityState&hji-params[state]=$matches[1]&hji-params[city]=$matches[2]&hji-params[pageNumber]=$matches[3]&paged=$matches[3]'),
            false
        );

        $router->mount();
    }


    /**
     * Front-End handling via Front Controller
     *
     * @param $query
     */
    public function handleFront($query)
    {
        // If route match if found and it's a front-end page, instantiate $frontController.

        if (!is_admin() && is_array($query->query_vars) && $this->getProjectRoute())
        {
            if (isset($query->query_vars['hji-controller']))
            {
                $frontController = $this->di()->get('hji\\construction\\front\\FrontController');

                // Adding $_GET properties to the query_vars, soe they are available to our controller

                if (!isset($query->query_vars['hji-params']))
                {
                    $query->query_vars['hji-params'] = $_GET;
                }
                else
                {
                    $query->query_vars['hji-params'] = array_merge($query->query_vars['hji-params'], $_GET);
                }

                $frontController->init();
            }
        }
    }


    /**
     * Registers Custom Posts Types
     * Listings and Subdivisions
     * both post types have no UI, we register them only for the purpose of
     * routing through WP urls and injecting our content into WP's native post objects.
     *
     * @codeCoverageIgnore
     */
    public function registerPostType()
    {
        $singular   = 'Listing';
        $plural     = 'Listings';

        register_post_type( 'nc-listing',
            array(
                'labels' => array(
                    'name'              => _x( $plural, "New Construction {$plural}",       self::$textdomain ),
                    'singular_name'     => _x( $singular, "New Construction {$singular}",   self::$textdomain ),
                    'add_new'           => __( "Add a New {$singular}", self::$textdomain ),
                    'add_new_item'      => __( "Add a New {$singular}", self::$textdomain ),
                    'edit_item'         => __( "Edit {$singular}",      self::$textdomain ),
                    'new_item'          => __( "New {$singular}",       self::$textdomain ),
                    'view_item'         => __( "View {$singular}",      self::$textdomain ),
                    'search_items'      => __( "Search {$singular}",    self::$textdomain ),
                    'not_found'         => __( "Nothing Found",         self::$textdomain ),
                    'not_found_in_trash' => __( "Nothing found in Trash", self::$textdomain ),
                    'parent_item_colon'  => ''
                ),
                'description'           => __("New Construction {$plural}", self::$textdomain),
                'public'                => true, // All the relevant settings below inherit from this setting
                'exclude_from_search'   => true, // When a search is conducted through search.php, should it be excluded?
                'publicly_queryable'    => true, // When a parse_request() search is conducted, should it be included?
                'show_ui'               => false, // Should the primary admin menu be displayed?
                'show_in_nav_menus'     => false, // Should it show up in Appearance > Menus?
                'show_in_menu'          => false, // This inherits from show_ui, and determines *where* it should be displayed in the admin
                'show_in_admin_bar'     => false, // Should it show up in the toolbar when a user is logged in?
                'has_archive'           => strtolower('new-construction/' . $plural),
                'rewrite'               => array(
                    'slug' => strtolower('new-construction/' . $singular),
                    'pages' => false,
                    'feeds' => false,
                )
            ));

        $singular   = 'Subdivision';
        $plural     = 'Subdivisions';

        register_post_type( 'nc-subdivision',
            array(
                'labels' => array(
                    'name'          => _x( $plural, "New Construction {$plural}",       self::$textdomain ),
                    'singular_name' => _x( $singular, "New Construction {$singular}",   self::$textdomain ),
                    'add_new'       => __( "Add a New {$singular}", self::$textdomain ),
                    'add_new_item'  => __( "Add a New {$singular}", self::$textdomain ),
                    'edit_item'     => __( "Edit {$singular}",      self::$textdomain ),
                    'new_item'      => __( "New {$singular}",       self::$textdomain ),
                    'view_item'     => __( "View {$singular}",      self::$textdomain ),
                    'search_items'  => __( "Search {$singular}",    self::$textdomain ),
                    'not_found'     => __( "Nothing Found",         self::$textdomain ),
                    'not_found_in_trash' => __("Nothing found in Trash", self::$textdomain),
                    'parent_item_colon'  => ''
                ),
                'description'       => __("New Construction {$plural}", self::$textdomain),
                'public'            => true, // All the relevant settings below inherit from this setting
                'exclude_from_search' => true, // When a search is conducted through search.php, should it be excluded?
                'publicly_queryable' => true, // When a parse_request() search is conducted, should it be included?
                'show_ui'           => false, // Should the primary admin menu be displayed?
                'show_in_nav_menus' => false, // Should it show up in Appearance > Menus?
                'show_in_menu'      => false, // This inherits from show_ui, and determines *where* it should be displayed in the admin
                'show_in_admin_bar' => false, // Should it show up in the toolbar when a user is logged in?
                'has_archive'       => strtolower('new-construction/' . $plural),
                'rewrite'           => array(
                    'slug'  => strtolower('new-construction/' . $singular),
                    'pages' => false,
                    'feeds' => false,
                )
            ));
    }


    /**
     * Registers Widgets
     */
    protected function registerWidgets()
    {
        // Creating and Registering New Construction Search Widget

        $searchWidget = $this->di()->create('hji\\common\\factories\\WidgetTrioFactory', array('hji\\construction\\models\\NCSearchWidget'));

        $searchWidget->setShortcodeName('new_construction_search');
        $searchWidget->setIconUrl($this->services()->getPaths()->getUrl('images') . '/new-construction.png');
        $searchWidget->setHeight(400);
        $searchWidget->create();
    }


    /**
     * Registers plugin's settings and sets defaults if they are not set
     */
    public function registerSettings()
    {
        $settings = $this->di()->get('hji\\construction\\models\\Settings');
        register_setting($settings->getSettingsKey(), $settings->getSettingsKey());

        // If no settings exist, set defaults
        // Don't do it during ajax requests, otherwise duplicate forms may be imported.

        if (!defined('DOING_AJAX') ||  !DOING_AJAX)
        {
            if (!$options = $settings->getOptions())
            {
                $settings->setDefaults();
            }
        }
    }


    /**
     * @codeCoverageIgnore
     */
    function loadAdminScripts()
    {
        $currentScreen = get_current_screen();

        // Load this script only on widgets dashboard

        if (is_object($currentScreen) && in_array($currentScreen->id, array('widgets', 'customize')))
        {
            $paths = $this->services()->getPaths();

            wp_enqueue_script('hji-nc-admin-widgets', $paths->getUrl('scripts') . '/admin.js', array('jquery'), false, true);
        }
    }


    /**
     * Dependency Injection Rules
     *
     * @codeCoverageIgnore
     */
    protected function _setDiRules()
    {
        // Rules for Singleton Settings Model

        $rule = $this->di()->createRule();
        $rule->constructParams = array(App::$slug, 'hji-nc-settings');
        $rule->shared = true;
        $this->di()->addRule('hji\\construction\\models\\Settings', $rule);
    }
}

Namespaces

Classes

Interfaces

Functions