%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* Global plugin settings stored in a single WordPress site option.
*
* @property string $version Current plugin version installed
* @property bool $gen_hash Whether to compile hash table into MO files
* @property bool $use_fuzzy Whether to include Fuzzy strings in MO files
* @property int $num_backups Number of backups to keep of Gettext files
* @property array $pot_alias Alternative names for POT files in priority order
* @property array $php_alias Alternative file extensions for PHP files
* @property array $jsx_alias Registered extensions for scanning JavaScript/JSX files (disabled by default)
* @property bool $fs_persist Whether to remember file system credentials in session
* @property int $fs_protect Prevent modification of files in system folders (0:off, 1:warn, 2:block)
* @property string $max_php_size Skip PHP source files this size or larger
* @property bool $po_utf8_bom Whether to prepend PO and POT files with UTF-8 byte order mark
* @property string $po_width PO/POT file maximum line width (wrapping) zero to disable
* @property bool $jed_pretty Whether to pretty print JSON JED files
* @property bool $ajax_files Whether to submit PO data as concrete files (requires Blob support in Ajax)
*/
class Loco_data_Settings extends Loco_data_Serializable {
/**
* Global instance of this plugin's settings
* @var Loco_data_Settings
*/
private static $current;
/**
* Available options and their defaults
* @var array
*/
private static $defaults = array (
'version' => '',
'gen_hash' => false,
'use_fuzzy' => true,
'num_backups' => 1,
'pot_alias' => array( 'default.po', 'en_US.po', 'en.po' ),
'php_alias' => array( 'php', 'twig' ),
'jsx_alias' => array(),
'fs_persist' => false,
'fs_protect' => 1,
'max_php_size' => '100K',
'po_utf8_bom' => false,
'po_width' => '79',
'jed_pretty' => false,
'ajax_files' => true,
);
/**
* Create default settings instance
* @return Loco_data_Settings
*/
public static function create(){
$args = self::$defaults;
$args['version'] = loco_plugin_version();
return new Loco_data_Settings( $args );
}
/**
* Get currently configured global settings
* @return Loco_data_Settings
*/
public static function get(){
$opts = self::$current;
if( ! $opts ){
$opts = self::create();
$opts->fetch();
self::$current = $opts;
// allow hooks to modify settings
do_action('loco_settings', $opts );
}
return $opts;
}
/**
* Destroy current settings
* @return void
*/
public static function clear(){
delete_option('loco_settings');
self::$current = null;
}
/**
* Destroy current settings and return a fresh one
* @return Loco_data_Settings
*/
public static function reset(){
self::clear();
return self::$current = self::create();
}
/**
* {@inheritdoc}
*/
public function offsetSet( $prop, $value ){
if( ! isset(self::$defaults[$prop]) ){
throw new InvalidArgumentException('Invalid option, '.$prop );
}
$default = self::$defaults[$prop];
// cast to same type as default
if( is_bool($default) ){
$value = (bool) $value;
}
else if( is_int($default) ){
$value = (int) $value;
}
else if( is_array($default) ){
if( ! is_array($value) ){
$value = preg_split( '/[\\s,]+/', trim($value), -1, PREG_SPLIT_NO_EMPTY );
}
}
else {
$value = (string) $value;
}
parent::offsetSet( $prop, $value );
}
/**
* Commit current settings to WordPress DB
* @return bool
*/
public function persist(){
$this->version = loco_plugin_version();
$this->clean();
return update_option('loco_settings', $this->getSerializable() );
}
/**
* Pull current settings from WordPress DB and merge into this object
* @return bool whether settings where previously saved
*/
public function fetch(){
if( $data = get_option('loco_settings') ){
$copy = new Loco_data_Settings;
$copy->setUnserialized($data);
// preserve any defaults not in previously saved data
// this will occur if we've added options since setting were saved
$data = $copy->getArrayCopy() + $this->getArrayCopy();
// could ensure redundant keys are removed, but no need currently
// $data = array_intersect_key( $data, self::$defaults );
$this->exchangeArray( $data );
$this->clean();
return true;
}
return false;
}
/**
* Run migration in case plugin has been upgraded since settings last saved
* @return bool whether upgrade has occurred
*/
public function migrate(){
$updated = false;
// Always update version number in settings after an upgrade
if( version_compare($this->version,loco_plugin_version(),'<') ){
$this->persist();
$updated = true;
}
return $updated;
}
/**
* Populate all settings from raw postdata.
* @param array posted setting values
* @return Loco_data_Settings
*/
public function populate( array $data ){
// set all keys present in array
foreach( $data as $prop => $value ){
try {
$this->offsetSet( $prop, $value );
}
catch( InvalidArgumentException $e ){
// skipping invalid key
}
}
// set missing boolean keys as false, because checkboxes
if( $missing = array_diff_key(self::$defaults,$data) ){
foreach( $missing as $prop => $default ){
if( is_bool($default) ){
parent::offsetSet( $prop, false );
}
}
}
// enforce missing values that must have a default
foreach( array('php_alias','max_php_size','po_width') as $prop ){
if( isset($data[$prop]) && '' === $data[$prop] ){
parent::offsetSet( $prop, self::$defaults[$prop] );
}
}
return $this;
}
/**
* Map a file extension to registered types, defaults to "php"
* @param string
* @return string php, js or twig
*/
public function ext2type($x){
$x = strtolower($x);
$types = array_fill_keys( $this->jsx_alias, 'js' );
$types['twig'] = 'twig'; // <- temporary hack in lieu of dedicated twig extractor
return isset($types[$x]) ? $types[$x] : 'php';
}
}
Zerion Mini Shell 1.0