extras.php

<?php
/**
 * Extras File
 *
 * Contains extra (helper) functions.
 *
 * @package Backstage
 */

/**
 * Get the link for visitors to auto-login and access the Customizer.
 *
 * @param string|bool $return_url Optional. The return URL to use for the Customizer back button. Defaults to current frontend URL.
 * @param string|bool $button_text Optional. Custom button text to use for the Customizer back button.
 * @param array $extra_query_args Optional. Extra args to add to the URL.
 * @return string
 */
function backstage_get_customizer_link( $return_url = false, $button_text = false, $extra_query_args = array() ) {
	global $wp;

	// This should not be used in the admin.
	if ( is_admin() ) {
		return '';
	}

	$auto_login_key = backstage_get_setting( 'auto_login_key' );
	if ( empty( $auto_login_key ) ) {
		$auto_login_key = Backstage::$default_auto_login_key;
	}

	if ( empty( $return_url ) ) {
		// Get the current frontend URL.
		$return_url = home_url( add_query_arg( array(), $wp->request ) );
	}

	// Now get the Customizer URL.
	$link = wp_customize_url();
	// Next we need to add our own parameters to it, including the return URL (the current page).
	$auto_login_hash = wp_hash( $return_url );

	$link = add_query_arg( $auto_login_key, rawurlencode( $auto_login_hash ), $link );
	$link = add_query_arg( 'return_url', rawurlencode( $return_url ), $link );

	if ( ! empty( $button_text ) ) {
		// Sanitize it
		$button_text = esc_html( $button_text );
		if ( ! empty( $button_text ) ) {
			// Put it in the link
			$link = add_query_arg( 'button_text', rawurlencode( utf8_uri_encode( $button_text ) ), $link );
		}
	}

	if ( ! empty( $extra_query_args ) && is_array( $extra_query_args ) && ! wp_is_numeric_array( $extra_query_args ) ) {
		foreach ( $extra_query_args as $key => $value ) {
			$link = add_query_arg( rawurlencode( $key ), rawurlencode( utf8_uri_encode( $value ) ), $link );
		}
	}

	return apply_filters( 'backstage_get_customizer_link', $link );
}

/**
 * Check if current logged in user is the user used by the plugin.
 *
 * @return bool
 */
function backstage_is_customizer_user() {
	return Backstage_Plugin()->backstage->is_customizer_user();
}


/**
 * Helper function to prefix options, metas IDs.
 *
 * @param string $option The option ID to prefix.
 * @param string $separator Optional. The separator to use between prefix and the rest.
 * @return string
 */
function backstage_prefix( $option, $separator = '_' ) {
	return Backstage_Metaboxes::getInstance()->prefix( $option, $separator );
}

/**
 * Helper function to get/return the Backstage_Settings object
 *
 * @return Backstage_Settings
 */
function backstage_settings() {
	return Backstage_Settings::getInstance();
}

/**
 * Wrapper function around cmb2_get_option.
 *
 * @since 1.0.0
 *
 * @param  string  $setting Option key without any prefixing.
 * @param mixed $default Optional. The default value to retrieve in case the option was not found.
 * @return mixed        Option value
 */
function backstage_get_setting( $setting, $default = false ) {
	return Backstage_Plugin()->settings->get_option( $setting, $default );
}

function backstage_array_sort( $array, $on, $order = SORT_ASC ) {
	$new_array = array();
    $sortable_array = array();

    if ( count( $array ) > 0 ) {
	    foreach ( $array as $k => $v ) {
		    if ( is_array( $v ) ) {
			    foreach ( $v as $k2 => $v2 ) {
				    if ( $k2 == $on ) {
					    $sortable_array[ $k ] = $v2;
				    }
			    }
		    } else {
			    $sortable_array[ $k ] = $v;
		    }
	    }

	    switch ( $order ) {
		    case SORT_ASC:
			    asort( $sortable_array );
			    break;
		    case SORT_DESC:
			    arsort( $sortable_array );
			    break;
	    }

	    foreach ( $sortable_array as $k => $v ) {
		    $new_array[ $k ] = $array[ $k ];
	    }
    }

    return $new_array;
}

function backstage_get_string_between( $string, $start, $end = null ){
	$string = ' ' . $string;
    $ini = strpos($string, $start);
    if ($ini == 0) return '';
    $ini += strlen($start);

    // If we couldn't find the end marker or it is null we will return everything 'till the end
    if ( null === $end || false === strpos($string, $end, $ini) ) {
		return substr($string, $ini);
    } else {
	    $len = strpos( $string, $end, $ini ) - $ini;

	    return substr( $string, $ini, $len );
    }
}

/**
 * Get the complete current URL including query args
 * @return string
 */
function backstage_get_current_url() {
	//@todo we should do this is more standard WordPress way
	$url  = @( $_SERVER["HTTPS"] != 'on' ) ? 'http://'.$_SERVER["SERVER_NAME"] :  'https://'.$_SERVER["SERVER_NAME"];
	$url .= $_SERVER["REQUEST_URI"];
	return $url;
}

function backstage_to_bool( $value ) {
	if ( empty( $value ) ) {
		return false;
	}

	//see this for more info: http://stackoverflow.com/questions/7336861/how-to-convert-string-to-boolean-php
	return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
}

/**
 * Return a boolean value for the current state of a checkbox (it usually has yes or no value)
 *
 * @param $post_id    int
 * @param $meta_key   string
 *
 * @return boolean
 */
function backstage_meta_to_bool( $post_id, $meta_key ) {

	$result = get_post_meta( $post_id, $meta_key, true );

	return backstage_to_bool( $result );
}

/**
 * Check if the $haystack contains any of the needles.
 *
 * @param string $haystack
 * @param array $needles
 *
 * @return bool
 */
function backstage_string_contains_any( $haystack, $needles ) {
	foreach ( $needles as $needle ) {
		if ( false !== strpos( $haystack, $needle ) ) {
			return true;
		}
	}

	return false;
}

/**
 * Wrapper for _doing_it_wrong.
 *
 * Taken from WooCommerce - see wc_doing_it_wrong().
 *
 * @since  1.0.0
 * @param string $function Function used.
 * @param string $message Message to log.
 * @param string $version Version the message was added in.
 */
function backstage_doing_it_wrong( $function, $message, $version ) {
	// @codingStandardsIgnoreStart
	$message .= ' Backtrace: ' . wp_debug_backtrace_summary();

	if ( is_ajax() ) {
		do_action( 'doing_it_wrong_run', $function, $message, $version );
		error_log( "{$function} was called incorrectly. {$message}. This message was added in version {$version}." );
	} else {
		_doing_it_wrong( $function, $message, $version );
	}
	// @codingStandardsIgnoreEnd
}

/**
 * Autoloads the files in a theme's directory.
 *
 * We do not support child themes at this time.
 *
 * @param string $path The path of the theme directory to autoload files from.
 * @param int    $depth The depth to which we should go in the directory. A depth of 0 means only the files directly in that
 *                     directory. Depth of 1 means also the first level subdirectories, and so on.
 *                     A depth of -1 means load everything.
 * @param string $method The method to use to load files. Supports require, require_once, include, include_once.
 *
 * @return false|int False on failure, otherwise the number of files loaded.
 */
function backstage_autoload_dir( $path, $depth = 0, $method = 'require_once' ) {
	// If the $path starts with the absolute path to the WP install or the plugin directory, not good
	if ( strpos( $path, ABSPATH ) === 0 && strpos( $path, plugin_dir_path( __FILE__ ) ) !== 0 ) {
		backstage_doing_it_wrong( __FUNCTION__, esc_html__( 'Please provide only paths in the plugin for autoloading.', 'backstage' ), null );
		return false;
	}

	if ( ! in_array( $method, array( 'require', 'require_once', 'include', 'include_once' ) ) ) {
		backstage_doing_it_wrong( __FUNCTION__, esc_html__( 'We support only require, require_once, include, and include_once.', 'backstage' ), null );
		return false;
	}

	// If we have a relative path, make it absolute.
	if ( strpos( $path, plugin_dir_path( __FILE__ ) ) !== 0 ) {
		// Delete any / at the beginning.
		$path = ltrim( $path, '/' );

		// Add the current plugin path
		$path = trailingslashit( plugin_dir_path( __FILE__ ) ) . $path;
	}

	// Start the counter
	$counter = 0;

	$iterator = new DirectoryIterator( $path );
	// First we will load the files in the directory
	foreach ( $iterator as $file_info ) {
		if ( ! $file_info->isDir() && ! $file_info->isDot() && 'php' == strtolower( $file_info->getExtension() ) ) {
			switch ( $method ) {
				case 'require':
					require $file_info->getPathname();
					break;
				case 'require_once':
					require_once $file_info->getPathname();
					break;
				case 'include':
					include $file_info->getPathname();
					break;
				case 'include_once':
					include_once $file_info->getPathname();
					break;
				default:
					break;
			}

			$counter ++;
		}
	}

	// Now we load files in subdirectories if that's the case
	if ( $depth > 0 || -1 === $depth ) {
		if ( $depth > 0 ) {
			$depth --;
		}
		$iterator->rewind();
		foreach ( $iterator as $file_info ) {
			if ( $file_info->isDir() && ! $file_info->isDot() ) {
				$counter += backstage_autoload_dir( $file_info->getPathname(), $depth, $method );
			}
		}
	}

	return $counter;
}

