source: multisite-language-switcher/trunk/includes/MslsAdmin.php

<?php declare( strict_types=1 );

namespace lloc\Msls;

use lloc\Msls\Component\Input\Checkbox;
use lloc\Msls\Component\Input\Group;
use lloc\Msls\Component\Input\Label;
use lloc\Msls\Component\Input\Text;
use lloc\Msls\Component\Input\Select;

/**
 * Administration of the options
 *
 * @method void activate_autocomplete()
 * @method void sort_by_description()
 * @method void exclude_current_blog()
 * @method void only_with_translation()
 * @method void output_current_blog()
 * @method void before_output()
 * @method void after_output()
 * @method void before_item()
 * @method void after_item()
 * @method void content_filter()
 *
 * @package Msls
 */
final class MslsAdmin extends MslsMain {

        const MSLS_REGISTER_ACTION = 'msls_admin_register';

        const MSLS_ACTION_PREFIX = 'msls_admin_';

        /**
         * Maximum number of users in the reference user select box
         *
         * @var int
         */
        public const MAX_REFERENCE_USERS = 100;

        /**
         * @codeCoverageIgnore
         */
        public static function init(): void {
                $obj = MslsRegistry::get_object( __CLASS__ );
                if ( ! $obj ) {
                        $obj = new self( msls_options(), msls_blog_collection() );

                        MslsRegistry::set_object( __CLASS__, $obj );

                        /**
                         * Override the capabilities needed for the plugin's settings
                         *
                         * @param string $capability
                         *
                         * @since 2.0
                         */
                        $caps = apply_filters( 'msls_admin_caps', 'manage_options' );
                        if ( current_user_can( $caps ) ) {
                                $title = __( 'Multisite Language Switcher', 'multisite-language-switcher' );
                                add_options_page( $title, $title, 'manage_options', $obj->get_menu_slug(), array( $obj, 'render' ) );

                                add_action( 'admin_init', array( $obj, 'register' ) );
                                add_action( 'admin_notices', array( $obj, 'has_problems' ) );

                                add_filter( 'msls_admin_validate', array( $obj, 'set_blog_language' ) );
                        }
                }
        }

        /**
         * Let's do this simple
         *
         * @return string
         */
        public function get_menu_slug(): string {
                return 'MslsAdmin';
        }

        /**
         * Gets the link for the switcher-settings in the wp-admin
         *
         * @return string
         */
        public function get_options_page_link(): string {
                return sprintf( '/options-general.php?page=%s', $this->get_menu_slug() );
        }

        /**
         * You can use every method of the decorated object
         *
         * @param string $method
         * @param mixed  $args
         *
         * @return mixed
         */
        public function __call( $method, $args ) {
                $parts = explode( '_', $method, 2 );
                if ( 2 === count( $parts ) && 'rewrite' === $parts[0] ) {
                        $this->render_rewrite( $parts[1] );
                        return;
                }

                $checkboxes = array(
                        'activate_autocomplete'   => __(
                                'Activate experimental autocomplete inputs',
                                'multisite-language-switcher'
                        ),
                        'activate_content_import' => __(
                                'Activate the content import functionality',
                                'multisite-language-switcher'
                        ),
                        'sort_by_description'     => __( 'Sort languages by description', 'multisite-language-switcher' ),
                        'exclude_current_blog'    => __( 'Exclude this blog from output', 'multisite-language-switcher' ),
                        'only_with_translation'   => __( 'Show only links with a translation', 'multisite-language-switcher' ),
                        'output_current_blog'     => __( 'Display link to the current language', 'multisite-language-switcher' ),
                        'content_filter'          => __( 'Add hint for available translations', 'multisite-language-switcher' ),
                );

                if ( isset( $checkboxes[ $method ] ) ) {
                        $group = ( new Group() )
                                ->add( new Checkbox( $method, $this->options->$method ) )
                                ->add( new Label( $method, $checkboxes[ $method ] ) );

                        echo $group->render(); // phpcs:ignore WordPress.Security.EscapeOutput
                } else {
                        $text = new Text( $method, ! empty( $this->options->$method ) ? $this->options->$method : '' );

                        echo $text->render(); // // phpcs:ignore WordPress.Security.EscapeOutput
                }
        }

