Overview

Namespaces

  • None
  • VSP
    • Core
      • Abstracts
      • Interfaces
      • Traits
        • WC_Compatibility
    • Deprecation
    • Helper
    • Modules
      • Addons
      • Logger

Classes

  • VSP\Ajax
  • VSP\Ajaxer
  • VSP\Base
  • VSP\Cache
  • VSP\Core\Abstracts\Addon
  • VSP\Core\Abstracts\Log_Handler
  • VSP\Core\Abstracts\Plugin_Settings
  • VSP\Core\Instance_Handler
  • VSP\Deprecation\Actions
  • VSP\Deprecation\Filters
  • VSP\Error
  • VSP\Framework
  • VSP\Framework_Admin
  • VSP\Framework_Base
  • VSP\Framework_Modules
  • VSP\Helper
  • VSP\Helper\Price_Calculation
  • VSP\Modules\Addons
  • VSP\Modules\Addons\Admin
  • VSP\Modules\Addons\Core
  • VSP\Modules\Logger
  • VSP\Modules\Logger\File_Handler
  • VSP\Modules\Logger\Levels
  • VSP\Modules\Shortcode
  • VSP\Modules\System_Logs
  • VSP\Modules\System_Tools
  • VSP\Modules\WPOnion
  • VSP\Setup
  • VSP\WC_Compatibility
  • VSP_Framework_Loader

Interfaces

  • VSP\Core\Interfaces\Log_Handler
  • VSP\Core\Interfaces\Logger

Traits

  • VSP\Core\Traits\Array_Helper
  • VSP\Core\Traits\Framework
  • VSP\Core\Traits\String_Helper
  • VSP\Core\Traits\URL
  • VSP\Core\Traits\WC_Compatibility\Product
  • VSP\Core\Traits\WC_Compatibility\Version
  • VSP\Core\Traits\WC_Helper
  • VSP\Core\Traits\WP

Functions

  • vsp_add_wc_required_notice
  • vsp_ajax_action
  • vsp_current_screen
  • vsp_date_format
  • vsp_delete_cache
  • vsp_doing_it_wrong
  • vsp_force_load
  • vsp_force_load_vendors
  • vsp_get_cache
  • vsp_get_cache_defaults
  • vsp_get_file_paths
  • vsp_get_logger
  • vsp_get_time_in_seconds
  • vsp_is_admin
  • vsp_is_ajax
  • vsp_is_cron
  • vsp_is_error
  • vsp_is_frontend
  • vsp_is_heartbeat
  • vsp_is_json
  • vsp_is_request
  • vsp_is_screen
  • vsp_json_last_error
  • vsp_list_files
  • vsp_list_log_files
  • vsp_load_core_assets
  • vsp_load_file
  • vsp_log_msg
  • vsp_logger
  • vsp_make_log_list_tree
  • vsp_maybe_load
  • vsp_placeholder_img
  • vsp_print_log_files_ui
  • vsp_register_assets
  • vsp_register_plugin
  • vsp_send_callback_error
  • vsp_send_callback_success
  • vsp_send_json_callback
  • vsp_set_cache
  • vsp_set_time_limit
  • vsp_slashit
  • vsp_time_format
  • vsp_unslashit
  • vsp_url
  • vsp_validate_required_plugin
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 
<?php

namespace VSP;

defined( 'ABSPATH' ) || exit;

/**
 * Class Helper
 *
 * @package VSP
 * @author Varun Sridharan <varunsridharan23@gmail.com>
 */
final class Helper {
    use Core\Traits\WP;
    use Core\Traits\WC_Helper;
    use Core\Traits\Array_Helper;
    use Core\Traits\URL;
    use Core\Traits\String_Helper;

    /**
     * Gets the key value from globals.
     *
     * @param string $key
     *
     * @return string|boolean|bool
     */
    protected static function global_vars( $key ) {
        if ( isset( $_SERVER[ $key ] ) ) {
            return $_SERVER[ $key ];
        }
        if ( isset( $_ENV[ $key ] ) ) {
            return $_ENV[ $key ];
        }
        return false;
    }

    /**
     * Helper method to check if the multibyte extension is loaded, which
     * indicates it's safe to use the mb_*() string methods
     *
     * @return bool
     */
    public static function multibyte_loaded() {
        return extension_loaded( 'mbstring' );
    }

    /**
     * Generates A Rand MD5 String and returns it.
     *
     * @return string
     */
    public static function rand_md5() {
        return md5( time() . '-' . uniqid( rand(), true ) . '-' . mt_rand( 1, 1000 ) );
    }

    /**
     * Convert number of seconds to 'X {units}'
     *
     * E.g. 123 => '2 minutes'
     * then you can use this string how you want, for e.g. append ' ago' => '2 minutes ago'
     *
     * @param int $seconds
     *
     * @return string
     */
    public static function human_time( $seconds ) {
        $translation = array(
            'year'    => esc_html__( 'year', 'vsp-framework' ),
            'years'   => esc_html__( 'years', 'vsp-framework' ),
            'month'   => esc_html__( 'month', 'vsp-framework' ),
            'months'  => esc_html__( 'months', 'vsp-framework' ),
            'week'    => esc_html__( 'week', 'vsp-framework' ),
            'weeks'   => esc_html__( 'weeks', 'vsp-framework' ),
            'day'     => esc_html__( 'day', 'vsp-framework' ),
            'days'    => esc_html__( 'days', 'vsp-framework' ),
            'hour'    => esc_html__( 'hour', 'vsp-framework' ),
            'hours'   => esc_html__( 'hours', 'vsp-framework' ),
            'minute'  => esc_html__( 'minute', 'vsp-framework' ),
            'minutes' => esc_html__( 'minutes', 'vsp-framework' ),
            'second'  => esc_html__( 'second', 'vsp-framework' ),
            'seconds' => esc_html__( 'seconds', 'vsp-framework' ),
        );
        $tokens      = array(
            31536000 => 'year',
            2592000  => 'month',
            604800   => 'week',
            86400    => 'day',
            3600     => 'hour',
            60       => 'minute',
            1        => 'second',
        );

        foreach ( $tokens as $unit => $translation_key ) {
            if ( $seconds < $unit ) {
                continue;
            }

            $number_of_units = floor( $seconds / $unit );
            $key             = ( 1 !== $number_of_units ) ? 's' : '';
            return $number_of_units . ' ' . $translation[ $translation_key . $key ];
        }
        return false;
    }

    /**
     * Converts VSP Error To WC Notice.
     *
     * @param \VSP\Error $vsp_error
     *
     * @since 0.8.7
     */
    public static function vsp_error_to_wc_notice( $vsp_error ) {
        if ( ! empty( $vsp_error->get_error_codes() ) ) {
            foreach ( $vsp_error->get_error_codes() as $code ) {
                wc_add_notice( $vsp_error->get_error_message( $code ), 'error', $vsp_error->get_error_data( $code ) );
            }
        }
    }
}
API documentation generated by ApiGen