LanguageDropdownField

Complexity

Total Complexity

28

Size/Duplication

Total Lines	113
Duplicated Lines	8.85 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
C	__construct()	10	59	17
A	Type()	0	4	1
A	getAttributes()	0	7	1

<?php

namespace SilverStripe\Translatable\Forms;

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Convert;
use SilverStripe\Forms\GroupedDropdownField;
use SilverStripe\i18n\i18n;
use SilverStripe\ORM\DataObject;
use SilverStripe\Translatable\Model\Translatable;

/**
 * An extension to dropdown field, pre-configured to list languages.
 * The languages already used in the site will be on top.
 *
 * @package translatable
 */
class LanguageDropdownField extends GroupedDropdownField
{
    private static $allowed_actions = array(

Consider using a different property name as you override a private property of the parent class.

The property $allowed_actions is not used and could be removed.

        'getLocaleForObject'
    );

    /**
     * Create a new LanguageDropdownField
     * @param string $name
     * @param string $title
     * @param array $excludeLocales List of locales that won't be included
     * @param string $translatingClass Name of the class with translated instances
     *               where to look for used languages
     * @param string $list Indicates the source language list.
     *               Can be either Common-English or Locale-English (default)
     */
    public function __construct(
        $name,
        $title,
        $excludeLocales = array(),
        $translatingClass = SiteTree::class,
        $list = 'Common-English',
        $instance = null
    ) {
        $usedLocalesWithTitle = Translatable::get_existing_content_languages($translatingClass);
        $usedLocalesWithTitle = array_diff_key($usedLocalesWithTitle, $excludeLocales);

        if ('Common-English' == $list) {
            $allLocalesWithTitle = i18n::getData()->getLanguages();
        } else {
            $allLocalesWithTitle = i18n::getData()->getLocales();
        }

        if (isset($allLocales[Translatable::default_locale()])) {

The variable $allLocales does not exist. Did you mean $allLocalesWithTitle?

            unset($allLocales[Translatable::default_locale()]);
        }

        // Limit to allowed locales if defined
        // Check for canTranslate() if an $instance is given
        $allowedLocales = Translatable::get_allowed_locales();
        foreach ($allLocalesWithTitle as $locale => $localeTitle) {
            if (($allowedLocales && !in_array($locale, $allowedLocales))

The expression $allowedLocales of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                || ($excludeLocales && in_array($locale, $excludeLocales))

The expression $excludeLocales of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                || ($usedLocalesWithTitle && array_key_exists($locale, $usedLocalesWithTitle))

The expression $usedLocalesWithTitle of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            ) {
                unset($allLocalesWithTitle[$locale]);
            }
        }
        // instance specific permissions
        foreach ($allLocalesWithTitle as $locale => $localeTitle) {

This code seems to be duplicated across your project.

            if ($instance && !$instance->canTranslate(null, $locale)) {
                unset($allLocalesWithTitle[$locale]);
            }
        }
        foreach ($usedLocalesWithTitle as $locale => $localeTitle) {

This code seems to be duplicated across your project.

            if ($instance && !$instance->canTranslate(null, $locale)) {
                unset($usedLocalesWithTitle[$locale]);
            }
        }

        // Sort by title (array value)
        asort($allLocalesWithTitle);

        if (count($usedLocalesWithTitle)) {
            asort($usedLocalesWithTitle);
            $source = array(
                _t('Form.LANGAVAIL', "Available languages") => $usedLocalesWithTitle,
                _t('Form.LANGAOTHER', "Other languages") => $allLocalesWithTitle
            );
        } else {
            $source = $allLocalesWithTitle;
        }

        parent::__construct($name, $title, $source);
    }

    public function Type()
    {
        return 'languagedropdown dropdown';
    }

    public function getAttributes()
    {
        return array_merge(
            parent::getAttributes(),
            array('data-locale-url' => $this->Link('getLocaleForObject'))
        );
    }

    /**
     * Get the locale for an object that has the Translatable extension.
     *
     * @return locale
     */
    public function getLocaleForObject()
    {
        $id = (int)$this->getRequest()->requestVar('id');
        $class = Convert::raw2sql($this->getRequest()->requestVar('class'));
        $locale = Translatable::get_current_locale();
        if ($id && $class && class_exists($class) && $class::has_extension(Translatable::class)) {
            // temporarily disable locale filter so that we won't filter out the object
            Translatable::disable_locale_filter();
            $object = DataObject::get_by_id($class, $id);

It seems like $class defined by \SilverStripe\Core\Convert::raw2sql($this->getRequest()->requestVar('class')) on line 115 can also be of type array; however, SilverStripe\ORM\DataObject::get_by_id() does only seem to accept string, maybe add an additional type check?

            Translatable::enable_locale_filter();
            if ($object) {
                $locale = $object->Locale;
            }
        }
        return $locale;
    }
}