        /**
         * There is something wrong? Here comes the message...
         *
         * @return void
         */
        public function has_problems(): void {
                $message = '';

                if ( $this->options->is_empty() ) {
                        /* translators: %s: URL to the options page */
                        $format  = __(
                                'Multisite Language Switcher is almost ready. You must <a href="%s">complete the configuration process</a>.',
                                'multisite-language-switcher'
                        );
                        $message = sprintf( $format, esc_url( admin_url( $this->get_options_page_link() ) ) );
                } elseif ( 1 === count( $this->options->get_available_languages() ) ) {
                        /* translators: %1$s: URL to a page at WordPress.orgs */
                        $format  = __(
                                'No language files are currently installed. Learn how to install various languages in WordPress by <a href="%1$s">reading more here</a>.',
                                'multisite-language-switcher'
                        );
                        $message = sprintf(
                                $format,
                                esc_url( 'https://developer.wordpress.org/advanced-administration/before-install/in-your-language/#Manually_Installing_Language_Files' )
                        );
                }

                MslsPlugin::message_handler( $message, 'updated fade' );
        }

        /**
         * Render the options-page
         */
        public function render(): void {
                printf(
                        '<div class="wrap"><div class="icon32" id="icon-options-general"><br/></div><h1>%s</h1>%s<br class="clear"/><form action="options.php" method="post"><p>%s</p>',
                        esc_html__( 'Multisite Language Switcher Options', 'multisite-language-switcher' ),
                        $this->subsubsub(), // phpcs:ignore WordPress.Security.EscapeOutput
                        esc_html__(
                                'To achieve maximum flexibility, you have to configure each blog separately.',
                                'multisite-language-switcher'
                        )
                );

                settings_fields( 'msls' );
                do_settings_sections( __CLASS__ );

                $value = $this->options->is_empty() ? __( 'Configure', 'multisite-language-switcher' ) : __( 'Update', 'multisite-language-switcher' );

                printf(
                        '<p class="submit"><input name="Submit" type="submit" class="button button-primary" value="%s" /></p></form></div>',
                        esc_html( $value )
                );
        }


        /**
         * Create a submenu which contains links to all blogs of the current user
         *
         * @return string
         */
        public function subsubsub(): string {
                $icon_type = $this->options->get_icon_type();

                $arr = array();
                foreach ( $this->collection->get_plugin_active_blogs() as $blog ) {
                        $admin_url = get_admin_url( $blog->userblog_id, $this->get_options_page_link() );
                        $current   = $blog->userblog_id === $this->collection->get_current_blog_id() ? ' class="current"' : '';

                        $arr[] = sprintf( '<a href="%1$s"%2$s>%3$s</a>', $admin_url, $current, $blog->get_title( $icon_type ) );
                }

                return empty( $arr ) ? '' : sprintf(
                        '<ul class="subsubsub"><li>%s</li></ul>',
                        implode( ' | </li><li>', $arr )
                );
        }

        /**
         * Register the form-elements
         */
        public function register(): void {
                register_setting( 'msls', 'msls', array( $this, 'validate' ) );

                $sections = array(
                        'language_section' => __( 'Language Settings', 'multisite-language-switcher' ),
                        'main_section'     => __( 'Main Settings', 'multisite-language-switcher' ),
                        'advanced_section' => __( 'Advanced Settings', 'multisite-language-switcher' ),
                );

                global $wp_rewrite;
                if ( $wp_rewrite->using_permalinks() ) {
                        $sections['rewrites_section'] = __( 'Rewrites Settings', 'multisite-language-switcher' );
                }

                foreach ( $sections as $id => $title ) {
                        add_settings_section( $id, $title, array( $this, $id ), __CLASS__ );
                }

                /**
                 * Lets you add your own settings section
                 *
                 * @param string $page
                 *
                 * @since 1.0
                 */
                do_action( self::MSLS_REGISTER_ACTION, __CLASS__ );
        }

