<?php
/**
 * "WordPress Plugin Template" Copyright (C) 2016 Michael Simpson  (email : michael.d.simpson@gmail.com)
 * This file is part of WordPress Plugin Template for WordPress.
 * WordPress Plugin Template is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * WordPress Plugin Template is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with Contact Form to Database Extension.
 * If not, see http://www.gnu.org/licenses/gpl-3.0.html
 *
 * @category File
 * @package  Adtechmedia_Plugin
 * @author   yamagleb
 */

/**
 * Class Adtechmedia_ShortCodeLoader
 */
abstract class Adtechmedia_ShortCodeLoader {

	/**
	 * Register shortcode
	 *
	 * @param mixed $shortcode_name either string name of the shortcode
	 * (as it would appear in a post, e.g. [shortcodeName])
	 * or an array of such names in case you want to have more than one name
	 * for the same shortcode.
	 * @return void
	 */
	public function register( $shortcode_name ) {
		$this->register_shortcode_to_function( $shortcode_name, 'handle_shortcode' );
	}

	/**
	 * Register shortcode to function
	 *
	 * @param mixed  $shortcode_name either string name of the shortcode
	 * (as it would appear in a post, e.g. [shortcodeName])
	 * or an array of such names in case you want to have more than one name
	 * for the same shortcode.
	 * @param string $function_name name of public function in this class to call as the
	 * shortcode handler.
	 * @return void
	 */
	protected function register_shortcode_to_function( $shortcode_name, $function_name ) {
		if ( is_array( $shortcode_name ) ) {
			foreach ( $shortcode_name as $a_name ) {
				add_shortcode( $a_name, array( $this, $function_name ) );
			}
		} else {
			add_shortcode( $shortcode_name, array( $this, $function_name ) );
		}
	}

	/**
	 * Handle Shortcode
	 *
	 * @abstract Override this function and add actual shortcode handling here
	 * @param shortcode $atts inputs.
	 * @return shortcode string content.
	 */
	public abstract function handle_shortcode( $atts );

}