array('field_one', * 'field_two' => 'FieldAssoc', 'field_three')) * * With above example only one permanent hasMany will be joined (for field_two * as FieldAssoc) * * $config could be empty - and translations configured dynamically by * bindTranslation() method * * By default INNER joins are used to fetch translations. In order to use * other join types $config should contain 'joinType' key: * ``` * array( * 'fields' => array('field_one', 'field_two' => 'FieldAssoc', 'field_three'), * 'joinType' => 'LEFT', * ) * ``` * In a model it may be configured this way: * ``` * public $actsAs = array( * 'Translate' => array( * 'content', * 'title', * 'joinType' => 'LEFT', * ), * ); * ``` * * @param Model $Model Model the behavior is being attached to. * @param array $config Array of configuration information. * @return mixed */ public function setup(Model $Model, $config = array()) { $db = ConnectionManager::getDataSource($Model->useDbConfig); if (!$db->connected) { trigger_error( __d('cake_dev', 'Datasource %s for TranslateBehavior of model %s is not connected', $Model->useDbConfig, $Model->alias), E_USER_ERROR ); return false; } $this->settings[$Model->alias] = array(); $this->runtime[$Model->alias] = array( 'fields' => array(), 'joinType' => 'INNER', ); if (isset($config['joinType'])) { $this->runtime[$Model->alias]['joinType'] = $config['joinType']; unset($config['joinType']); } $this->translateModel($Model); return $this->bindTranslation($Model, $config, false); } /** * Cleanup Callback unbinds bound translations and deletes setting information. * * @param Model $Model Model being detached. * @return void */ public function cleanup(Model $Model) { $this->unbindTranslation($Model); unset($this->settings[$Model->alias]); unset($this->runtime[$Model->alias]); } /** * beforeFind Callback * * @param Model $Model Model find is being run on. * @param array $query Array of Query parameters. * @return array Modified query */ public function beforeFind(Model $Model, $query) { $this->runtime[$Model->alias]['virtualFields'] = $Model->virtualFields; $locale = $this->_getLocale($Model); if (empty($locale)) { return $query; } $db = $Model->getDataSource(); $RuntimeModel = $this->translateModel($Model); if (!empty($RuntimeModel->tablePrefix)) { $tablePrefix = $RuntimeModel->tablePrefix; } else { $tablePrefix = $db->config['prefix']; } $joinTable = new StdClass(); $joinTable->tablePrefix = $tablePrefix; $joinTable->table = $RuntimeModel->table; $joinTable->schemaName = $RuntimeModel->getDataSource()->getSchemaName(); $this->_joinTable = $joinTable; $this->_runtimeModel = $RuntimeModel; if (is_string($query['fields'])) { if ($query['fields'] === "COUNT(*) AS {$db->name('count')}") { $query['fields'] = "COUNT(DISTINCT({$db->name($Model->escapeField())})) {$db->alias}count"; $query['joins'][] = array( 'type' => $this->runtime[$Model->alias]['joinType'], 'alias' => $RuntimeModel->alias, 'table' => $joinTable, 'conditions' => array( $Model->escapeField() => $db->identifier($RuntimeModel->escapeField('foreign_key')), $RuntimeModel->escapeField('model') => $Model->name, $RuntimeModel->escapeField('locale') => $locale ) ); $conditionFields = $this->_checkConditions($Model, $query); foreach ($conditionFields as $field) { $query = $this->_addJoin($Model, $query, $field, $field, $locale); } unset($this->_joinTable, $this->_runtimeModel); return $query; } else { $query['fields'] = CakeText::tokenize($query['fields']); } } $addFields = $this->_getFields($Model, $query); $this->runtime[$Model->alias]['virtualFields'] = $Model->virtualFields; $query = $this->_addAllJoins($Model, $query, $addFields); $this->runtime[$Model->alias]['beforeFind'] = $addFields; unset($this->_joinTable, $this->_runtimeModel); return $query; } /** * Gets fields to be retrieved. * * @param Model $Model The model being worked on. * @param array $query The query array to take fields from. * @return array The fields. */ protected function _getFields(Model $Model, $query) { $fields = array_merge( $this->settings[$Model->alias], $this->runtime[$Model->alias]['fields'] ); $addFields = array(); if (empty($query['fields'])) { $addFields = $fields; } elseif (is_array($query['fields'])) { $isAllFields = ( in_array($Model->alias . '.' . '*', $query['fields']) || in_array($Model->escapeField('*'), $query['fields']) ); foreach ($fields as $key => $value) { $field = (is_numeric($key)) ? $value : $key; if ($isAllFields || in_array($Model->alias . '.' . $field, $query['fields']) || in_array($field, $query['fields']) ) { $addFields[] = $field; } } } return $addFields; } /** * Appends all necessary joins for translated fields. * * @param Model $Model The model being worked on. * @param array $query The query array to append joins to. * @param string $addFields The fields being joined. * @return array The modified query */ protected function _addAllJoins(Model $Model, $query, $addFields) { $locale = $this->_getLocale($Model); if ($addFields) { foreach ($addFields as $_f => $field) { $aliasField = is_numeric($_f) ? $field : $_f; foreach (array($aliasField, $Model->alias . '.' . $aliasField) as $_field) { $key = array_search($_field, (array)$query['fields']); if ($key !== false) { unset($query['fields'][$key]); } } $query = $this->_addJoin($Model, $query, $field, $aliasField, $locale); } } return $query; } /** * Check a query's conditions for translated fields. * Return an array of translated fields found in the conditions. * * @param Model $Model The model being read. * @param array $query The query array. * @return array The list of translated fields that are in the conditions. */ protected function _checkConditions(Model $Model, $query) { if (empty($query['conditions']) || (!empty($query['conditions']) && !is_array($query['conditions']))) { return array(); } return $this->_getConditionFields($Model, $query['conditions']); } /** * Extracts condition field names recursively. * * @param Model $Model The model being read. * @param array $conditions The conditions array. * @return array The list of condition fields. */ protected function _getConditionFields(Model $Model, $conditions) { $conditionFields = array(); foreach ($conditions as $col => $val) { if (is_array($val)) { $subConditionFields = $this->_getConditionFields($Model, $val); $conditionFields = array_merge($conditionFields, $subConditionFields); } foreach ($this->settings[$Model->alias] as $field => $assoc) { if (is_numeric($field)) { $field = $assoc; } if (strpos($col, $field) !== false) { $conditionFields[] = $field; } } } return $conditionFields; } /** * Appends a join for translated fields. * * @param Model $Model The model being worked on. * @param array $query The query array to append a join to. * @param string $field The field name being joined. * @param string $aliasField The aliased field name being joined. * @param string|array $locale The locale(s) having joins added. * @return array The modified query */ protected function _addJoin(Model $Model, $query, $field, $aliasField, $locale) { $db = ConnectionManager::getDataSource($Model->useDbConfig); $RuntimeModel = $this->_runtimeModel; $joinTable = $this->_joinTable; $aliasVirtual = "i18n_{$field}"; $alias = "I18n__{$field}"; if (is_array($locale)) { foreach ($locale as $_locale) { $aliasVirtualLocale = "{$aliasVirtual}_{$_locale}"; $aliasLocale = "{$alias}__{$_locale}"; $Model->virtualFields[$aliasVirtualLocale] = "{$aliasLocale}.content"; if (!empty($query['fields']) && is_array($query['fields'])) { $query['fields'][] = $aliasVirtualLocale; } $query['joins'][] = array( 'type' => 'LEFT', 'alias' => $aliasLocale, 'table' => $joinTable, 'conditions' => array( $Model->escapeField() => $db->identifier("{$aliasLocale}.foreign_key"), "{$aliasLocale}.model" => $Model->name, "{$aliasLocale}.{$RuntimeModel->displayField}" => $aliasField, "{$aliasLocale}.locale" => $_locale ) ); } } else { $Model->virtualFields[$aliasVirtual] = "{$alias}.content"; if (!empty($query['fields']) && is_array($query['fields'])) { $query['fields'][] = $aliasVirtual; } $query['joins'][] = array( 'type' => $this->runtime[$Model->alias]['joinType'], 'alias' => $alias, 'table' => $joinTable, 'conditions' => array( "{$Model->alias}.{$Model->primaryKey}" => $db->identifier("{$alias}.foreign_key"), "{$alias}.model" => $Model->name, "{$alias}.{$RuntimeModel->displayField}" => $aliasField, "{$alias}.locale" => $locale ) ); } return $query; } /** * afterFind Callback * * @param Model $Model Model find was run on * @param array $results Array of model results. * @param bool $primary Did the find originate on $model. * @return array Modified results */ public function afterFind(Model $Model, $results, $primary = false) { $Model->virtualFields = $this->runtime[$Model->alias]['virtualFields']; $this->runtime[$Model->alias]['virtualFields'] = $this->runtime[$Model->alias]['fields'] = array(); if (!empty($this->runtime[$Model->alias]['restoreFields'])) { $this->runtime[$Model->alias]['fields'] = $this->runtime[$Model->alias]['restoreFields']; unset($this->runtime[$Model->alias]['restoreFields']); } $locale = $this->_getLocale($Model); if (empty($locale) || empty($results) || empty($this->runtime[$Model->alias]['beforeFind'])) { return $results; } $beforeFind = $this->runtime[$Model->alias]['beforeFind']; foreach ($results as $key => &$row) { $results[$key][$Model->alias]['locale'] = (is_array($locale)) ? current($locale) : $locale; foreach ($beforeFind as $_f => $field) { $aliasField = is_numeric($_f) ? $field : $_f; $aliasVirtual = "i18n_{$field}"; if (is_array($locale)) { foreach ($locale as $_locale) { $aliasVirtualLocale = "{$aliasVirtual}_{$_locale}"; if (!isset($row[$Model->alias][$aliasField]) && !empty($row[$Model->alias][$aliasVirtualLocale])) { $row[$Model->alias][$aliasField] = $row[$Model->alias][$aliasVirtualLocale]; $row[$Model->alias]['locale'] = $_locale; } unset($row[$Model->alias][$aliasVirtualLocale]); } if (!isset($row[$Model->alias][$aliasField])) { $row[$Model->alias][$aliasField] = ''; } } else { $value = ''; if (isset($row[$Model->alias][$aliasVirtual])) { $value = $row[$Model->alias][$aliasVirtual]; } $row[$Model->alias][$aliasField] = $value; unset($row[$Model->alias][$aliasVirtual]); } } } return $results; } /** * beforeValidate Callback * * @param Model $Model Model invalidFields was called on. * @param array $options Options passed from Model::save(). * @return bool * @see Model::save() */ public function beforeValidate(Model $Model, $options = array()) { unset($this->runtime[$Model->alias]['beforeSave']); $this->_setRuntimeData($Model); return true; } /** * beforeSave callback. * * Copies data into the runtime property when `$options['validate']` is * disabled. Or the runtime data hasn't been set yet. * * @param Model $Model Model save was called on. * @param array $options Options passed from Model::save(). * @return bool true. * @see Model::save() */ public function beforeSave(Model $Model, $options = array()) { if (isset($options['validate']) && !$options['validate']) { unset($this->runtime[$Model->alias]['beforeSave']); } if (isset($this->runtime[$Model->alias]['beforeSave'])) { return true; } $this->_setRuntimeData($Model); return true; } /** * Sets the runtime data. * * Used from beforeValidate() and beforeSave() for compatibility issues, * and to allow translations to be persisted even when validation * is disabled. * * @param Model $Model Model using this behavior. * @return void */ protected function _setRuntimeData(Model $Model) { $locale = $this->_getLocale($Model); if (empty($locale)) { return true; } $fields = array_merge($this->settings[$Model->alias], $this->runtime[$Model->alias]['fields']); $tempData = array(); foreach ($fields as $key => $value) { $field = (is_numeric($key)) ? $value : $key; if (isset($Model->data[$Model->alias][$field])) { $tempData[$field] = $Model->data[$Model->alias][$field]; if (is_array($Model->data[$Model->alias][$field])) { if (is_string($locale) && !empty($Model->data[$Model->alias][$field][$locale])) { $Model->data[$Model->alias][$field] = $Model->data[$Model->alias][$field][$locale]; } else { $values = array_values($Model->data[$Model->alias][$field]); $Model->data[$Model->alias][$field] = $values[0]; } } } } $this->runtime[$Model->alias]['beforeSave'] = $tempData; } /** * Restores model data to the original data. * This solves issues with saveAssociated and validate = first. * * @param Model $Model Model using this behavior. * @return void */ public function afterValidate(Model $Model) { $Model->data[$Model->alias] = array_merge( $Model->data[$Model->alias], $this->runtime[$Model->alias]['beforeSave'] ); return true; } /** * afterSave Callback * * @param Model $Model Model the callback is called on * @param bool $created Whether or not the save created a record. * @param array $options Options passed from Model::save(). * @return void */ public function afterSave(Model $Model, $created, $options = array()) { if (!isset($this->runtime[$Model->alias]['beforeValidate']) && !isset($this->runtime[$Model->alias]['beforeSave'])) { return true; } if (isset($this->runtime[$Model->alias]['beforeValidate'])) { $tempData = $this->runtime[$Model->alias]['beforeValidate']; } else { $tempData = $this->runtime[$Model->alias]['beforeSave']; } unset($this->runtime[$Model->alias]['beforeValidate'], $this->runtime[$Model->alias]['beforeSave']); $conditions = array('model' => $Model->name, 'foreign_key' => $Model->id); $RuntimeModel = $this->translateModel($Model); if ($created) { $tempData = $this->_prepareTranslations($Model, $tempData); } $locale = $this->_getLocale($Model); $atomic = array(); if (isset($options['atomic'])) { $atomic = array('atomic' => $options['atomic']); } foreach ($tempData as $field => $value) { unset($conditions['content']); $conditions['field'] = $field; if (is_array($value)) { $conditions['locale'] = array_keys($value); } else { $conditions['locale'] = $locale; if (is_array($locale)) { $value = array($locale[0] => $value); } else { $value = array($locale => $value); } } $translations = $RuntimeModel->find('list', array( 'conditions' => $conditions, 'fields' => array( $RuntimeModel->alias . '.locale', $RuntimeModel->alias . '.id' ) )); foreach ($value as $_locale => $_value) { $RuntimeModel->create(); $conditions['locale'] = $_locale; $conditions['content'] = $_value; if (array_key_exists($_locale, $translations)) { $RuntimeModel->save(array( $RuntimeModel->alias => array_merge( $conditions, array('id' => $translations[$_locale]) ), $atomic )); } else { $RuntimeModel->save(array($RuntimeModel->alias => $conditions), $atomic); } } } } /** * Prepares the data to be saved for translated records. * Add blank fields, and populates data for multi-locale saves. * * @param Model $Model Model using this behavior * @param array $data The sparse data that was provided. * @return array The fully populated data to save. */ protected function _prepareTranslations(Model $Model, $data) { $fields = array_merge($this->settings[$Model->alias], $this->runtime[$Model->alias]['fields']); $locales = array(); foreach ($data as $key => $value) { if (is_array($value)) { $locales = array_merge($locales, array_keys($value)); } } $locales = array_unique($locales); $hasLocales = count($locales) > 0; foreach ($fields as $key => $field) { if (!is_numeric($key)) { $field = $key; } if ($hasLocales && !isset($data[$field])) { $data[$field] = array_fill_keys($locales, ''); } elseif (!isset($data[$field])) { $data[$field] = ''; } } return $data; } /** * afterDelete Callback * * @param Model $Model Model the callback was run on. * @return void */ public function afterDelete(Model $Model) { $RuntimeModel = $this->translateModel($Model); $conditions = array('model' => $Model->name, 'foreign_key' => $Model->id); $RuntimeModel->deleteAll($conditions); } /** * Get selected locale for model * * @param Model $Model Model the locale needs to be set/get on. * @return mixed string or false */ protected function _getLocale(Model $Model) { if (!isset($Model->locale) || $Model->locale === null) { $I18n = I18n::getInstance(); $I18n->l10n->get(Configure::read('Config.language')); $Model->locale = $I18n->l10n->locale; } return $Model->locale; } /** * Get instance of model for translations. * * If the model has a translateModel property set, this will be used as the class * name to find/use. If no translateModel property is found 'I18nModel' will be used. * * @param Model $Model Model to get a translatemodel for. * @return Model */ public function translateModel(Model $Model) { if (!isset($this->runtime[$Model->alias]['model'])) { if (!isset($Model->translateModel) || empty($Model->translateModel)) { $className = 'I18nModel'; } else { $className = $Model->translateModel; } $this->runtime[$Model->alias]['model'] = ClassRegistry::init($className); } if (!empty($Model->translateTable) && $Model->translateTable !== $this->runtime[$Model->alias]['model']->useTable) { $this->runtime[$Model->alias]['model']->setSource($Model->translateTable); } elseif (empty($Model->translateTable) && empty($Model->translateModel)) { $this->runtime[$Model->alias]['model']->setSource('i18n'); } return $this->runtime[$Model->alias]['model']; } /** * Bind translation for fields, optionally with hasMany association for * fake field. * * *Note* You should avoid binding translations that overlap existing model properties. * This can cause un-expected and un-desirable behavior. * * @param Model $Model using this behavior of model * @param string|array $fields string with field or array(field1, field2=>AssocName, field3) * @param bool $reset Leave true to have the fields only modified for the next operation. * if false the field will be added for all future queries. * @return bool * @throws CakeException when attempting to bind a translating called name. This is not allowed * as it shadows Model::$name. */ public function bindTranslation(Model $Model, $fields, $reset = true) { if (is_string($fields)) { $fields = array($fields); } $associations = array(); $RuntimeModel = $this->translateModel($Model); $default = array( 'className' => $RuntimeModel->alias, 'foreignKey' => 'foreign_key', 'order' => 'id' ); foreach ($fields as $key => $value) { if (is_numeric($key)) { $field = $value; $association = null; } else { $field = $key; $association = $value; } if ($association === 'name') { throw new CakeException( __d('cake_dev', 'You cannot bind a translation named "name".') ); } $this->_removeField($Model, $field); if ($association === null) { if ($reset) { $this->runtime[$Model->alias]['fields'][] = $field; } else { $this->settings[$Model->alias][] = $field; } } else { if ($reset) { $this->runtime[$Model->alias]['fields'][$field] = $association; $this->runtime[$Model->alias]['restoreFields'][] = $field; } else { $this->settings[$Model->alias][$field] = $association; } foreach (array('hasOne', 'hasMany', 'belongsTo', 'hasAndBelongsToMany') as $type) { if (isset($Model->{$type}[$association]) || isset($Model->__backAssociation[$type][$association])) { trigger_error( __d('cake_dev', 'Association %s is already bound to model %s', $association, $Model->alias), E_USER_ERROR ); return false; } } $associations[$association] = array_merge($default, array('conditions' => array( 'model' => $Model->name, $RuntimeModel->displayField => $field ))); } } if (!empty($associations)) { $Model->bindModel(array('hasMany' => $associations), $reset); } return true; } /** * Update runtime setting for a given field. * * @param Model $Model Model using this behavior * @param string $field The field to update. * @return void */ protected function _removeField(Model $Model, $field) { if (array_key_exists($field, $this->settings[$Model->alias])) { unset($this->settings[$Model->alias][$field]); } elseif (in_array($field, $this->settings[$Model->alias])) { $this->settings[$Model->alias] = array_merge(array_diff($this->settings[$Model->alias], array($field))); } if (array_key_exists($field, $this->runtime[$Model->alias]['fields'])) { unset($this->runtime[$Model->alias]['fields'][$field]); } elseif (in_array($field, $this->runtime[$Model->alias]['fields'])) { $this->runtime[$Model->alias]['fields'] = array_merge(array_diff($this->runtime[$Model->alias]['fields'], array($field))); } } /** * Unbind translation for fields, optionally unbinds hasMany association for * fake field * * @param Model $Model using this behavior of model * @param string|array $fields string with field, or array(field1, field2=>AssocName, field3), or null for * unbind all original translations * @return bool */ public function unbindTranslation(Model $Model, $fields = null) { if (empty($fields) && empty($this->settings[$Model->alias])) { return false; } if (empty($fields)) { return $this->unbindTranslation($Model, $this->settings[$Model->alias]); } if (is_string($fields)) { $fields = array($fields); } $associations = array(); foreach ($fields as $key => $value) { if (is_numeric($key)) { $field = $value; $association = null; } else { $field = $key; $association = $value; } $this->_removeField($Model, $field); if ($association !== null && (isset($Model->hasMany[$association]) || isset($Model->__backAssociation['hasMany'][$association]))) { $associations[] = $association; } } if (!empty($associations)) { $Model->unbindModel(array('hasMany' => $associations), false); } return true; } }