        /**
         * Registers the fields in the language_section
         *
         * Returns the number of added fields
         *
         * @return int
         */
        public function language_section(): int {
                $map = array( 'blog_language' => __( 'Blog Language', 'multisite-language-switcher' ) );

                return $this->add_settings_fields( $map, 'language_section' );
        }

        /**
         * Registers the fields in the main_section
         *
         * Returns the number of added fields
         *
         * @return int
         */
        public function main_section(): int {
                $map = array(
                        'display'               => esc_html__( 'Display', 'multisite-language-switcher' ),
                        'admin_display'         => esc_html__( 'Admin Display', 'multisite-language-switcher' ),
                        'sort_by_description'   => esc_html__( 'Sort languages', 'multisite-language-switcher' ),
                        'output_current_blog'   => esc_html__( 'Current language link', 'multisite-language-switcher' ),
                        'only_with_translation' => esc_html__( 'Translation links', 'multisite-language-switcher' ),
                        'description'           => esc_html__( 'Description', 'multisite-language-switcher' ),
                        'before_output'         => esc_html__( 'Text/HTML before the list', 'multisite-language-switcher' ),
                        'after_output'          => esc_html__( 'Text/HTML after the list', 'multisite-language-switcher' ),
                        'before_item'           => esc_html__( 'Text/HTML before each item', 'multisite-language-switcher' ),
                        'after_item'            => esc_html__( 'Text/HTML after each item', 'multisite-language-switcher' ),
                        'content_filter'        => esc_html__( 'Available translations hint', 'multisite-language-switcher' ),
                        'content_priority'      => esc_html__( 'Hint priority', 'multisite-language-switcher' ),
                );

                return $this->add_settings_fields( $map, 'main_section' );
        }

        /**
         * Registers the fields in the advanced_section
         *
         * Returns the number of added fields
         *
         * @return int
         */
        public function advanced_section(): int {
                $map = array(
                        'activate_autocomplete'   => esc_html__( 'Autocomplete', 'multisite-language-switcher' ),
                        'image_url'               => esc_html__( 'Custom URL for flag-images', 'multisite-language-switcher' ),
                        'reference_user'          => esc_html__( 'Reference user', 'multisite-language-switcher' ),
                        'exclude_current_blog'    => esc_html__( 'Exclude blog', 'multisite-language-switcher' ),
                        'activate_content_import' => esc_html__( 'Content import', 'multisite-language-switcher' ),
                );

                return $this->add_settings_fields( $map, 'advanced_section' );
        }

        /**
         * Registers the fields in the rewrites_section
         *
         * Returns the number of added fields
         *
         * @return int
         */
        public function rewrites_section(): int {
                $map = array();
                foreach ( get_post_types( array( 'public' => true ), 'objects' ) as $key => $object ) {
                        /* translators: %s: post type label */
                        $format = __( '%s Slug', 'multisite-language-switcher' );

                        $map[ "rewrite_{$key}" ] = sprintf( $format, $object->label );
                }

                return $this->add_settings_fields( $map, 'rewrites_section' );
        }

        /**
         * @param array<string, string> $map
         * @param string                $section
         *
         * @return int
         */
        protected function add_settings_fields( array $map, string $section ): int {
                foreach ( $map as $id => $title ) {
                        add_settings_field( $id, $title, array( $this, $id ), __CLASS__, $section, array( 'label_for' => $id ) );
                }

                /**
                 * Lets you add your own field to the section
                 *
                 * @param string $page
                 * @param string $section
                 *
                 * @since 2.4.4
                 */
                do_action( self::MSLS_ACTION_PREFIX . $section, __CLASS__, $section );

                return count( $map );
        }

        /**
         * Shows the select-form-field 'blog_language'
         */
        public function blog_language(): void {
                $languages = $this->options->get_available_languages();
                $selected  = get_locale();

        // phpcs:ignore WordPress.Security.EscapeOutput
                echo ( new Select( 'blog_language', $languages, $selected ) )->render();
        }

        /**
         * Shows the select-form-field 'display'
         */
        public function display(): void {
        // phpcs:ignore WordPress.Security.EscapeOutput
                echo ( new Select( 'display', MslsLink::get_types_description(), strval( $this->options->display ) ) )->render();
        }

