GV\Shortcode

Complexity

Total Complexity

8

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	callback()	0	3	1
A	remove()	0	5	1
A	add()	0	13	3
B	parse()	0	39	3

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 13 and the first side effect is on line 5.

namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) )

It is generally a best practice to always use braces with control structures.

	die();

/**
 * The base \GV\Shortcode class.
 *
 * Contains some unitility methods, base class for all GV Shortcodes.
 */
class Shortcode {
	/*
	 * @var array All GravityView-registered and loaded shortcodes can be found here.
	 */
	private static $shortcodes;

	/**
	 * @var array The parsed attributes of this shortcode.
	 */
	public $atts;

	/**
	 * @var string The parsed name of this shortcode.
	 */
	public $name;

	/**
	 * @var string The parsed content between tags of this shortcode.
	 */
	public $content;

	/**
	 * The WordPress Shortcode API callback for this shortcode.
	 *
	 * @param array $atts The callback shortcode attributes.
	 * @param string|null $content The wrapped content. Default: null.
	 *
	 * @throws \BadMethodCallException in base class.
	 *
	 * @return string The result of the shortcode logic.
	 */
	public static function callback( $atts, $content = null ) {

The parameter $atts is not used and could be removed.

The parameter $content is not used and could be removed.

		throw new \BadMethodCallException( 'Callback not implemented in base \GV\Shortcode class.' );
	}

	/**
	 * Register this shortcode class with the WordPress Shortcode API.
	 *
	 * @throws \ErrorException if shortcode with this name has already been registered elsewhere.
	 * @internal

	 * @return \GV\Shortcode The only internally registered instance of this shortcode.
	 */
	public static function add() {
		$shortcode = new static();
		if ( shortcode_exists( $shortcode->name ) ) {
			if ( empty( self::$shortcodes[$shortcode->name] ) ) {

Array keys should be surrounded by spaces unless they contain a string or an integer.

				throw new \ErrorException( sprintf( 'Shortcode [%s] has already been registered elsewhere.', $shortcode->name ) );
			}
		} else {
			add_shortcode( $shortcode->name, array( get_class( $shortcode ), 'callback' ) );
			self::$shortcodes[$shortcode->name] = $shortcode;

Array keys should be surrounded by spaces unless they contain a string or an integer.

		}

		return self::$shortcodes[$shortcode->name];

Array keys should be surrounded by spaces unless they contain a string or an integer.

	}

	/**
	 * Unregister this shortcode.
	 *
	 * @internal
	 *
	 * @return void
	 */
	public static function remove() {
		$shortcode = new static();
		unset( self::$shortcodes[$shortcode->name] );

Array keys should be surrounded by spaces unless they contain a string or an integer.

		remove_shortcode( $shortcode->name );
	}

	/**
	 * Parse a string of content and figure out which ones there are.
	 *
	 * Only registered shortcodes (via add_shortcode) will show up.
	 * Returned order is not guaranteed.
	 *
	 * @param string $content Some post content to search through.
	 *
	 * @internal
	 *
	 * @return \GV\Shortcode[] An array of \GV\Shortcode (and subclass) instances.
	 */
	public static function parse( $content ) {
		$shortcodes = array();

		/**
		 * The matches contains:
		 *
		 * 1 - An extra [ to allow for escaping shortcodes with double [[]]
		 * 2 - The shortcode name
		 * 3 - The shortcode argument list
		 * 4 - The self closing /
		 * 5 - The content of a shortcode when it wraps some content.
		 * 6 - An extra ] to allow for escaping shortcodes with double [[]]
		 */
		preg_match_all( '/' . get_shortcode_regex() . '/', $content, $matches, PREG_SET_ORDER );

		foreach ( $matches as $shortcode ) {
			$shortcode_name = $shortcode[2];

			$shortcode_atts = shortcode_parse_atts( $shortcode[3] );
			$shortcode_content = $shortcode[5];

			/** This is a registered GravityView shortcode. */
			if ( !empty( self::$shortcodes[$shortcode_name] ) ) {

Expected 1 space after "!"; 0 found

Array keys should be surrounded by spaces unless they contain a string or an integer.

				$shortcode = clone( self::$shortcodes[$shortcode_name] );

Array keys should be surrounded by spaces unless they contain a string or an integer.

			} else {
				/** This is some generic shortcode. */
				$shortcode = new self;
				$shortcode->name = $shortcode_name;
			}

			$shortcode->atts = $shortcode_atts;
			$shortcode->content = $shortcode_content;

			/** Merge inner shortcodes. */
			$shortcodes = array_merge( $shortcodes, array( $shortcode ), self::parse( $shortcode_content ) );
		}

		return $shortcodes;
	}
}