/**
 * Does the same thing the JS encodeURIComponent() does
 *
 * @param string $str
 *
 * @return string
 */
function backstage_encodeURIComponent( $str ) {
	//if we get an array we just let it be
	if ( is_string( $str ) ) {
		$revert = array( '%21' => '!', '%2A' => '*', '%27' => "'", '%28' => '(', '%29' => ')' );

		$str = strtr( rawurlencode( $str ), $revert );
	} else {
		var_dump( 'boooom' );
		die;
	}

	return $str;
}

/**
 * Does the same thing the JS decodeURIComponent() does
 *
 * @param string $str
 *
 * @return string
 */
function backstage_decodeURIComponent( $str ) {
	// If we get an array we just let it be
	if ( is_string( $str ) ) {
		$revert = array( '!' => '%21', '*' => '%2A', "'" => '%27', '(' => '%28', ')' => '%29' );
		$str    = rawurldecode( strtr( $str, $revert ) );
	}

	return $str;
}

/**
 * Checks whether an array is associative or not
 *
 * @param array $array
 *
 * @return bool
 */
function backstage_is_assoc( $array ) {

	if ( ! is_array( $array ) ) {
		return false;
	}

	// Keys of the array
	$keys = array_keys( $array );

	// If the array keys of the keys match the keys, then the array must
	// not be associative (e.g. the keys array looked like {0:0, 1:1...}).
	return array_keys( $keys ) !== $keys;
}

/**
 * Attempt to split a string by whitespaces and return the parts as an array.
 * If not a string or no whitespaces present, just returns the value.
 *
 * @param mixed $value
 *
 * @return array|false|string[]
 */
function backstage_maybe_split_by_whitespace( $value ) {
	if ( ! is_string( $value ) ) {
		return $value;
	}

	return preg_split( '#[\s][\s]*#', $value, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE );
}

/**
 * Given a string, treat it as a (comma separated by default) list and return the array with the items
 *
 * @param mixed $str
 * @param string $delimiter Optional. The delimiter to user.
 *
 * @return array
 */
function backstage_maybe_explode_list( $str, $delimiter = ',' ) {
	// If by any chance we are given an array, just return it
	if ( is_array( $str ) ) {
		return $str;
	}

	// Anything else we coerce to a string
	if ( ! is_string( $str ) ) {
		$str = (string) $str;
	}

	// Make sure we trim it
	$str = trim( $str );

	// Bail on empty string
	if ( empty( $str ) ) {
		return array();
	}

	// Return the whole string as an element if the delimiter is missing
	if ( false === strpos( $str, $delimiter ) ) {
		return array( $str );
	}

	// Explode it and return it
	return explode( $delimiter, str_replace( ' ', '', $str ) );
}

/**
 * Retrive the class attribute given some classes.
 *
 * @param string|array $class Optional. One or more classes to add to the class list.
 * @param string|array $location Optional. The place (template) where the classes are displayed. This is a hint for filters.
 * @param string       $prefix Optional. Prefix to prepend to all of the provided classes
 * @param string       $suffix Optional. Suffix to append to all of the provided classes
 * @return string
 */
function backstage_css_class( $class = '', $location = '', $prefix = '', $suffix = '' ) {
	// Separates classes with a single space, collates classes for element
	return 'class="' . esc_attr( join( ' ', backstage_get_css_class( $class, $location ) ) ) . '"';
}

/**
 * Retrieve the classes for a element as an array.
 *
 * @param string|array $class Optional. One or more classes to add to the class list.
 * @param string|array $location Optional. The place (template) where the classes are displayed. This is a hint for filters.
 * @param string       $prefix Optional. Prefix to prepend to all of the provided classes
 * @param string       $suffix Optional. Suffix to append to all of the provided classes
 *
 * @return array Array of classes.
 */
function backstage_get_css_class( $class = '', $location = '', $prefix = '', $suffix = '' ) {
	$classes = array();

	if ( ! empty( $class ) ) {
		$class = backstage_maybe_split_by_whitespace( $class );

		// If we have a prefix then we need to add it to every class
		if ( ! empty( $prefix ) && is_string( $prefix ) ) {
			foreach ( $class as $key => $value ) {
				$class[ $key ] = $prefix . $value;
			}
		}

		// If we have a suffix then we need to add it to every class
		if ( ! empty( $suffix ) && is_string( $suffix ) ) {
			foreach ( $class as $key => $value ) {
				$class[ $key ] = $value . $suffix;
			}
		}

		$classes = array_merge( $classes, $class );
	} else {
		// Ensure that we always coerce class to being an array.
		$class = array();
	}

	$classes = array_map( 'esc_attr', $classes );

	return array_unique( $classes );
} // function