        /**
         * Shows the select-form-field 'admin_display'
         */
        public function admin_display(): void {
                $select = new Select(
                        'admin_display',
                        array(
                                MslsAdminIcon::TYPE_FLAG  => __( 'Flag', 'multisite-language-switcher' ),
                                MslsAdminIcon::TYPE_LABEL => __( 'Label', 'multisite-language-switcher' ),
                        ),
                        $this->options->get_icon_type()
                );

                echo $select->render(); // phpcs:ignore WordPress.Security.EscapeOutput
        }

        /**
         * Shows the select-form-field 'reference_user'
         */
        public function reference_user(): void {
                $users = array();

                foreach ( (array) apply_filters( 'msls_reference_users', $this->collection->get_users() ) as $user ) {
                        $users[ $user->ID ] = $user->user_nicename;
                }

                if ( count( $users ) > self::MAX_REFERENCE_USERS ) {
                        $users = array_slice( $users, 0, self::MAX_REFERENCE_USERS, true );

                        /* translators: %s: maximum number of users */
                        $format = __(
                                'Multisite Language Switcher: Collection for reference user has been truncated because it exceeded the maximum of %d users. Please, use the hook "msls_reference_users" to filter the result before!',
                                'multisite-language-switcher'
                        );

                        // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
                        trigger_error( esc_html( sprintf( $format, strval( self::MAX_REFERENCE_USERS ) ) ) );
                }

        // phpcs:ignore WordPress.Security.EscapeOutput
                echo ( new Select( 'reference_user', $users, strval( $this->options->reference_user ) ) )->render();
        }

        /**
         * The description for the current blog
         *
         * The language will be used ff there is no description.
         */
        public function description(): void {
        // phpcs:ignore WordPress.Security.EscapeOutput
                echo ( new Text( 'description', $this->options->description, 40 ) )->render();
        }

        /**
         * If the output in the_content is active you can set the priority too
         *
         * Default is 10. But may be there are other plugins active and you run into
         * trouble. So you can decide a higher (from 1) or a lower (to 100) priority
         * for the output
         */
        public function content_priority(): void {
                $temp     = array_merge( range( 1, 10 ), array( 20, 50, 100 ) );
                $arr      = array_combine( $temp, $temp );
                $selected = empty( $this->options->content_priority ) ? 10 : $this->options->content_priority;

        // phpcs:ignore WordPress.Security.EscapeOutput
                echo ( new Select( 'content_priority', $arr, strval( $selected ) ) )->render();
        }

        /**
         * Rewrites slugs for registered post types
         *
         * @param mixed $key
         */
        public function render_rewrite( $key ): void {
                $rewrite = get_post_type_object( $key )->rewrite;
                $value   = $rewrite['slug'] ?? '';

        // phpcs:ignore WordPress.Security.EscapeOutput
                echo ( new Text( "rewrite_{$key}", $value, 30, true ) )->render();
        }

        /**
         * Validates input before saving it
         *
         * @param array<string, mixed> $arr Values of the submitted form.
         *
         * @return array<string, mixed>
         */
        public function validate( array $arr ) {
                /**
                 * Returns custom filtered input array
                 *
                 * @param array $arr
                 *
                 * @since 1.0
                 */
                $arr = (array) apply_filters( 'msls_admin_validate', $arr );

                $arr['display'] = intval( $arr['display'] ?? 0 );
                if ( isset( $arr['image_url'] ) ) {
                        $arr['image_url'] = rtrim( esc_attr( $arr['image_url'] ), '/' );
                }

                return $arr;
        }

        /**
         * Filter which sets the global blog language
         *
         * @param string[] $arr
         *
         * @return string[]
         */
        public function set_blog_language( array $arr ) {
                if ( isset( $arr['blog_language'] ) ) {
                        $blog_language = ( 'en_US' === $arr['blog_language'] ) ? '' : $arr['blog_language'];
                        update_option( 'WPLANG', $blog_language );
                        unset( $arr['blog_language'] );
                }

                return $arr;
        }
}