yoast_i18n

This class defines a promo box and checks your translation site's API for stats about it, then shows them to the user.

Defined (1)

The class is defined in the following location(s).

/vendor/yoast/i18n-module/i18n-module.php  
  1. class yoast_i18n { 
  2.  
  3.     /** 
  4.      * Your translation site's logo 
  5.      * 
  6.      * @var string 
  7.      */ 
  8.     private $glotpress_logo; 
  9.  
  10.     /** 
  11.      * Your translation site's name 
  12.      * 
  13.      * @var string 
  14.      */ 
  15.     private $glotpress_name; 
  16.  
  17.     /** 
  18.      * Your translation site's URL 
  19.      * 
  20.      * @var string 
  21.      */ 
  22.     private $glotpress_url; 
  23.  
  24.     /** 
  25.      * Hook where you want to show the promo box 
  26.      * 
  27.      * @var string 
  28.      */ 
  29.     private $hook; 
  30.  
  31.     /** 
  32.      * Will contain the site's locale 
  33.      * 
  34.      * @access private 
  35.      * @var string 
  36.      */ 
  37.     private $locale; 
  38.  
  39.     /** 
  40.      * Will contain the locale's name, obtained from yoru translation site 
  41.      * 
  42.      * @access private 
  43.      * @var string 
  44.      */ 
  45.     private $locale_name; 
  46.  
  47.     /** 
  48.      * Will contain the percentage translated for the plugin translation project in the locale 
  49.      * 
  50.      * @access private 
  51.      * @var int 
  52.      */ 
  53.     private $percent_translated; 
  54.  
  55.     /** 
  56.      * Name of your plugin 
  57.      * 
  58.      * @var string 
  59.      */ 
  60.     private $plugin_name; 
  61.  
  62.     /** 
  63.      * Project slug for the project on your translation site 
  64.      * 
  65.      * @var string 
  66.      */ 
  67.     private $project_slug; 
  68.  
  69.     /** 
  70.      * URL to point to for registration links 
  71.      * 
  72.      * @var string 
  73.      */ 
  74.     private $register_url; 
  75.  
  76.     /** 
  77.      * Your plugins textdomain 
  78.      * 
  79.      * @var string 
  80.      */ 
  81.     private $textdomain; 
  82.  
  83.     /** 
  84.      * Indicates whether there's a translation available at all. 
  85.      * 
  86.      * @access private 
  87.      * @var bool 
  88.      */ 
  89.     private $translation_exists; 
  90.  
  91.     /** 
  92.      * Indicates whether the translation's loaded. 
  93.      * 
  94.      * @access private 
  95.      * @var bool 
  96.      */ 
  97.     private $translation_loaded; 
  98.  
  99.     /** 
  100.      * Class constructor 
  101.      * 
  102.      * @param array $args Contains the settings for the class. 
  103.      */ 
  104.     public function __construct( $args ) { 
  105.         if ( ! is_admin() ) { 
  106.             return; 
  107.         } 
  108.  
  109.         $this->locale = get_locale(); 
  110.         if ( 'en_US' === $this->locale ) { 
  111.             return; 
  112.         } 
  113.  
  114.         $this->init( $args ); 
  115.  
  116.         if ( ! $this->hide_promo() ) { 
  117.             add_action( $this->hook, array( $this, 'promo' ) ); 
  118.         } 
  119.     } 
  120.  
  121.     /** 
  122.      * This is where you decide where to display the messages and where you set the plugin specific variables. 
  123.      * 
  124.      * @access private 
  125.      * 
  126.      * @param array $args 
  127.      */ 
  128.     private function init( $args ) { 
  129.         foreach ( $args as $key => $arg ) { 
  130.             $this->$key = $arg; 
  131.         } 
  132.     } 
  133.  
  134.     /** 
  135.      * Check whether the promo should be hidden or not 
  136.      * 
  137.      * @access private 
  138.      * 
  139.      * @return bool 
  140.      */ 
  141.     private function hide_promo() { 
  142.         $hide_promo = get_transient( 'yoast_i18n_' . $this->project_slug . '_promo_hide' ); 
  143.         if ( ! $hide_promo ) { 
  144.             if ( filter_input( INPUT_GET, 'remove_i18n_promo', FILTER_VALIDATE_INT ) === 1 ) { 
  145.                 // No expiration time, so this would normally not expire, but it wouldn't be copied to other sites etc. 
  146.                 set_transient( 'yoast_i18n_' . $this->project_slug . '_promo_hide', true ); 
  147.                 $hide_promo = true; 
  148.             } 
  149.         } 
  150.  
  151.         return $hide_promo; 
  152.     } 
  153.  
  154.     /** 
  155.      * Generates a promo message 
  156.      * 
  157.      * @access private 
  158.      * 
  159.      * @return bool|string $message 
  160.      */ 
  161.     private function promo_message() { 
  162.         $message = false; 
  163.  
  164.         if ( $this->translation_exists && $this->translation_loaded && $this->percent_translated < 90 ) { 
  165.             $message = __( 'As you can see, there is a translation of this plugin in %1$s. This translation is currently %3$d%% complete. We need your help to make it complete and to fix any errors. Please register at %4$s to help complete the translation to %1$s!', $this->textdomain ); 
  166.         } else if ( ! $this->translation_loaded && $this->translation_exists ) { 
  167.             $message = __( 'You\'re using WordPress in %1$s. While %2$s has been translated to %1$s for %3$d%%, it\'s not been shipped with the plugin yet. You can help! Register at %4$s to help complete the translation to %1$s!', $this->textdomain ); 
  168.         } else if ( ! $this->translation_exists ) { 
  169.             $message = __( 'You\'re using WordPress in a language we don\'t support yet. We\'d love for %2$s to be translated in that language too, but unfortunately, it isn\'t right now. You can change that! Register at %4$s to help translate it!', $this->textdomain ); 
  170.         } 
  171.  
  172.         $registration_link = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $this->register_url ), esc_html( $this->glotpress_name ) ); 
  173.         $message = sprintf( $message, esc_html( $this->locale_name ), esc_html( $this->plugin_name ), $this->percent_translated, $registration_link ); 
  174.  
  175.         return $message; 
  176.     } 
  177.  
  178.     /** 
  179.      * Outputs a promo box 
  180.      */ 
  181.     public function promo() { 
  182.         $this->translation_details(); 
  183.  
  184.         $message = $this->promo_message(); 
  185.  
  186.         if ( $message ) { 
  187.             echo '<div id="i18n_promo_box" style="border:1px solid #ccc;background-color:#fff;padding:10px;max-width:650px;">'; 
  188.             echo '<a href="' . esc_url( add_query_arg( array( 'remove_i18n_promo' => '1' ) ) ) . '" style="color:#333;text-decoration:none;font-weight:bold;font-size:16px;border:1px solid #ccc;padding:1px 4px;" class="alignright">X</a>'; 
  189.             echo '<h2>' . sprintf( __( 'Translation of %s', $this->textdomain ), $this->plugin_name ) . '</h2>'; 
  190.             if ( isset( $this->glotpress_logo ) && '' != $this->glotpress_logo ) { 
  191.                 echo '<a href="' . $this->register_url . '"><img class="alignright" style="margin:15px 5px 5px 5px;width:200px;" src="' . $this->glotpress_logo . '" alt="' . $this->glotpress_name . '"/></a>'; 
  192.             } 
  193.             echo '<p>' . $message . '</p>'; 
  194.             echo '<p><a href="' . $this->register_url . '">' . __( 'Register now »', $this->textdomain ) . '</a></p>'; 
  195.             echo '</div>'; 
  196.         } 
  197.     } 
  198.  
  199.     /** 
  200.      * Try to find the transient for the translation set or retrieve them. 
  201.      * 
  202.      * @access private 
  203.      * 
  204.      * @return object|null 
  205.      */ 
  206.     private function find_or_initialize_translation_details() { 
  207.         $set = get_transient( 'yoast_i18n_' . $this->project_slug . '_' . $this->locale ); 
  208.  
  209.         if ( ! $set ) { 
  210.             $set = $this->retrieve_translation_details(); 
  211.             set_transient( 'yoast_i18n_' . $this->project_slug . '_' . $this->locale, $set, DAY_IN_SECONDS ); 
  212.         } 
  213.  
  214.         return $set; 
  215.     } 
  216.  
  217.     /** 
  218.      * Try to get translation details from cache, otherwise retrieve them, then parse them. 
  219.      * 
  220.      * @access private 
  221.      */ 
  222.     private function translation_details() { 
  223.         $set = $this->find_or_initialize_translation_details(); 
  224.  
  225.         $this->translation_exists = ! is_null( $set ); 
  226.         $this->translation_loaded = is_textdomain_loaded( $this->textdomain ); 
  227.  
  228.         $this->parse_translation_set( $set ); 
  229.     } 
  230.  
  231.     /** 
  232.      * Retrieve the translation details from Yoast Translate 
  233.      * 
  234.      * @access private 
  235.      * 
  236.      * @return object|null 
  237.      */ 
  238.     private function retrieve_translation_details() { 
  239.         $api_url = trailingslashit( $this->glotpress_url ) . 'api/projects/' . $this->project_slug; 
  240.  
  241.         $resp = wp_remote_get( $api_url ); 
  242.         $body = wp_remote_retrieve_body( $resp ); 
  243.         unset( $resp ); 
  244.  
  245.         if ( $body ) { 
  246.             $body = json_decode( $body ); 
  247.             foreach ( $body->translation_sets as $set ) { 
  248.                 if ( $this->locale == $set->wp_locale ) { 
  249.                     return $set; 
  250.                 } 
  251.             } 
  252.         } 
  253.  
  254.         return null; 
  255.     } 
  256.  
  257.     /** 
  258.      * Set the needed private variables based on the results from Yoast Translate 
  259.      * 
  260.      * @param object $set The translation set 
  261.      * 
  262.      * @access private 
  263.      */ 
  264.     private function parse_translation_set( $set ) { 
  265.         if ( $this->translation_exists && is_object( $set ) ) { 
  266.             $this->locale_name = $set->name; 
  267.             $this->percent_translated = $set->percent_translated; 
  268.         } else { 
  269.             $this->locale_name = ''; 
  270.             $this->percent_translated = ''; 
  271.         } 
  272.     } 
  273. }