EE_Venue_Shortcodes - Code Metrics - Inspection of "Daily Inspection: Merge branch 'master' into BUG-1..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-10725-paypal-express-dupli... (e50e53)

unknown

created 2017-05-30 21:05 UTC

EE_Venue_Shortcodes C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	258
Duplicated Lines	10.85 %

Coupling/Cohesion

Components	2
Dependencies	10

Importance

Changes

Metric	Value
dl	28
loc	258
rs	6.8
c	0
b	0
f	0
wmc	55
lcom	2
cbo	10

4 Methods

Rating	Name	Duplication	Size	Complexity
B	_init_props()	28	28	1
C	_parser()	0	66	16
F	_venue()	0	102	33
B	get_map_attributes()	0	20	5

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like EE_Venue_Shortcodes often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use EE_Venue_Shortcodes, and based on these observations, apply Extract Interface, too.

<?php
defined('EVENT_ESPRESSO_VERSION') || exit('No direct access allowed.');

/**
 * EE_Venue_Shortcodes
 * this is a child class for the EE_Shortcodes library.  The EE_Venue_Shortcodes lists all shortcodes related to venue
 * specific info. NOTE: if a method doesn't have any phpdoc commenting the details can be found in the comments in
 * EE_Shortcodes parent class.
 *
 * @package        Event Espresso
 * @subpackage     libraries/shortcodes/EE_Venue_Shortcodes.lib.php
 * @author         Darren Ethier
 * ------------------------------------------------------------------------
 */
class EE_Venue_Shortcodes extends EE_Shortcodes
{


    /**
     * Will hold the EE_Event if available
     *
     * @var EE_Event
     */
    protected $_event;


    /**
     * Initialize properties
     */
    protected function _init_props()
    {
        $this->label       = esc_html__('Venue Shortcodes', 'event_espresso');
        $this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
        $this->_shortcodes = array(
            '[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
            '[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
            '[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
            '[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
            '[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
            '[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
            '[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
            '[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
            '[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
            '[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
            '[VENUE_FORMATTED_ADDRESS]' => esc_html__(
                'This just outputs the venue address in a semantic address format.',
                'event_espresso'
            ),
            '[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
            '[GOOGLE_MAP_URL]'          => esc_html__(
                'URL for the google map associated with the venue.',
                'event_espresso'
            ),
            '[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
            '[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
        );
    }


    /**
     * Parse incoming shortcode
     * @param string $shortcode
     * @return string
     */
    protected function _parser($shortcode)
    {

        switch ($shortcode) {
            case '[VENUE_TITLE]':
                return $this->_venue('title');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_DESCRIPTION]':
                return $this->_venue('description');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_URL]':
                return $this->_venue('url');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_IMAGE]':
                return $this->_venue('image');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_PHONE]':
                return $this->_venue('phone');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_ADDRESS]':
                return $this->_venue('address');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_ADDRESS2]':
                return $this->_venue('address2');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_CITY]':
                return $this->_venue('city');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_COUNTRY]':
                return $this->_venue('country');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_STATE]':
                return $this->_venue('state');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_ZIP]':
                return $this->_venue('zip');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[VENUE_FORMATTED_ADDRESS]':
                return $this->_venue('formatted_address');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[GOOGLE_MAP_URL]':
                return $this->_venue('gmap_url');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[GOOGLE_MAP_LINK]':
                return $this->_venue('gmap_link');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case '[GOOGLE_MAP_IMAGE]':
                return $this->_venue('gmap_link_img');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

        }
    }


    /**
     * This retrieves the specified venue information
     *
     * @param string $field  What Venue field to retrieve
     * @return string What was retrieved!
     * @throws EE_Error
     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
     */
    private function _venue($field)
    {
        //we need the EE_Event object to get the venue.
        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;

        //if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
        if (empty($this->_event)) {
            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;

            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration ? $aee->reg_obj->event() : null;

            //if still empty do we have a ticket data item?
            $this->_event = empty($this->_event)
                            && $this->_data instanceof EE_Ticket
                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
                ? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
                : $this->_event;

            //if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee and use that.
            $event        = $aee instanceof EE_Messages_Addressee ? reset($aee->events) : array();
            $this->_event = empty($this->_event) && ! empty($events) ? $event : $this->_event;

        }


        //If there is no event objecdt by now then get out.
        if (! $this->_event instanceof EE_Event) {
            return '';
        }

        /** @var EE_Venue $venue */
        $venue = $this->_event->get_first_related('Venue');

        if (empty($venue)) {
            return '';
        } //no venue so get out.

        switch ($field) {
            case 'title':
                return $venue->get('VNU_name');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'description':
                return $venue->get('VNU_desc');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'url':
                $url = $venue->get('VNU_url');
                return empty($url) ? $venue->get_permalink() : $url;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'image':
                return '<img src="' . $venue->feature_image_url(array(200, 200,))
                       . '" alt="' . sprintf(
                           esc_attr__('%s Feature Image', 'event_espresso'),
                           $venue->get('VNU_name')
                       ) . '" />';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'phone':
                return $venue->get('VNU_phone');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'address':
                return $venue->get('VNU_address');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'address2':
                return $venue->get('VNU_address2');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'city':
                return $venue->get('VNU_city');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'state':
                $state = $venue->state_obj();
                return is_object($state) ? $state->get('STA_name') : '';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'country':
                $country = $venue->country_obj();
                return is_object($country) ? $country->get('CNT_name') : '';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'zip':
                return $venue->get('VNU_zip');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'formatted_address':
                return EEH_Address::format($venue);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'gmap_link':
            case 'gmap_url':
            case 'gmap_link_img':
                $atts = $this->get_map_attributes($venue, $field);
                return EEH_Maps::google_map_link($atts);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }
        return '';
    }


    /**
     * Generates the attributes for retrieving a google_map artifact.
     * @param EE_Venue $venue
     * @param string   $field
     * @return array
     * @throws EE_Error
     */
    protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
    {
        $state   = $venue->state_obj();
        $country = $venue->country_obj();
        $atts    = array(
            'id'      => $venue->ID(),
            'address' => $venue->get('VNU_address'),
            'city'    => $venue->get('VNU_city'),
            'state'   => is_object($state) ? $state->get('STA_name') : '',
            'zip'     => $venue->get('VNU_zip'),
            'country' => is_object($country) ? $country->get('CNT_name') : '',
            'type'    => $field === 'gmap_link' ? 'url' : 'map',
            'map_w'   => 200,
            'map_h'   => 200,
        );
        if ($field === 'gmap_url') {
            $atts['type'] = 'url_only';
        }
        return $atts;
    }
}


eventespresso / event-espresso-core