Translatable::choose_site_locale() - Code Metrics - Inspection of "WIP: Upgrade for SS4" - silverstripe/silverstripe-translatable - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#264)

by Robbie
created 2017-08-11 00:13 UTC
Translatable::choose_site_locale() B

↳ Parent: Translatable
Complexity

Conditions	6
Paths	3
Size

Total Lines	18
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	18
rs	8.8571
c	0
b	0
f	0
cc	6
eloc	10
nc	3
nop	1
<?php

namespace SilverStripe\Translatable\Model;

use Exception;
use InvalidArgumentException;
use SilverStripe\CMS\Controllers\RootURLController;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\CMS\Model\VirtualPage;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Convert;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\HiddenField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\Tab;
use SilverStripe\i18n\i18n;
use SilverStripe\i18n\Data\Intl\IntlLocales;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DataQuery;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\FieldType\DBLocale;
use SilverStripe\ORM\Queries\SQLConditionGroup;
use SilverStripe\ORM\Queries\SQLSelect;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\Translatable\Forms\LanguageDropdownField;
use SilverStripe\Translatable\Model\Translatable;
use SilverStripe\Versioned\Versioned;




use SilverStripe\Translatable\Forms\TemporaryInlineFormAction;

/**
 * The Translatable decorator allows your DataObjects to have versions in different languages,
 * defining which fields are can be translated. Translatable can be applied
 * to any {@link DataObject} subclass, but is mostly used with {@link SiteTree}.
 * Translatable is compatible with the {@link Versioned} extension.
 * To avoid cluttering up the database-schema of the 99% of sites without multiple languages,
 * the translation-feature is disabled by default.
 *
 * Locales (e.g. 'en_US') are used in Translatable for identifying a record by language,
 * see section "Locales and Language Tags".
 *
 * <h2>Configuration</h2>
 *
 * The extension is automatically enabled for SiteTree and SiteConfig records,
 * if they can be found. Add the following to your config.yml in order to
 * register a custom class:
 *
 * <code>
 * MyClass:
 *   extensions:
 *     - SilverStripe\Translatable\Model\Translatable
 * </code>
 *
 * Make sure to rebuild the database through /dev/build after enabling translatable.
 * Use the correct {@link set_default_locale()} before building the database
 * for the first time, as this locale will be written on all new records.
 *
 * <h3>"Default" locales</h3>
 *
 * Important: If the "default language" of your site is not US-English (en_US),
 * please ensure to set the appropriate default language for
 * your content before building the database with Translatable enabled:
 * <code>
 * Translatable::set_default_locale(<locale>); // e.g. 'de_DE' or 'fr_FR'
 * </code>
 *
 * For the Translatable class, a "locale" consists of a language code plus a region
 * code separated by an underscore,
 * for example "de_AT" for German language ("de") in the region Austria ("AT").
 * See http://www.w3.org/International/articles/language-tags/ for a detailed description.
 *
 * <h2>Usage</h2>
 *
 * Getting a translation for an existing instance:
 * <code>
 * $translatedObj = Translatable::get_one_by_locale('MyObject', 'de_DE');
 * </code>
 *
 * Getting a translation for an existing instance:
 * <code>
 * $obj = DataObject::get_by_id('MyObject', 99); // original language
 * $translatedObj = $obj->getTranslation('de_DE');
 * </code>
 *
 * Getting translations through {@link Translatable::set_current_locale()}.
 * This is *not* a recommended approach, but sometimes inavoidable (e.g. for {@link Versioned} methods).
 * <code>
 * $origLocale = Translatable::get_current_locale();
 * Translatable::set_current_locale('de_DE');
 * $obj = Versioned::get_one_by_stage('MyObject', "ID = 99");
 * Translatable::set_current_locale($origLocale);
 * </code>
 *
 * Creating a translation:
 * <code>
 * $obj = new MyObject();
 * $translatedObj = $obj->createTranslation('de_DE');
 * </code>
 *
 * <h2>Usage for SiteTree</h2>
 *
 * Translatable can be used for subclasses of {@link SiteTree},
 * it is automatically configured if this class is foun.
 *
 * If a child page translation is requested without the parent
 * page already having a translation in this language, the extension
 * will recursively create translations up the tree.
 * Caution: The "URLSegment" property is enforced to be unique across
 * languages by auto-appending the language code at the end.
 * You'll need to ensure that the appropriate "reading language" is set
 * before showing links to other pages on a website through $_GET['locale'].
 * Pages in different languages can have different publication states
 * through the {@link Versioned} extension.
 *
 * Note: You can't get Children() for a parent page in a different language
 * through set_current_locale(). Get the translated parent first.
 *
 * <code>
 * // wrong
 * Translatable::set_current_locale('de_DE');
 * $englishParent->Children();
 * // right
 * $germanParent = $englishParent->getTranslation('de_DE');
 * $germanParent->Children();
 * </code>
 *
 * <h2>Translation groups</h2>
 *
 * Each translation can have one or more related pages in other languages.
 * This relation is optional, meaning you can
 * create translations which have no representation in the "default language".
 * This means you can have a french translation with a german original,
 * without either of them having a representation
 * in the default english language tree.
 * Caution: There is no versioning for translation groups,
 * meaning associating an object with a group will affect both stage and live records.
 *
 * SiteTree database table (abbreviated)
 * ^ ID ^ URLSegment ^ Title ^ Locale ^
 * | 1 | about-us | About us | en_US |
 * | 2 | ueber-uns | Über uns | de_DE |
 * | 3 | contact | Contact | en_US |
 *
 * SiteTree_translationgroups database table
 * ^ TranslationGroupID ^ OriginalID ^
 * | 99 | 1 |
 * | 99 | 2 |
 * | 199 | 3 |
 *
 * <h2>Character Sets</h2>
 *
 * Caution: Does not apply any character-set conversion, it is assumed that all content
 * is stored and represented in UTF-8 (Unicode). Please make sure your database and
 * HTML-templates adjust to this.
 *
 * <h2>Permissions</h2>
 *
 * Authors without administrative access need special permissions to edit locales other than
 * the default locale.
 *
 * - TRANSLATE_ALL: Translate into all locales
 * - Translate_<locale>: Translate a specific locale. Only available for all locales set in
 *   `Translatable::set_allowed_locales()`.
 *
 * Note: If user-specific view permissions are required, please overload `SiteTree->canView()`.
 *
 * <h2>Uninstalling/Disabling</h2>
 *
 * Disabling Translatable after creating translations will lead to all
 * pages being shown in the default sitetree regardless of their language.
 * It is advised to start with a new database after uninstalling Translatable,
 * or manually filter out translated objects through their "Locale" property
 * in the database.
 *
 * @see http://doc.silverstripe.org/doku.php?id=multilingualcontent
 *
 * @author Ingo Schommer <ingo (at) silverstripe (dot) com>
 * @author Michael Gall <michael (at) wakeless (dot) net>
 * @author Bernat Foj Capell <[email protected]>
 *
 * @package translatable
 */
class Translatable extends DataExtension implements PermissionProvider
{
    const QUERY_LOCALE_FILTER_ENABLED = 'Translatable.LocaleFilterEnabled';

    /**
     * The 'default' language.
     * @var string
     */
    protected static $default_locale = 'en_US';

    /**
     * The language in which we are reading dataobjects.
     *
     * @var string
     */
    protected static $current_locale = null;

    /**
     * A cached list of existing tables
     *
     * @var mixed
     */
    protected static $tableList = null;

    /**
     * An array of fields that can be translated.
     * @var array
     */
    protected $translatableFields = null;

    /**
     * A map of the field values of the original (untranslated) DataObject record
     * @var array
     */
    protected $original_values = null;

    /**
     * If this is set to TRUE then {@link augmentSQL()} will automatically add a filter
     * clause to limit queries to the current {@link get_current_locale()}. This camn be
     * disabled using {@link disable_locale_filter()}
     *
     * @var bool
     */
    protected static $locale_filter_enabled = true;

    /**
     * @var array All locales in which a translation can be created.
     * This limits the choice in the CMS language dropdown in the
     * "Translation" tab, as well as the language dropdown above
     * the CMS tree. If not set, it will default to showing all
     * common locales.
     */
    protected static $allowed_locales = null;

    /**
     * @var boolean Check other languages for URLSegment values (only applies to {@link SiteTree}).
     * Turn this off to handle language setting yourself, e.g. through language-specific subdomains
     * or URL path prefixes like "/en/mypage".
     */
    private static $enforce_global_unique_urls = true;


    /**
     * Exclude these fields from translation
     *
     * @var array
     * @config
     */
    private static $translate_excluded_fields = array(

        'ViewerGroups',
        'EditorGroups',
        'CanViewType',
        'CanEditType',
        'NewTransLang',
        'createtranslation'
    );

    /**
     * Reset static configuration variables to their default values
     */
    public static function reset()
    {
        self::enable_locale_filter();
        self::$default_locale = 'en_US';
        self::$current_locale = null;
        self::$allowed_locales = null;

    }

    /**
     * Choose the language the site is currently on.
     *
     * If $_GET['locale'] is currently set, then that locale will be used.
     * Otherwise the member preference (if logged
     * in) or default locale will be used.
     *
     * @todo Re-implement cookie and member option
     *
     * @param $langsAvailable array A numerical array of languages which are valid choices (optional)
     * @return string Selected language (also saved in $current_locale).
     */
    public static function choose_site_locale($langsAvailable = array())
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (self::$current_locale) {
            return self::$current_locale;
        }

        if ((isset($_REQUEST['locale']) && !$langsAvailable)

            || (isset($_REQUEST['locale'])
            && in_array($_REQUEST['locale'], $langsAvailable))
        ) {
            // get from request parameter
            self::set_current_locale($_REQUEST['locale']);
        } else {
            self::set_current_locale(self::default_locale());
        }

        return self::$current_locale;
    }

    /**
     * Get the current reading language.
     * This value has to be set before the schema is built with translatable enabled,
     * any changes after this can cause unintended side-effects.
     *
     * @return string
     */
    public static function default_locale()
    {
        return self::$default_locale;
    }

    /**
     * Set default language. Please set this value *before* creating
     * any database records (like pages), as this locale will be attached
     * to all new records.
     *
     * @param $locale String
     * @throws InvalidArgumentException if the locale is not valid
     */
    public static function set_default_locale($locale)
    {
        if ($locale && !self::isLocaleValid($locale)) {
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        $localeList = i18n::getData()->config()->locales;
        if (isset($localeList[$locale])) {
            self::$default_locale = $locale;
        } else {
            throw new InvalidArgumentException("Translatable::set_default_locale(): '$locale' is not a valid locale.");
        }
    }

    /**
     * Get the current reading language.
     * If its not chosen, call {@link choose_site_locale()}.
     *
     * @return string
     */
    public static function get_current_locale()
    {
        return (self::$current_locale) ? self::$current_locale : self::choose_site_locale();
    }

    /**
     * Set the reading language, either namespaced to 'site' (website content)
     * or 'cms' (management backend). This value is used in {@link augmentSQL()}
     * to "auto-filter" all SELECT queries by this language.
     * See {@link disable_locale_filter()} on how to override this behaviour temporarily.
     *
     * @param string $lang New reading language.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public static function set_current_locale($locale)
    {
        if ($locale && !self::isLocaleValid($locale)) {
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        self::$current_locale = $locale;
    }

    /**
     * Get a singleton instance of a class in the given language.
     * @param string $class The name of the class.
     * @param string $locale  The name of the language.
     * @param string $filter A filter to be inserted into the WHERE clause.
     * @param boolean $cache Use caching (default: false)
     * @param string $orderby A sort expression to be inserted into the ORDER BY clause.
     * @return DataObject
     * @throws InvalidArgumentException
     */
    public static function get_one_by_locale($class, $locale, $filter = '', $cache = false, $orderby = "")

    {
        if ($locale && !self::isLocaleValid($locale)) {
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        $orig = Translatable::get_current_locale();
        Translatable::set_current_locale($locale);
        $do = $class::get()
            ->where($filter)
            ->where(sprintf('"Locale" = \'%s\'', Convert::raw2sql($locale)))
            ->sort($orderby)
            ->First();
        Translatable::set_current_locale($orig);
        return $do;
    }

    /**
     * Get all the instances of the given class translated to the given language
     *
     * @param string $class The name of the class
     * @param string $locale  The name of the language
     * @param string $filter A filter to be inserted into the WHERE clause.
     * @param string $sort A sort expression to be inserted into the ORDER BY clause.
     * @param string $join A single join clause.  This can be used for filtering, only 1
     *               instance of each DataObject will be returned.
     * @param string $limit A limit expression to be inserted into the LIMIT clause.
     * @param string $containerClass The container class to return the results in.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $having A filter to be inserted into the HAVING clause.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return mixed The objects matching the conditions.
     */
    public static function get_by_locale($class, $locale, $filter = '', $sort = '', $join = "", $limit = "")
    {
        if ($locale && !self::isLocaleValid($locale)) {
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        $oldLang = self::get_current_locale();
        self::set_current_locale($locale);
        $result = $class::get();
        if ($filter) {
            $result = $result->where($filter);
        }
        if ($sort) {
            $result = $result->sort($sort);
        }
        if ($join) {
            $result = $result->leftJoin($join);
        }
        if ($limit) {
            $result = $result->limit($limit);
        }
        self::set_current_locale($oldLang);

        return $result;
    }

    /**
     * @return bool
     */
    public static function locale_filter_enabled()
    {
        return self::$locale_filter_enabled;
    }

    /**
     * Enables automatic filtering by locale. This is normally called after is has been
     * disabled using {@link disable_locale_filter()}.
     *
     * @param $enabled (default true), if false this call is a no-op - see {@link disable_locale_filter()}
     */
    public static function enable_locale_filter($enabled = true)
    {
        if ($enabled) {
            self::$locale_filter_enabled = true;
        }
    }

    /**
     * Disables automatic locale filtering in {@link augmentSQL()}. This can be re-enabled
     * using {@link enable_locale_filter()}.
     *
     * Note that all places that disable the locale filter should generally re-enable it
     * before returning from that block of code (function, etc). This is made easier by
     * using the following pattern:
     *
     * <code>
     * $enabled = Translatable::disable_locale_filter();
     * // do some work here
     * Translatable::enable_locale_filter($enabled);
     * return $whateverYouNeedTO;
     * </code>
     *
     * By using this pattern, the call to enable the filter will not re-enable it if it
     * was not enabled initially.  That will keep code that called your function from
     * breaking if it had already disabled the locale filter since it will not expect
     * calling your function to change the global state by re-enabling the filter.
     *
     * @return boolean true if the locale filter was enabled, false if it was not
     */
    public static function disable_locale_filter()
    {
        $enabled = self::$locale_filter_enabled;
        self::$locale_filter_enabled = false;
        return $enabled;
    }

    /**
     * Gets all translations for this specific page.
     * Doesn't include the language of the current record.
     *
     * @return array Numeric array of all locales, sorted alphabetically.
     */
    public function getTranslatedLocales()
    {
        $langs = array();

        $baseDataClass = DataObject::getSchema()->baseDataTable(get_class($this->owner)); //Base Class
        $translationGroupClass = $baseDataClass . "_translationgroups";
        if ($this->owner->hasExtension(Versioned::class)  && Versioned::get_stage() == "Live") {
            $baseDataClass = $baseDataClass . "_Live";
        }

        $translationGroupID = $this->getTranslationGroup();
        if (is_numeric($translationGroupID)) {
            $query = new SQLSelect(
                'DISTINCT "Locale"',
                sprintf(
                    '"%s" LEFT JOIN "%s" ON "%s"."OriginalID" = "%s"."ID"',
                    $baseDataClass,
                    $translationGroupClass,
                    $translationGroupClass,
                    $baseDataClass
                ), // from
                sprintf(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    '"%s"."TranslationGroupID" = %d AND "%s"."Locale" != \'%s\'',
                    $translationGroupClass,
                    $translationGroupID,
                    $baseDataClass,
                    $this->owner->Locale
                ) // where
            );
            $langs = $query->execute()->column();
        }
        if ($langs) {

            $langCodes = array_values($langs);
            sort($langCodes);
            return $langCodes;
        } else {
            return array();
        };
    }

    /**
     * Gets all locales that a member can access
     * as defined by {@link $allowed_locales}
     * and {@link canTranslate()}.
     * If {@link $allowed_locales} is not set and
     * the user has the `TRANSLATE_ALL` permission,
     * the method will return all available locales in the system.
     *
     * @param Member $member
     * @return array Map of locales
     */
    public function getAllowedLocalesForMember($member)
    {
        $locales = self::get_allowed_locales();
        if (!$locales) {

            $locales = i18n::get_common_locales();

        }
        if ($locales) {
            foreach ($locales as $k => $locale) {
                if (!$this->canTranslate($member, $locale)) {
                    unset($locales[$k]);
                }
            }
        }

        return $locales;
    }

    public function setOwner($owner, $ownerBaseClass = null)
    {
        parent::setOwner($owner, $ownerBaseClass);

        // setting translatable fields by inspecting owner - this should really be done in the constructor
        if ($this->owner && $this->translatableFields === null) {
            $this->translatableFields = array_merge(
                array_keys(DataObject::getSchema()->databaseFields($this->owner)),
                array_keys($this->owner->hasMany()),
                array_keys($this->owner->manyMany())
            );
            foreach (array_keys($this->owner->hasOne()) as $fieldname) {
                $this->translatableFields[] = $fieldname.'ID';
            }
        }
    }

    public static function get_extra_config($class, $extensionClass, $args = null)

    {
        $config = array();
        $config['defaults'] = array(
            "Locale" => Translatable::default_locale() // as an overloaded getter as well: getLang()
        );
        $config['db'] = array(
            "Locale" => DBLocale::class,
            //"TranslationMasterID" => "Int" // optional relation to a "translation master"

        );
        return $config;
    }

    /**
     * Check if a given SQLSelect filters on the Locale field
     *
     * @param SQLSelect $query
     * @return boolean
     */
    protected function filtersOnLocale($query)
    {
        foreach ($query->getWhere() as $condition) {
            // Compat for 3.1/3.2 where syntax
            if (is_array($condition)) {
                // In >=3.2 each $condition is a single length array('condition' => array('params'))
                reset($condition);
                $condition = key($condition);
            }

            // >=3.2 allows conditions to be expressed as evaluatable objects
            if (interface_exists(SQLConditionGroup::class) && ($condition instanceof SQLConditionGroup)) {
                $condition = $condition->conditionSQL($params);
            }

            if (preg_match('/("|\'|`)Locale("|\'|`)/', $condition)) {
                return true;
            }
        }
    }

    /**
     * Changes any SELECT query thats not filtering on an ID
     * to limit by the current language defined in {@link get_current_locale()}.
     * It falls back to "Locale='' OR Lang IS NULL" and assumes that
     * this implies querying for the default language.
     *
     * Use {@link disable_locale_filter()} to temporarily disable this "auto-filtering".
     */
    public function augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)
    {
        // If the record is saved (and not a singleton), and has a locale,
        // limit the current call to its locale. This fixes a lot of problems
        // with other extensions like Versioned
        if ($this->owner->ID && !empty($this->owner->Locale)) {
            $locale = $this->owner->Locale;
        } else {
            $locale = Translatable::get_current_locale();
        }

        $baseTable = DataObject::getSchema()->baseDataTable(get_class($this->owner));
        if ($locale
            // unless the filter has been temporarily disabled
            && self::locale_filter_enabled()
            // or it was disabled when the DataQuery was created
            && $dataQuery->getQueryParam(self::QUERY_LOCALE_FILTER_ENABLED)
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
            // DataObject::get_by_id() should work independently of language
            && !$query->filtersOnID()
            // the query contains this table
            // @todo Isn't this always the case?!
            && array_search($baseTable, array_keys($query->getFrom())) !== false
            //&& !$query->filtersOnFK()

        ) {
            // Or we're already filtering by Lang (either from an earlier augmentSQL()
            // call or through custom SQL filters)
            $filtersOnLocale = array_filter($query->getWhere(), function ($predicates) {
                foreach ($predicates as $predicate => $params) {
                    if (preg_match('/("|\'|`)Locale("|\'|`)/', $predicate)) {
                        return true;
                    }
                }
            });
            if (!$filtersOnLocale) {

                $qry = sprintf('"%s"."Locale" = \'%s\'', $baseTable, Convert::raw2sql($locale));
                $query->addWhere($qry);
            }
        }
    }

    public function augmentDataQueryCreation(SQLSelect $sqlQuery, DataQuery $dataQuery)

    {
        $enabled = self::locale_filter_enabled();
        $dataQuery->setQueryParam(self::QUERY_LOCALE_FILTER_ENABLED, $enabled);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Create <table>_translation database table to enable
     * tracking of "translation groups" in which each related
     * translation of an object acts as a sibling, rather than
     * a parent->child relation.
     */
    public function augmentDatabase()
    {
        $baseDataClass = DataObject::getSchema()->baseDataClass(get_class($this->owner));
        if (get_class($this->owner) != $baseDataClass) {
            return;
        }
        $baseDataTable = DataObject::getSchema()->baseDataTable(get_class($this->owner));

        $fields = [
            'OriginalID' => 'Int',
            'TranslationGroupID' => 'Int',
        ];
        $indexes = [
            'OriginalID' => ['type' => 'index', 'columns' => ['OriginalID']],
            'TranslationGroupID' => ['type' => 'index', 'columns' => ['TranslationGroupID']]
        ];

        // Add new tables if required
        DB::get_schema()->requireTable("{$baseDataTable}_translationgroups", $fields, $indexes);

        // Remove 2.2 style tables
        DB::get_schema()->dontRequireTable("{$baseDataTable}_lang");
        if ($this->owner->hasExtension(Versioned::class)) {
            DB::get_schema()->dontRequireTable("{$baseDataTable}_lang_Live");
            DB::get_schema()->dontRequireTable("{$baseDataTable}_lang_versions");
        }
    }

    /**
     * @todo Find more appropriate place to hook into database building
     */
    public function requireDefaultRecords()
    {
        // @todo This relies on the Locale attribute being on the base data class, and not any subclasses
        $baseDataClass = DataObject::getSchema()->baseDataClass(get_class($this->owner));
        if (get_class($this->owner) != $baseDataClass) {
            return;
        }
        $baseDataTable = DataObject::getSchema()->baseDataTable(get_class($this->owner));

        // Permissions: If a group doesn't have any specific TRANSLATE_<locale> edit rights,
        // but has CMS_ACCESS_CMSMain (general CMS access), then assign TRANSLATE_ALL permissions as a default.
        // Auto-setting permissions based on these intransparent criteria is a bit hacky,
        // but unavoidable until we can determine when a certain permission code was made available first
        // (see http://open.silverstripe.org/ticket/4940)
        $groups = Permission::get_groups_by_permission(array(
            'CMS_ACCESS_CMSMain',
            'CMS_ACCESS_LeftAndMain',
            'ADMIN'
        ));
        if ($groups) {
            foreach ($groups as $group) {
                $codes = $group->Permissions()->column('Code');
                $hasTranslationCode = false;
                foreach ($codes as $code) {
                    if (preg_match('/^TRANSLATE_/', $code)) {
                        $hasTranslationCode = true;
                    }
                }
                // Only add the code if no more restrictive code exists
                if (!$hasTranslationCode) {
                    Permission::grant($group->ID, 'TRANSLATE_ALL');
                }
            }
        }

        // If the Translatable extension was added after the first records were already
        // created in the database, make sure to update the Locale property if
        // if wasn't set before
        $idsWithoutLocale = DB::query(sprintf(
            'SELECT "ID" FROM "%s" WHERE "Locale" IS NULL OR "Locale" = \'\'',
            $baseDataTable
        ))->column();
        if (!$idsWithoutLocale) {
            return;
        }

        if (class_exists(SiteTree::class) && get_class($this->owner) == SiteTree::class) {
            foreach (array('Stage', 'Live') as $stage) {
                foreach ($idsWithoutLocale as $id) {
                    $obj = Versioned::get_one_by_stage(
                        get_class($this->owner),
                        $stage,
                        sprintf('"SiteTree"."ID" = %d', $id)
                    );
                    if (!$obj || $obj->ObsoleteClassName) {

                        continue;
                    }

                    $obj->Locale = Translatable::default_locale();

                    $oldMode = Versioned::get_reading_mode();
                    Versioned::set_stage($stage);
                    $obj->writeWithoutVersion();
                    Versioned::set_reading_mode($oldMode);

                    $obj->addTranslationGroup($obj->ID);
                    $obj->destroy();
                    unset($obj);
                }
            }
        } else {
            foreach ($idsWithoutLocale as $id) {
                $obj = DataObject::get_by_id(get_class($this->owner), $id);
                if (!$obj || $obj->ObsoleteClassName) {

                    continue;
                }

                $obj->Locale = Translatable::default_locale();
                $obj->write();
                $obj->addTranslationGroup($obj->ID);
                $obj->destroy();
                unset($obj);
            }
        }
        DB::alteration_message(sprintf(
            "Added default locale '%s' to table %s",
            "changed",
            Translatable::default_locale(),
            get_class($this->owner)
        ));
    }

    /**
     * Add a record to a "translation group",
     * so its relationship to other translations
     * based off the same object can be determined later on.
     * See class header for further comments.
     *
     * @param int $originalID Either the primary key of the record this new translation is based on,
     *  or the primary key of this record, to create a new translation group
     * @param boolean $overwrite
     */
    public function addTranslationGroup($originalID, $overwrite = false)
    {
        if (!$this->owner->exists()) {
            return false;
        }

        $baseDataClass = DataObject::getSchema()->baseDataTable(get_class($this->owner));
        $existingGroupID = $this->getTranslationGroup($originalID);


        // Remove any existing groups if overwrite flag is set
        if ($existingGroupID && $overwrite) {

            $sql = sprintf(
                'DELETE FROM "%s_translationgroups" WHERE "TranslationGroupID" = %d AND "OriginalID" = %d',
                $baseDataClass,
                $existingGroupID,
                $this->owner->ID
            );
            DB::query($sql);
            $existingGroupID = null;
        }

        // Add to group (only if not in existing group or $overwrite flag is set)
        if (!$existingGroupID) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $sql = sprintf(
                'INSERT INTO "%s_translationgroups" ("TranslationGroupID","OriginalID") VALUES (%d,%d)',
                $baseDataClass,
                $originalID,
                $this->owner->ID
            );
            DB::query($sql);
        }
    }

    /**
     * Gets the translation group for the current record.
     * This ID might equal the record ID, but doesn't have to -
     * it just points to one "original" record in the list.
     *
     * @return int Numeric ID of the translationgroup in the <classname>_translationgroup table
     */
    public function getTranslationGroup()
    {
        if (!$this->owner->exists()) {
            return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        $baseDataClass = DataObject::getSchema()->baseDataTable(get_class($this->owner));
        return DB::query(
            sprintf(
                'SELECT "TranslationGroupID" FROM "%s_translationgroups" WHERE "OriginalID" = %d',
                $baseDataClass,
                $this->owner->ID
            )
        )->value();
    }

    /**
     * Removes a record from the translation group lookup table.
     * Makes no assumptions on other records in the group - meaning
     * if this happens to be the last record assigned to the group,
     * this group ceases to exist.
     */
    public function removeTranslationGroup()
    {
        $baseDataClass = DataObject::getSchema()->baseDataTable(get_class($this->owner));
        DB::query(
            sprintf('DELETE FROM "%s_translationgroups" WHERE "OriginalID" = %d', $baseDataClass, $this->owner->ID)
        );
    }

    /**
     * Determine if a table needs Versioned support
     * This is called at db/build time
     *
     * @param string $table Table name
     * @return boolean
     */
    public function isVersionedTable($table)

    {
        return false;
    }

    /**
     * Note: The bulk of logic is in ModelAsController->getNestedController()
     * and ContentController->handleRequest()
     */
    public function contentcontrollerInit($controller)
    {
        $controller->Locale = Translatable::choose_site_locale();
    }

    public function modelascontrollerInit($controller)

    {
        //$this->contentcontrollerInit($controller);

    }

    public function initgetEditForm($controller)
    {
        $this->contentcontrollerInit($controller);
    }

    /**
     * Recursively creates translations for parent pages in this language
     * if they aren't existing already. This is a necessity to make
     * nested pages accessible in a translated CMS page tree.
     * It would be more userfriendly to grey out untranslated pages,
     * but this involves complicated special cases in AllChildrenIncludingDeleted().
     *
     * {@link SiteTree->onBeforeWrite()} will ensure that each translation will get
     * a unique URL across languages, by means of {@link SiteTree::get_by_link()}
     * and {@link Translatable->alternateGetByURL()}.
     */
    public function onBeforeWrite()
    {
        // If language is not set explicitly, set it to current_locale.
        // This might be a bit overzealous in assuming the language
        // of the content, as a "single language" website might be expanded
        // later on. See {@link requireDefaultRecords()} for batch setting
        // of empty Locale columns on each dev/build call.
        if (!$this->owner->Locale) {
            $this->owner->Locale = Translatable::get_current_locale();
        }

        // Specific logic for SiteTree subclasses.
        // If page has untranslated parents, create (unpublished) translations
        // of those as well to avoid having inaccessible children in the sitetree.
        // Caution: This logic is very sensitve to infinite loops when translation status isn't determined properly
        // If a parent for the newly written translation was existing before this
        // onBeforeWrite() call, it will already have been linked correctly through createTranslation()
        if (class_exists(SiteTree::class)
            && $this->owner->hasField('ParentID')
            && $this->owner instanceof SiteTree
        ) {
            if (!$this->owner->ID
                && $this->owner->ParentID
                && !$this->owner->Parent()->hasTranslation($this->owner->Locale)
            ) {
                $parentTranslation = $this->owner->Parent()->createTranslation($this->owner->Locale);
                $this->owner->ParentID = $parentTranslation->ID;
            }
        }

        // Has to be limited to the default locale, the assumption is that the "page type"
        // dropdown is readonly on all translations.
        if ($this->owner->ID && $this->owner->Locale == Translatable::default_locale()) {
            $changedFields = $this->owner->getChangedFields();
            $changed = isset($changedFields['ClassName']);

            if ($changed && $this->owner->hasExtension(Versioned::class)) {
                // this is required because when publishing a node the before/after
                // values of $changedFields['ClassName'] will be the same because
                // the record was already written to the stage/draft table and thus
                // the record was updated, and then publish('Stage', 'Live') is
                // called, which uses forceChange, which will make all the fields
                // act as though they are changed, although the before/after values
                // will be the same
                // So, we load one from the current stage and test against it
                // This is to prevent the overhead of writing all translations when
                // the class didn't actually change.
                $baseDataClass = DataObject::getSchema()->baseDataClass(get_class($this->owner));
                $currentStage = Versioned::get_stage();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                $fresh = Versioned::get_one_by_stage(
                    $baseDataClass,
                    Versioned::get_stage(),
                    '"ID" = ' . $this->owner->ID,
                    null
                );
                if ($fresh) {
                    $changed = $changedFields['ClassName']['after'] != $fresh->ClassName;
                }
            }

            if ($changed) {
                $this->owner->ClassName = $changedFields['ClassName']['before'];
                $translations = $this->owner->getTranslations();
                $this->owner->ClassName = $changedFields['ClassName']['after'];
                if ($translations) {
                    foreach ($translations as $translation) {
                        $translation->setClassName($this->owner->ClassName);
                        $translation = $translation->newClassInstance($translation->ClassName);
                        $translation->populateDefaults();
                        $translation->forceChange();
                        $translation->write();
                    }
                }
            }
        }

        // see onAfterWrite()
        if (!$this->owner->ID) {
            $this->owner->_TranslatableIsNewRecord = true;

        }
    }

    public function onAfterWrite()
    {
        // hacky way to determine if the record was created in the database,
        // or just updated
        if ($this->owner->_TranslatableIsNewRecord) {

            // this would kick in for all new records which are NOT
            // created through createTranslation(), meaning they don't
            // have the translation group automatically set.
            $translationGroupID = $this->getTranslationGroup();
            if (!$translationGroupID) {
                $this->addTranslationGroup(
                    $this->owner->_TranslationGroupID ? $this->owner->_TranslationGroupID : $this->owner->ID
                );
            }
            unset($this->owner->_TranslatableIsNewRecord);
            unset($this->owner->_TranslationGroupID);
        }
    }

    /**
     * Remove the record from the translation group mapping.
     */
    public function onBeforeDelete()
    {
        // @todo Coupling to Versioned, we need to avoid removing
        // translation groups if records are just deleted from a stage
        // (="unpublished"). Ideally the translation group tables would
        // be specific to different Versioned changes, making this restriction unnecessary.
        // This will produce orphaned translation group records for SiteTree subclasses.
        if (!$this->owner->hasExtension(Versioned::class)) {
            $this->removeTranslationGroup();
        }

        parent::onBeforeDelete();
    }

    /**
     * Attempt to get the page for a link in the default language that has been translated.
     *
     * @param string $URLSegment
     * @param int|null $parentID
     * @return SiteTree
     */
    public function alternateGetByLink($URLSegment, $parentID)
    {
        // If the parentID value has come from a translated page,
        // then we need to find the corresponding parentID value
        // in the default Locale.
        if (is_int($parentID)
            && $parentID > 0
            && ($parent = DataObject::get_by_id(SiteTree::class, $parentID))
            && ($parent->isTranslation())
        ) {
            $parentID = $parent->getTranslationGroup();
        }

        // Find the locale language-independent of the page
        self::disable_locale_filter();
        $default = SiteTree::get()->where(sprintf(
            '"URLSegment" = \'%s\'%s',
            Convert::raw2sql($URLSegment),
            (is_int($parentID) ? " AND \"ParentID\" = $parentID" : null)
        ))->First();
        self::enable_locale_filter();

        return $default;
    }

    //-----------------------------------------------------------------------------------------------//

    public function applyTranslatableFieldsUpdate($fields, $type)
    {
        if (method_exists($this, $type)) {
            $this->$type($fields);
        } else {
            throw new InvalidArgumentException("Method $type does not exist on object of type ".  get_class($this));
        }
    }

    /**
     * If the record is not shown in the default language, this method
     * will try to autoselect a master language which is shown alongside
     * the normal formfields as a readonly representation.
     * This gives translators a powerful tool for their translation workflow
     * without leaving the translated page interface.
     * Translatable also adds a new tab "Translation" which shows existing
     * translations, as well as a formaction to create new translations based
     * on a dropdown with available languages.
     *
     * This method can be called multiple times on the same FieldList
     * because it checks which fields have already been added or modified.
     *
     * @todo This is specific to SiteTree and CMSMain
     * @todo Implement a special "translation mode" which triggers display of the
     * readonly fields, so you can translation INTO the "default language" while
     * seeing readonly fields as well.
     */
    public function updateCMSFields(FieldList $fields)
    {
        $this->addTranslatableFields($fields);

        // Show a dropdown to create a new translation.
        // This action is possible both when showing the "default language"
        // and a translation. Include the current locale (record might not be saved yet).
        $alreadyTranslatedLocales = $this->getTranslatedLocales();
        $alreadyTranslatedLocales[$this->owner->Locale] = $this->owner->Locale;
        $alreadyTranslatedLocales = array_combine($alreadyTranslatedLocales, $alreadyTranslatedLocales);

        // Check if fields exist already to avoid adding them twice on repeat invocations
        $tab = $fields->findOrMakeTab('Root.Translations', _t('Translatable.TRANSLATIONS', 'Translations'));
        if (!$tab->fieldByName('CreateTransHeader')) {
            $tab->push(new HeaderField(
                'CreateTransHeader',
                _t('Translatable.CREATE', 'Create new translation'),
                2
            ));
        }
        if (!$tab->fieldByName('NewTransLang') && !$tab->fieldByName('AllTransCreated')) {
            $langDropdown = LanguageDropdownField::create(
                "NewTransLang",
                _t('Translatable.NEWLANGUAGE', 'New language'),
                $alreadyTranslatedLocales,
                SiteTree::class,
                'Locale-English',
                $this->owner
            )->addExtraClass('languageDropdown no-change-track');
            $tab->push($langDropdown);
            $canAddLocale = (count($langDropdown->getSource()) > 0);

            if ($canAddLocale) {
                // Only add create button if new languages are available
                $tab->push(
                    $createButton = TemporaryInlineFormAction::create(
                        'createtranslation',
                        _t('Translatable.CREATEBUTTON', 'Create')
                    )->addExtraClass('createTranslationButton')
                );
            } else {
                $tab->removeByName('NewTransLang');
                $tab->push(new LiteralField(
                    'AllTransCreated',
                    _t('Translatable.ALLCREATED', 'All allowed translations have been created.')
                ));
            }
        }
        if ($alreadyTranslatedLocales) {

            if (!$tab->fieldByName('ExistingTransHeader')) {
                $tab->push(new HeaderField(
                    'ExistingTransHeader',
                    _t('Translatable.EXISTING', 'Existing translations'),
                    3
                ));
                if (!$tab->fieldByName('existingtrans')) {
                    $existingTransHTML = '<ul>';
                    if ($existingTranslations = $this->getTranslations()) {
                        foreach ($existingTranslations as $existingTranslation) {
                            if ($existingTranslation && $existingTranslation->hasMethod('CMSEditLink')) {
                                $existingTransHTML .= sprintf(
                                    '<li><a href="%s">%s</a></li>',
                                    Controller::join_links(
                                        $existingTranslation->CMSEditLink(),
                                        '?Locale=' . $existingTranslation->Locale
                                    ),
                                    i18n::getData()->localeName($existingTranslation->Locale)
                                );
                            }
                        }
                    }
                    $existingTransHTML .= '</ul>';
                    $tab->push(new LiteralField('existingtrans', $existingTransHTML));
                }
            }
        }
    }

    public function updateSettingsFields(&$fields)
    {
        $this->addTranslatableFields($fields);
    }

    public function updateRelativeLink(&$base, &$action)

    {
        // Prevent home pages for non-default locales having their urlsegments
        // reduced to the site root.
        if ($base === null && $this->owner->Locale != self::default_locale()) {
            $base = $this->owner->URLSegment;
        }
    }

    /**
     * This method can be called multiple times on the same FieldList
     * because it checks which fields have already been added or modified.
     */
    protected function addTranslatableFields(&$fields)
    {
        // used in LeftAndMain->init() to set language state when reading/writing record
        $fields->push(new HiddenField("Locale", "Locale", $this->owner->Locale));

        // Don't apply these modifications for normal DataObjects - they rely on CMSMain logic
        if (!class_exists(SiteTree::class)) {
            return;
        }
        if (!($this->owner instanceof SiteTree)) {
            return;
        }

        // Don't allow translation of virtual pages because of data inconsistencies (see #5000)
        if (class_exists(VirtualPage::class)) {
            $excludedPageTypes = array(VirtualPage::class);
            foreach ($excludedPageTypes as $excludedPageType) {
                if (is_a($this->owner, $excludedPageType)) {
                    return;
                }
            }
        }

        // Get excluded fields from translation
        $excludeFields = $this->owner->config()->translate_excluded_fields;

        // if a language other than default language is used, we're in "translation mode",
        // hence have to modify the original fields
        $baseClass = get_class($this->owner);
        while (($p = get_parent_class($baseClass)) != DataObject::class) {
            $baseClass = $p;
        }

        // try to get the record in "default language"
        $originalRecord = $this->owner->getTranslation(Translatable::default_locale());
        // if no translation in "default language", fall back to first translation
        if (!$originalRecord) {
            $translations = $this->owner->getTranslations();
            $originalRecord = ($translations) ? $translations->First() : null;
        }

        $isTranslationMode = $this->owner->Locale != Translatable::default_locale();

        if ($originalRecord && $isTranslationMode) {
            // Remove parent page dropdown
            $fields->removeByName("ParentType");
            $fields->removeByName("ParentID");

            $translatableFieldNames = $this->getTranslatableFields();
            $allDataFields = $fields->dataFields();

            $transformation = new Translatable\Transformation($originalRecord);

            // iterate through sequential list of all datafields in fieldset
            // (fields are object references, so we can replace them with the translatable CompositeField)
            foreach ($allDataFields as $dataField) {
                // Transformation is a visual helper for CMS authors, so ignore hidden fields
                if ($dataField instanceof HiddenField) {
                    continue;
                }
                // Some fields are explicitly excluded from transformation
                if (in_array($dataField->getName(), $excludeFields)) {
                    continue;
                }
                // Readonly field which has been added previously
                if (preg_match('/_original$/', $dataField->getName())) {
                    continue;
                }
                // Field already has been transformed
                if (isset($allDataFields[$dataField->getName() . '_original'])) {
                    continue;
                }
                // CheckboxField which is already transformed
                if (preg_match('/class=\"originalvalue\"/', $dataField->Title())) {
                    continue;
                }

                if (in_array($dataField->getName(), $translatableFieldNames)) {
                    // if the field is translatable, perform transformation
                    $fields->replaceField($dataField->getName(), $transformation->transformFormField($dataField));
                } elseif (!$dataField->isReadonly()) {
                    // else field shouldn't be editable in translation-mode, make readonly
                    $fields->replaceField($dataField->getName(), $dataField->performReadonlyTransformation());
                }
            }
        } elseif ($this->owner->isNew()) {
            $fields->addFieldsToTab(
                'Root',
                new Tab(
                    _t('Translatable.TRANSLATIONS', 'Translations'),
                    new LiteralField(
                        'SaveBeforeCreatingTranslationNote',
                        sprintf(
                            '<p class="message">%s</p>',
                            _t('Translatable.NOTICENEWPAGE', 'Please save this page before creating a translation')
                        )
                    )
                )
            );
        }
    }

    /**
     * Get the names of all translatable fields on this class as a numeric array.
     * @todo Integrate with blacklist once branches/translatable is merged back.
     *
     * @return array
     */
    public function getTranslatableFields()
    {
        return $this->translatableFields;
    }

    /**
     * Return the base table - the class that directly extends DataObject.
     * @return string
     */
    public function baseTable($stage = null)
    {
        $baseTable = DataObject::getSchema()->baseDataTable(get_class($this->owner));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        return (!$stage || $stage == $this->defaultStage) ? $baseClass : $baseClass . "_$stage";
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function extendWithSuffix($table)
    {
        return $table;
    }

    /**
     * Gets all related translations for the current object,
     * excluding itself. See {@link getTranslation()} to retrieve
     * a single translated object.
     *
     * Getter with $stage parameter is specific to {@link Versioned} extension,
     * mostly used for {@link SiteTree} subclasses.
     *
     * @param string $locale
     * @param string $stage
     * @return DataObjectSet
     */
    public function getTranslations($locale = null, $stage = null)
    {
        if ($locale && !$this->isLocaleValid($locale)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        if (!$this->owner->exists()) {
            return new ArrayList();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        // HACK need to disable language filtering in augmentSQL(),
        // as we purposely want to get different language
        // also save state of locale-filter, revert to this state at the
        // end of this method
        $localeFilterEnabled = false;
        if (self::locale_filter_enabled()) {
            self::disable_locale_filter();
            $localeFilterEnabled = true;
        }

        $translationGroupID = $this->getTranslationGroup();

        $baseDataClass = DataObject::getSchema()->baseDataClass(get_class($this->owner));
        $baseDataTable = DataObject::getSchema()->tableName($baseDataClass);

        $filter = sprintf('"%s_translationgroups"."TranslationGroupID" = %d', $baseDataTable, $translationGroupID);
        if ($locale) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $filter .= sprintf(' AND "%s"."Locale" = \'%s\'', $baseDataTable, Convert::raw2sql($locale));
        } else {
            // exclude the language of the current owner
            $filter .= sprintf(' AND "%s"."Locale" != \'%s\'', $baseDataTable, $this->owner->Locale);
        }
        $currentStage = Versioned::get_stage();
        $joinOnClause = sprintf('"%s_translationgroups"."OriginalID" = "%s"."ID"', $baseDataTable, $baseDataTable);
        if ($this->owner->hasExtension(Versioned::class)) {
            if ($stage) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                Versioned::set_stage($stage);
            }
            $translations = Versioned::get_by_stage(
                $baseDataClass,
                Versioned::get_stage(),
                $filter,
                null
            )->leftJoin("{$baseDataTable}_translationgroups", $joinOnClause);
            if ($stage) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                Versioned::set_stage($currentStage);
            }
        } else {
            $class = get_class($this->owner);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $translations = $baseDataClass::get()
                ->where($filter)
                ->leftJoin("{$baseDataTable}_translationgroups", $joinOnClause);
        }

        // only re-enable locale-filter if it was enabled at the beginning of this method
        if ($localeFilterEnabled) {
            self::enable_locale_filter();
        }

        return $translations;
    }

    /**
     * Gets an existing translation based on the language code.
     * Use {@link hasTranslation()} as a quicker alternative to check
     * for an existing translation without getting the actual object.
     *
     * @param String $locale
     * @return DataObject Translated object
     */
    public function getTranslation($locale, $stage = null)
    {
        if ($locale && !$this->isLocaleValid($locale)) {
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        $translations = $this->getTranslations($locale, $stage);
        return ($translations) ? $translations->First() : null;
    }

    /**
     * When the SiteConfig object is automatically instantiated, we should ensure that
     * 1. All SiteConfig objects belong to the same group
     * 2. Defaults are correctly initiated from the base object
     * 3. The creation mechanism uses the createTranslation function in order to be consistent
     * This function ensures that any already created "vanilla" SiteConfig object is populated
     * correctly with translated values.
     * This function DOES populate the ID field with the newly created object ID
     * @see SiteConfig
     */
    protected function populateSiteConfigDefaults()
    {
        $table = DataObject::getSchema()->tableName(get_class($this->owner));

        // Work-around for population of defaults during database initialisation.
        // When the database is being setup singleton('SiteConfig') is called.
        if (!DB::get_schema()->hasTable($table)) {
            return;
        }
        if (!DB::get_schema()->hasField($table, 'Locale')) {
            return;
        }
        if (DB::get_schema()->isSchemaUpdating()) {
            return;
        }

        // Find the best base translation for SiteConfig
        $enabled = Translatable::locale_filter_enabled();
        Translatable::disable_locale_filter();
        $existingConfig = SiteConfig::get()->filter(array(
            'Locale' => Translatable::default_locale()
        ))->first();
        if (!$existingConfig) {
            $existingConfig = SiteConfig::get()->first();
        }
        if ($enabled) {
            Translatable::enable_locale_filter();
        }

        // Stage this SiteConfig and copy into the current object
        if ($existingConfig
            // Double-up of SiteConfig in the same locale can be ignored. Often caused by singleton(SiteConfig)
            && !$existingConfig->getTranslation(Translatable::get_current_locale())
            // If translation is not allowed by the current user then do not
            // allow this code to attempt any behind the scenes translation.
            && $existingConfig->canTranslate(null, Translatable::get_current_locale())
        ) {
            // Create an unsaved "staging" translated object using the correct createTranslation mechanism
            $stagingConfig = $existingConfig->createTranslation(Translatable::get_current_locale(), false);
            $this->owner->update($stagingConfig->toMap());
        }

        // Maintain single translation group for SiteConfig
        if ($existingConfig) {
            $this->owner->_TranslationGroupID = $existingConfig->getTranslationGroup();
        }

        $this->owner->Locale = Translatable::get_current_locale();
    }

    /**
     * Enables automatic population of SiteConfig fields using createTranslation if
     * created outside of the Translatable module
     * @var boolean
     */
    public static $enable_siteconfig_generation = true;

    /**
     * Hooks into the DataObject::populateDefaults() method
     */
    public function populateDefaults()
    {
        if (empty($this->owner->ID)
            && ($this->owner instanceof SiteConfig)
            && self::$enable_siteconfig_generation
        ) {
            // Use enable_siteconfig_generation to prevent infinite loop during object creation
            self::$enable_siteconfig_generation = false;
            $this->populateSiteConfigDefaults();
            self::$enable_siteconfig_generation = true;
        }
    }

    /**
     * Creates a new translation for the owner object of this decorator.
     * Checks {@link getTranslation()} to return an existing translation
     * instead of creating a duplicate. Writes the record to the database before
     * returning it. Use this method if you want the "translation group"
     * mechanism to work, meaning that an object knows which group of translations
     * it belongs to. For "original records" which are not created through this
     * method, the "translation group" is set in {@link onAfterWrite()}.
     *
     * @param string $locale Target locale to translate this object into
     * @param boolean $saveTranslation Flag indicating whether the new record
     * should be saved to the database.
     * @return DataObject The translated object
     * @throws InvalidArgumentException If the locale is invalid
     * @throws Exception if the user is not allowed to create a new translation
     */
    public function createTranslation($locale, $saveTranslation = true)
    {
        if ($locale && !$this->isLocaleValid($locale)) {
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        if (!$this->owner->exists()) {
            user_error(
                'Translatable::createTranslation(): Please save your record before creating a translation',
                E_USER_ERROR
            );
        }

        // permission check
        if (!$this->owner->canTranslate(null, $locale)) {
            throw new Exception(sprintf(
                'Creating a new translation in locale "%s" is not allowed for this user',
                $locale
            ));
            return;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        }

        $existingTranslation = $this->getTranslation($locale);
        if ($existingTranslation) {
            return $existingTranslation;
        }

        $class = get_class($this->owner);
        $newTranslation = new $class;

        // copy all fields from owner (apart from ID)
        $newTranslation->update(array_diff_key($this->owner->toMap(), array('Version' => null)));

        // If the object has Hierarchy extension,
        // check for existing translated parents and assign
        // their ParentID (and overwrite any existing ParentID relations
        // to parents in other language). If no parent translations exist,
        // they are automatically created in onBeforeWrite()
        if ($newTranslation->hasField('ParentID')) {
            $origParent = $this->owner->Parent();
            $newTranslationParent = $origParent->getTranslation($locale);
            if ($newTranslationParent) {
                $newTranslation->ParentID = $newTranslationParent->ID;
            }
        }

        $newTranslation->ID = 0;
        $newTranslation->Locale = $locale;
        $newTranslation->Version = 0;

        $originalPage = $this->getTranslation(self::default_locale());
        if ($originalPage) {
            $urlSegment = $originalPage->URLSegment;
        } else {
            $urlSegment = $newTranslation->URLSegment;
        }

        // Only make segment unique if it should be enforced
        if (Config::inst()->get(Translatable::class, 'enforce_global_unique_urls')) {
            $newTranslation->URLSegment = $urlSegment . '-' . i18n::convert_rfc1766($locale);
        }

        // hacky way to set an existing translation group in onAfterWrite()
        $translationGroupID = $this->getTranslationGroup();
        $newTranslation->_TranslationGroupID = $translationGroupID ? $translationGroupID : $this->owner->ID;
        if ($saveTranslation) {
            $newTranslation->write();
        }

        // run callback on page for translation related hooks
        $newTranslation->invokeWithExtensions('onTranslatableCreate', $saveTranslation);

        return $newTranslation;
    }

    /**
     * Caution: Does not consider the {@link canEdit()} permissions.
     *
     * @param DataObject|int $member
     * @param string $locale
     * @return boolean
     * @throws InvalidArgumentException If the locale is invalid
     */
    public function canTranslate($member = null, $locale)
    {
        if ($locale && !$this->isLocaleValid($locale)) {
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        if (!$member || !(is_a($member, Member::class)) || is_numeric($member)) {
            $member = Member::currentUser();

        }

        // check for locale
        $allowedLocale = (
            !is_array(self::get_allowed_locales())
            || in_array($locale, self::get_allowed_locales())
        );

        if (!$allowedLocale) {
            return false;
        }

        // By default, anyone who can edit a page can edit the default locale
        if ($locale == self::default_locale()) {
            return true;
        }

        // check for generic translation permission
        if (Permission::checkMember($member, 'TRANSLATE_ALL')) {
            return true;
        }

        // check for locale specific translate permission
        if (!Permission::checkMember($member, 'TRANSLATE_' . $locale)) {
            return false;
        }

        return true;
    }

    /**
     * @return boolean
     */
    public function canEdit($member)
    {
        if (!$this->owner->Locale) {
            return null;
        }
        return $this->owner->canTranslate($member, $this->owner->Locale) ? null : false;
    }

    /**
     * Returns TRUE if the current record has a translation in this language.
     * Use {@link getTranslation()} to get the actual translated record from
     * the database.
     *
     * @param string $locale
     * @return boolean
     * @throws InvalidArgumentException If the locale is invalid
     */
    public function hasTranslation($locale)
    {
        if ($locale && !$this->isLocaleValid($locale)) {
            throw new InvalidArgumentException(sprintf('Invalid locale "%s"', $locale));
        }

        return (
            $this->owner->Locale == $locale
            || array_search($locale, $this->getTranslatedLocales()) !== false
        );
    }

    /**
     * Returns <link rel="alternate"> markup for insertion into
     * a HTML4/XHTML compliant <head> section, listing all available translations
     * of a page.
     *
     * @see http://www.w3.org/TR/html4/struct/links.html#edef-LINK
     * @see http://www.w3.org/International/articles/language-tags/
     *
     * @return string HTML
     */
    public function MetaTags(&$tags)
    {
        $template = '<link rel="alternate" type="text/html" title="%s" hreflang="%s" href="%s" />' . "\n";
        $translations = $this->owner->getTranslations();
        if ($translations) {
            $translations = $translations->toArray();
            $translations[] = $this->owner;

            foreach ($translations as $translation) {
                $tags .= sprintf(
                    $template,
                    Convert::raw2xml($translation->Title),
                    i18n::convert_rfc1766($translation->Locale),
                    $translation->AbsoluteLink()
                );
            }
        }
    }

    public function providePermissions()
    {
        if (!SiteTree::has_extension(Translatable::class) || !class_exists(SiteTree::class)) {
            return false;
        }

        $locales = self::get_allowed_locales();

        // Fall back to any locales used in existing translations (see #4939)
        if (!$locales) {

            $locales = DB::query('SELECT "Locale" FROM "SiteTree" GROUP BY "Locale"')->column();
        }

        $permissions = array();
        if ($locales) {

            foreach ($locales as $locale) {
                $localeName = i18n::getData()->localeName($locale);
                $permissions['TRANSLATE_' . $locale] = sprintf(
                    _t(
                        'Translatable.TRANSLATEPERMISSION',
                        'Translate %s',
                        'Translate pages into a language'
                    ),
                    $localeName
                );
            }
        }

        $permissions['TRANSLATE_ALL'] = _t(
            'Translatable.TRANSLATEALLPERMISSION',
            'Translate into all available languages'
        );

        $permissions['VIEW_LANGS'] = _t(
            'Translatable.TRANSLATEVIEWLANGS',
            'View language dropdown'
        );

        return $permissions;
    }

    /**
     * Get a list of languages with at least one element translated in (including the default language)
     *
     * @param string $className Look for languages in elements of this class
     * @param string $where Optional SQL WHERE statement
     * @return array Map of languages in the form locale => langName
     */
    public static function get_existing_content_languages($className = SiteTree::class, $where = '')
    {
        $baseTable = DataObject::getSchema()->baseDataTable($className);
        $query = new SQLSelect("Distinct \"Locale\"", "\"$baseTable\"", $where, '', "\"Locale\"");
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $dbLangs = $query->execute()->column();
        $langlist = array_merge((array) Translatable::default_locale(), (array) $dbLangs);
        $returnMap = [];
        $allCodes = i18n::getData()->getLocales();
        foreach ($langlist as $langCode) {
            if ($langCode && isset($allCodes[$langCode])) {
                if (is_array($allCodes[$langCode])) {
                    $returnMap[$langCode] = $allCodes[$langCode]['name'];
                } else {
                    $returnMap[$langCode] = $allCodes[$langCode];
                }
            }
        }
        return $returnMap;
    }

    /**
     * Get the RelativeLink value for a home page in another locale. This is found by searching for the default home
     * page in the default language, then returning the link to the translated version (if one exists).
     *
     * @return string
     */
    public static function get_homepage_link_by_locale($locale)
    {
        $originalLocale = self::get_current_locale();

        self::set_current_locale(self::default_locale());
        $original = SiteTree::get_by_link(RootURLController::config()->default_homepage_link);
        self::set_current_locale($originalLocale);

        if ($original) {
            if ($translation = $original->getTranslation($locale)) {
                return trim($translation->RelativeLink(true), '/');
            }
        }
    }

    /**
     * Define all locales which in which a new translation is allowed.
     * Checked in {@link canTranslate()}.
     *
     * @param array List of allowed locale codes (see {@link i18n::$all_locales}).
     *  Example: array('de_DE','ja_JP')
     */
    public static function set_allowed_locales($locales)
    {
        self::$allowed_locales = $locales;
    }

    /**
     * Get all locales which are generally permitted to be translated.
     * Use {@link canTranslate()} to check if a specific member has permission
     * to translate a record.
     *
     * @return array
     */
    public static function get_allowed_locales()
    {
        return self::$allowed_locales;
    }

    /**
     * Return a piece of text to keep DataObject cache keys appropriately specific
     */
    public function cacheKeyComponent()
    {
        return 'locale-' . self::get_current_locale();
    }

    /**
     * Extends the SiteTree::validURLSegment() method, to do checks appropriate
     * to Translatable
     *
     * @return bool
     */
    public function augmentValidURLSegment()
    {
        $reEnableFilter = false;
        if (!Config::inst()->get(Translatable::class, 'enforce_global_unique_urls')) {
            self::enable_locale_filter();
        } elseif (self::locale_filter_enabled()) {
            self::disable_locale_filter();
            $reEnableFilter = true;
        }

        $IDFilter = ($this->owner->ID) ? "AND \"SiteTree\".\"ID\" <> {$this->owner->ID}" :  null;
        $parentFilter = null;

        if (Config::inst()->get(SiteTree::class, 'nested_urls')) {
            if ($this->owner->ParentID) {
                $parentFilter = " AND \"SiteTree\".\"ParentID\" = {$this->owner->ParentID}";
            } else {
                $parentFilter = ' AND "SiteTree"."ParentID" = 0';
            }
        }

        $existingPage = SiteTree::get()
            // disable get_one cache, as this otherwise may pick up results from when locale_filter was on
            ->where("\"URLSegment\" = '{$this->owner->URLSegment}' $IDFilter $parentFilter")->First();
        if ($reEnableFilter) {
            self::enable_locale_filter();
        }

        // By returning TRUE or FALSE, we overrule the base SiteTree->validateURLSegment() logic
        return !$existingPage;
    }

    /**
     * Determine whether the given locale is valid
     *
     * @param  string $locale
     * @return bool
     */
    public static function isLocaleValid($locale)
    {
        return (bool) i18n::getData()->validate($locale);
    }
}

silverstripe / silverstripe-translatable

Pull Request — master (#264)

Translatable::choose_site_locale() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
