<?php

/**
 * Venue_Overview_Help_Tour
 *
 * This is the help tour object for the Venue Overview page
 *
 *
 * @package         Venue_Overview_Help_Tour
 * @subpackage      caffeinated/admin/new/pricing/help_tours/Venue_Overview_Help_Tour.core.php
 * @author          Darren Ethier
 *
 * ------------------------------------------------------------------------
 */
class Venues_Categories_Help_Tour extends EE_Help_Tour
{

    protected function _set_tour_properties()
    {
        $this->_label = __('Venue Categories Tour', 'event_espresso');
        $this->_slug = 'venue-categories-joyride';
    }

    protected function _set_tour_stops()
    {
        $this->_stops = array(
            10 => array(
                'content' => $this->_start(),
            ),
            20 => array(
                'id'      => 'id',
                'content' => $this->_id_stop(),
                'options' => array(
                    'tipLocation'    => 'top',
                    'tipAdjustmentX' => -20,
                    'tipAdjustmentY' => -30,
                ),
            ),
            30 => array(
                'id'      => 'name',
                'content' => $this->_name_stop(),
                'options' => array(
                    'tipLocation'    => 'top',
                    'tipAdjustmentX' => -5,
                    'tipAdjustmentY' => -30,
                ),
            ),
            40 => array(
                'id'      => 'shortcode',
                'content' => $this->_shortcode_stop(),
                'options' => array(
                    'tipLocation'    => 'top',
                    'tipAdjustmentX' => 5,
                    'tipAdjustmentY' => -30,
                ),
            ),
            50 => array(
                'id'      => 'count',
                'content' => $this->_count_stop(),
                'options' => array(
                    'tipLocation'    => 'top',
                    'tipAdjustmentX' => 5,
                    'tipAdjustmentY' => -30,
                ),
            ),
            60 => array(
                'class'   => 'bulkactions',
                'content' => $this->_bulk_actions_stop(),
                'options' => array(
                    'tipLocation'    => 'top',
                    'tipAdjustmentX' => 25,
                    'tipAdjustmentY' => -35,
                ),
            ),
            70 => array(
                'id'      => 'event-espresso_page_espresso_venues-search-input',
                'content' => $this->_search_stop(),
                'options' => array(
                    'tipLocation'    => 'left',
                    'tipAdjustmentY' => -50,
                    'tipAdjustmentX' => -15,
                ),
            ),
            80 => array(
                'id'      => 'add-new-category',
                'content' => $this->_new_category_stop(),
                'options' => array(
                    'tipLocation'    => 'right',
                    'tipAdjustmentY' => -50,
                    'tipAdjustmentX' => 10,
                ),
            ),
        );
    }


    protected function _start()
    {
        $content = '<h3>' . __('Venue Overview', 'event_espresso') . '</h3>';
        $content .= '<p>'
                    . __(
                        'This tour of the Venues Overview page will provide an overview of the different areas of the screen to help you understand what they are used for.',
                        'event_espresso'
                    ) . '</p>';
        return $content;
    }

    protected function _id_stop()
    {
        return '<p>'
               . __(
                   'View the venue category ID. Can be sorted by ascending or descending order.',
                   'event_espresso'
               ) . '</p>';
    }

    protected function _name_stop()
    {
        return '<p>'
               . __(
                   'View the name of each venue category. Can be sorted by ascending or descending order.',
                   'event_espresso'
               ) . '</p>';
    }

    protected function _shortcode_stop()
    {
        return '<p>'
               . __(
                   'View the shortcode for a venue category. This shortcode can be added to an event, WordPress post, or WordPress page. ',
                   'event_espresso'
               ) . '</p>';
    }

    protected function _count_stop()
    {
        return '<p>' . __('View the number of venues that are associated with a category.', 'event_espresso') . '</p>';
    }

    protected function _bulk_actions_stop()
    {
        return '<p>' . __('Perform bulk actions to multiple venue categories.', 'event_espresso') . '</p>';
    }

    protected function _search_stop()
    {
        return '<p>'
               . __(
                   'Search through venues categories. The following sources will be searched: Venue Category ID, Venue Category Name, Venue Shortcode, and Venue Count.',
                   'event_espresso'
               ) . '</p>';
    }

    protected function _new_category_stop()
    {
        return '<p>' . __('Click here to add a new venue category.', 'event_espresso') . '</p>';
    }
}
