GravityView  2.17
The best, easiest way to display Gravity Forms entries on your website.
Public Member Functions | Static Public Member Functions | Data Fields | Private Attributes | Static Private Attributes
Framework Class Reference

Public Member Functions

 can_install_languages ()
 Checks of user has permissions to install languages. More...
 
 get_T15s_updater ( $text_domain)
 Returns TranslationsPress updater instance. More...
 
 init ()
 Initializes Translations framework. More...
 
 install ( $text_domain, $new_language)
 Downloads and installs translations from TranslationsPress. More...
 
 is_en_locale ( $locale='')
 Checks whether the current locale is set to English language. More...
 
 load_all_translations ( $text_domain, $language='')
 Loads and sets frontend and backend translations. More...
 
 load_backend_translations ( $text_domain, $language='')
 Loads and sets backend translations. More...
 
 load_frontend_translations ( $text_domain, $language='', $frontend_text_domain='')
 Loads and sets frontend translations. More...
 
 on_plugin_activation ( $plugin_file)
 Installs or updates translations for all plugins when a plugin is activated. More...
 
 on_plugin_deactivation ( $plugin_file)
 Deletes translations when the plugin is deactivated. More...
 
 on_site_language_change ( $from_language, $to_language)
 Installs or updates translations for all plugins when the site's language setting is changed. More...
 

Static Public Member Functions

static get_instance ()
 Returns class instance. More...
 
static get_translation_filename ( $text_domain, $language, $extension='mo')
 Returns the translation filename for a given language. More...
 

Data Fields

const ID = 'gk-translations'
 
const WP_LANG_DIR = WP_LANG_DIR . '/plugins'
 

Private Attributes

 $_logger
 
 $_text_domains = []
 

Static Private Attributes

static $_instance
 

Detailed Description

Definition at line 15 of file Translations/Framework.php.

Member Function Documentation

◆ can_install_languages()

can_install_languages ( )

Checks of user has permissions to install languages.

Since
1.0.0
Returns
bool
Runs Filter:
gk/foundation/translations/permissions/can_install_languages Sets permission to install languages.
Since
1.0.0
Parameters
bool$can_install_languagesDefault: 'install_languages' capability.

Definition at line 120 of file Translations/Framework.php.

Referenced by Framework\install(), Framework\on_plugin_activation(), Framework\on_plugin_deactivation(), and Framework\on_site_language_change().

◆ get_instance()

static get_instance ( )
static

Returns class instance.

Since
1.0.0
Returns
Framework

Definition at line 52 of file Translations/Framework.php.

◆ get_T15s_updater()

get_T15s_updater (   $text_domain)

Returns TranslationsPress updater instance.

Since
1.0.0
Parameters
string$text_domainText domain.
Returns
TranslationsPress_Updater

Definition at line 69 of file Translations/Framework.php.

References TranslationsPress_Updater\get_instance().

Referenced by Framework\install().

◆ get_translation_filename()

static get_translation_filename (   $text_domain,
  $language,
  $extension = 'mo' 
)
static

Returns the translation filename for a given language.

Parameters
string$text_domainText domain.
string$languageTranslation language (e.g. 'en_EN').
string$extension(optional) File extension. Default is 'mo'.
Returns
string|null

Definition at line 281 of file Translations/Framework.php.

Referenced by Framework\load_backend_translations(), and Framework\load_frontend_translations().

◆ init()

init ( )

Initializes Translations framework.

Since
1.0.0
Returns
void
Runs Actions:
gk/foundation/translations/initialized Fires when the class has finished initializing.
Since
1.0.0
Parameters
$this

Definition at line 80 of file Translations/Framework.php.

◆ install()

install (   $text_domain,
  $new_language 
)

Downloads and installs translations from TranslationsPress.

Since
1.0.0
Parameters
string$text_domainText domain.
string$new_languageThe new site language, only set if user is updating their language settings.
Returns
void

Definition at line 141 of file Translations/Framework.php.

References Framework\can_install_languages(), Framework\get_T15s_updater(), and Framework\load_backend_translations().

Referenced by Framework\on_plugin_activation(), and Framework\on_site_language_change().

◆ is_en_locale()

is_en_locale (   $locale = '')

Checks whether the current locale is set to English language.

Since
1.0.0
Parameters
string$locale(optional) Locale to check. Default is site locale.
Returns
bool

Definition at line 372 of file Translations/Framework.php.

Referenced by Framework\load_frontend_translations(), Framework\on_plugin_activation(), and Framework\on_plugin_deactivation().

◆ load_all_translations()

load_all_translations (   $text_domain,
  $language = '' 
)

Loads and sets frontend and backend translations.

Since
1.0.0
Parameters
string$text_domainText domain.
string$language(optional) Language to load. Default is site locale.
Returns
void

Definition at line 178 of file Translations/Framework.php.

References Framework\load_backend_translations(), and Framework\load_frontend_translations().

◆ load_backend_translations()

load_backend_translations (   $text_domain,
  $language = '' 
)

Loads and sets backend translations.

Since
1.0.0
Parameters
string$text_domainText domain.
string$language(optional) Language to load. Default is site locale.
Returns
void

Definition at line 193 of file Translations/Framework.php.

References Framework\get_translation_filename().

Referenced by Framework\install(), and Framework\load_all_translations().

◆ load_frontend_translations()

load_frontend_translations (   $text_domain,
  $language = '',
  $frontend_text_domain = '' 
)

Loads and sets frontend translations.

Since
1.0.0
Parameters
string$text_domainText domain.
string$language(optional) Language to load. Default is site locale.
string$frontend_text_domain(optional) Frontend text domain if different from the backend text domain (e.g., plugin uses 'foo', but JS uses 'bar' for the same translations).
Returns
void

Definition at line 226 of file Translations/Framework.php.

References Framework\get_translation_filename(), and Framework\is_en_locale().

Referenced by Framework\load_all_translations().

◆ on_plugin_activation()

on_plugin_activation (   $plugin_file)

Installs or updates translations for all plugins when a plugin is activated.

Since
1.0.0
Parameters
string$plugin_filePlugin file.
Returns
void

Definition at line 316 of file Translations/Framework.php.

References Framework\can_install_languages(), Framework\install(), and Framework\is_en_locale().

◆ on_plugin_deactivation()

on_plugin_deactivation (   $plugin_file)

Deletes translations when the plugin is deactivated.

Since
1.0.0
Parameters
string$plugin_filePlugin file.
Returns
void

Definition at line 339 of file Translations/Framework.php.

References Framework\can_install_languages(), and Framework\is_en_locale().

◆ on_site_language_change()

on_site_language_change (   $from_language,
  $to_language 
)

Installs or updates translations for all plugins when the site's language setting is changed.

Since
1.0.0
Parameters
string$from_languageThe language before the user changed their language setting.
string$to_languageThe new language after the user changed their language setting.
Returns
void

Definition at line 297 of file Translations/Framework.php.

References Framework\can_install_languages(), and Framework\install().

Field Documentation

◆ $_instance

$_instance
staticprivate

Definition at line 27 of file Translations/Framework.php.

◆ $_logger

$_logger
private

Definition at line 36 of file Translations/Framework.php.

◆ $_text_domains

$_text_domains = []
private

Definition at line 43 of file Translations/Framework.php.

◆ ID

const ID = 'gk-translations'

Definition at line 16 of file Translations/Framework.php.

◆ WP_LANG_DIR

const WP_LANG_DIR = WP_LANG_DIR . '/plugins'

Definition at line 18 of file Translations/Framework.php.

The documentation for this class was generated from the following file: