Merge pull request #50 from AD7six/cake-3.6

ADmad · web-flow · commit 3e20e232911d · 2018-04-30T01:58:22.000+05:30
Cake 3.5
diff --git a/.travis.yml b/.travis.yml
@@ -6,8 +6,6 @@ php:
   - 7.1
   - 7.2
 
-sudo: false
-
 env:
   matrix:
     - DB=mysql db_dsn='mysql://travis@0.0.0.0/cakephp_test'
@@ -20,29 +18,34 @@ matrix:
   fast_finish: true
 
   include:
-    - php: 7.0
+    - php: 5.6
+      env: PREFER_LOWEST=1 DB=mysql db_dsn='mysql://travis@0.0.0.0/cakephp_test'
+
+    - php: 7.1
       env: PHPCS=1 DEFAULT=0
 
-    - php: 7.0
+    - php: 7.1
       env: PHPSTAN=1 DEFAULT=0
 
 before_script:
-  - if [[ $TRAVIS_PHP_VERSION != 7.0 && $TRAVIS_PHP_VERSION != 7.2 ]]; then phpenv config-rm xdebug.ini; fi
+  - phpenv config-rm xdebug.ini
+
+  - if [[ $PREFER_LOWEST != 1 ]]; then composer install --no-interaction --prefer-source; fi
+  - if [[ $PREFER_LOWEST = 1 ]]; then composer update --no-interaction --prefer-source --prefer-lowest --prefer-stable; fi
 
-  - composer install --no-interaction --prefer-source
   - if [[ $DB = 'mysql' ]]; then mysql -e 'CREATE DATABASE cakephp_test;'; fi
   - if [[ $DB = 'pgsql' ]]; then psql -c 'CREATE DATABASE cakephp_test;' -U postgres; fi
 
 script:
-  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.0 ]]; then vendor/bin/phpunit; fi
-  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.0 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi
+  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.1 ]]; then vendor/bin/phpunit; fi
+  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.1 ]]; then phpdbg -qrr vendor/bin/phpunit --coverage-clover=clover.xml; fi
 
   - if [[ $PHPCS = 1 ]]; then vendor/bin/phpcs -p -n --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src ./tests; fi
 
-  - if [[ $PHPSTAN = 1 ]]; then composer require --dev phpstan/phpstan:^0.8 && vendor/bin/phpstan analyse -l 5 src; fi
+  - if [[ $PHPSTAN = 1 ]]; then composer require --dev phpstan/phpstan:^0.9 && vendor/bin/phpstan analyse -l 5 src; fi
 
 after_success:
-- if [[ $DEFAULT = 1 && $DB = 'mysql' && $TRAVIS_PHP_VERSION = 7.0 ]]; then bash <(curl -s https://codecov.io/bash); fi
+- if [[ $DEFAULT = 1 && $DB = 'mysql' && $TRAVIS_PHP_VERSION = 7.1 ]]; then bash <(curl -s https://codecov.io/bash); fi
 
 notifications:
   email: false
diff --git a/composer.json b/composer.json
@@ -10,13 +10,13 @@
         }
     ],
     "require": {
-        "cakephp/orm": "^3.4.3",
-        "cakephp/i18n": "^3.4.3"
+        "cakephp/orm": "^3.5",
+        "cakephp/i18n": "^3.5"
     },
     "require-dev": {
-        "phpunit/phpunit": "<6.0",
-        "cakephp/cakephp": "^3.4.3",
-        "cakephp/cakephp-codesniffer": "~2.3"
+        "phpunit/phpunit": "^5.7.14|^6.0",
+        "cakephp/cakephp": "^3.5",
+        "cakephp/cakephp-codesniffer": "^3.0"
     },
     "autoload": {
         "psr-4": {
diff --git a/src/Model/Behavior/ShadowTranslateBehavior.php b/src/Model/Behavior/ShadowTranslateBehavior.php
@@ -5,6 +5,7 @@
 use Cake\Database\Expression\FieldInterface;
 use Cake\Datasource\EntityInterface;
 use Cake\Event\Event;
+use Cake\I18n\I18n;
 use Cake\ORM\Behavior\TranslateBehavior;
 use Cake\ORM\Query;
 use Cake\ORM\Table;
@@ -23,8 +24,13 @@ class ShadowTranslateBehavior extends TranslateBehavior
      */
     public function __construct(Table $table, array $config = [])
     {
-        $tableAlias = $table->alias();
-        list($plugin) = pluginSplit($table->registryAlias(), true);
+        $this->_defaultConfig['implementedMethods'] += [
+            'setLocale' => 'setLocale',
+            'getLocale' => 'getLocale',
+        ];
+
+        $tableAlias = $table->getAlias();
+        list($plugin) = pluginSplit($table->getRegistryAlias(), true);
 
         if (isset($config['referenceName'])) {
             $tableReferenceName = $config['referenceName'];
@@ -41,6 +47,46 @@ public function __construct(Table $table, array $config = [])
         parent::__construct($table, $config);
     }
 
+    /**
+     * Sets the locale that should be used for all future find and save operations on
+     * the table where this behavior is attached to.
+     *
+     * When fetching records, the behavior will include the content for the locale set
+     * via this method, and likewise when saving data, it will save the data in that
+     * locale.
+     *
+     * Note that in case an entity has a `_locale` property set, that locale will win
+     * over the locale set via this method (and over the globally configured one for
+     * that matter)!
+     *
+     * @param string|null $locale The locale to use for fetching and saving records. Pass `null`
+     * in order to unset the current locale, and to make the behavior fall back to using the
+     * globally configured locale.
+     * @return $this
+     * @see \ShadowTranslate\ORM\Behavior\ShadowTranslateBehavior::getLocale()
+     */
+    public function setLocale($locale)
+    {
+        $this->_locale = $locale;
+
+        return $this;
+    }
+
+    /**
+     * Returns the current locale.
+     *
+     * If no locale has been explicitly set via `setLocale()`, this method will return
+     * the currently configured global locale.
+     *
+     * @return string
+     * @see \Cake\I18n\I18n::getLocale()
+     * @see \ShadowTranslate\ORM\Behavior\ShadowTranslateBehavior::setLocale()
+     */
+    public function getLocale()
+    {
+        return $this->_locale ?: I18n::getLocale();
+    }
+
     /**
      * Create a hasMany association for all records
      *
@@ -56,14 +102,14 @@ public function __construct(Table $table, array $config = [])
      */
     public function setupFieldAssociations($fields, $table, $fieldConditions, $strategy)
     {
-        $config = $this->config();
+        $config = $this->getConfig();
 
         $this->_table->hasMany($config['translationTable'], [
             'className' => $config['translationTable'],
             'foreignKey' => 'id',
             'strategy' => $strategy,
             'propertyName' => '_i18n',
-            'dependent' => true
+            'dependent' => true,
         ]);
     }
 
@@ -79,13 +125,13 @@ public function setupFieldAssociations($fields, $table, $fieldConditions, $strat
      */
     public function beforeFind(Event $event, Query $query, $options)
     {
-        $locale = $this->locale();
+        $locale = $this->getLocale();
 
-        if ($locale === $this->config('defaultLocale')) {
+        if ($locale === $this->getConfig('defaultLocale')) {
             return;
         }
 
-        $config = $this->config();
+        $config = $this->getConfig();
 
         if (isset($options['filterByCurrentLocale'])) {
             $joinType = $options['filterByCurrentLocale'] ? 'INNER' : 'LEFT';
@@ -133,7 +179,7 @@ public function beforeFind(Event $event, Query $query, $options)
      */
     protected function _addFieldsToQuery(Query $query, array $config)
     {
-        if ($query->autoFields()) {
+        if ($query->isAutoFieldsEnabled()) {
             return true;
         }
 
@@ -264,8 +310,8 @@ protected function _traverseClause(Query $query, $name = '', $config = [])
      */
     public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $options)
     {
-        $locale = $entity->get('_locale') ?: $this->locale();
-        $newOptions = [$this->_translationTable->alias() => ['validate' => false]];
+        $locale = $entity->get('_locale') ?: $this->getLocale();
+        $newOptions = [$this->_translationTable->getAlias() => ['validate' => false]];
         $options['associated'] = $newOptions + $options['associated'];
 
         // Check early if empty translations are present in the entity.
@@ -281,7 +327,7 @@ public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $o
 
         // No additional translation records need to be saved,
         // as the entity is in the default locale.
-        if ($noBundled && $locale === $this->config('defaultLocale')) {
+        if ($noBundled && $locale === $this->getConfig('defaultLocale')) {
             return;
         }
 
@@ -296,15 +342,15 @@ public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $o
             return;
         }
 
-        $primaryKey = (array)$this->_table->primaryKey();
+        $primaryKey = (array)$this->_table->getPrimaryKey();
         $id = $entity->get(current($primaryKey));
 
         // When we have no key and bundled translations, we
         // need to mark the entity dirty so the root
         // entity persists.
         if ($noFields && $bundled && !$id) {
             foreach ($this->_translationFields() as $field) {
-                $entity->dirty($field, true);
+                $entity->setDirty($field, true);
             }
 
             return;
@@ -319,7 +365,7 @@ public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $o
         $translation = $this->_translationTable()->find()
             ->select(array_merge(['id', 'locale'], $fields))
             ->where($where)
-            ->bufferResults(false)
+            ->enableBufferedResults(false)
             ->first();
 
         if ($translation) {
@@ -331,17 +377,17 @@ public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $o
                 $where + $values,
                 [
                     'useSetters' => false,
-                    'markNew' => true
+                    'markNew' => true,
                 ]
             );
         }
 
         $entity->set('_i18n', array_merge($bundled, [$translation]));
         $entity->set('_locale', $locale, ['setter' => false]);
-        $entity->dirty('_locale', false);
+        $entity->setDirty('_locale', false);
 
         foreach ($fields as $field) {
-            $entity->dirty($field, false);
+            $entity->setDirty($field, false);
         }
     }
 
@@ -367,13 +413,13 @@ public function buildMarshalMap($marshaller, $map, $options)
      */
     public function translationField($field)
     {
-        if ($this->locale() === $this->getConfig('defaultLocale')) {
+        if ($this->getLocale() === $this->getConfig('defaultLocale')) {
             return $this->_table->aliasField($field);
         }
 
         $translatedFields = $this->_translationFields();
         if (in_array($field, $translatedFields)) {
-            return $this->config('hasOneAlias') . '.' . $field;
+            return $this->getConfig('hasOneAlias') . '.' . $field;
         }
 
         return $this->_table->aliasField($field);
@@ -399,7 +445,7 @@ protected function _rowMapper($results, $locale)
             $hydrated = !is_array($row);
 
             if (empty($row['translation'])) {
-                $row['_locale'] = $this->locale();
+                $row['_locale'] = $this->getLocale();
                 unset($row['translation']);
 
                 if ($hydrated) {
@@ -459,7 +505,7 @@ public function groupTranslations($results)
 
             $row['_translations'] = $result;
             unset($row['_i18n']);
-            if (is_object($row)) {
+            if ($row instanceof EntityInterface) {
                 $row->clean();
             }
 
@@ -479,11 +525,11 @@ protected function _bundleTranslatedFields($entity)
     {
         $translations = (array)$entity->get('_translations');
 
-        if (empty($translations) && !$entity->dirty('_translations')) {
+        if (empty($translations) && !$entity->isDirty('_translations')) {
             return;
         }
 
-        $primaryKey = (array)$this->_table->primaryKey();
+        $primaryKey = (array)$this->_table->getPrimaryKey();
         $key = $entity->get(current($primaryKey));
 
         foreach ($translations as $lang => $translation) {
@@ -512,7 +558,7 @@ protected function _bundleTranslatedFields($entity)
     protected function _translationTable($config = [])
     {
         if (!$config) {
-            $config = $this->config();
+            $config = $this->getConfig();
         }
 
         return TableRegistry::get($config['translationTable']);
@@ -525,16 +571,16 @@ protected function _translationTable($config = [])
      */
     protected function _mainFields()
     {
-        $fields = $this->config('mainTableFields');
+        $fields = $this->getConfig('mainTableFields');
 
         if ($fields) {
             return $fields;
         }
 
         $table = $this->_table;
-        $fields = $table->schema()->columns();
+        $fields = $table->getSchema()->columns();
 
-        $this->config('mainTableFields', $fields);
+        $this->setConfig('mainTableFields', $fields);
 
         return $fields;
     }
@@ -546,17 +592,17 @@ protected function _mainFields()
      */
     protected function _translationFields()
     {
-        $fields = $this->config('fields');
+        $fields = $this->getConfig('fields');
 
         if ($fields) {
             return $fields;
         }
 
         $table = $this->_translationTable();
-        $fields = $table->schema()->columns();
+        $fields = $table->getSchema()->columns();
         $fields = array_values(array_diff($fields, ['id', 'locale']));
 
-        $this->config('fields', $fields);
+        $this->setConfig('fields', $fields);
 
         return $fields;
     }
diff --git a/tests/TestCase/Model/Behavior/ShadowTranslateBehaviorTest.php b/tests/TestCase/Model/Behavior/ShadowTranslateBehaviorTest.php
