Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
klimov-paul committed Jun 19, 2023
0 parents commit 5b300e8
Show file tree
Hide file tree
Showing 13 changed files with 412 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Ignore all test and documentation for archive
/.github export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.scrutinizer.yml export-ignore
/phpunit.xml.dist export-ignore
/tests export-ignore
/docs export-ignore
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These are supported funding model platforms

github: [klimov-paul]
patreon: klimov_paul
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### What steps will reproduce the problem?

### What is the expected result?

### What do you get instead?

### Additional info

| Q | A
|-----------------------| ---
| This Package Version | 1.?.?
| Yii Framework Version | 1.1.?
| PHP version |
| Operating system |
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
| Q | A
| ------------- | ---
| Is bugfix? | ✔️/❌
| New feature? | ✔️/❌
| Breaks BC? | ✔️/❌
| Tests pass? | ✔️/❌
| Fixed issues | comma-separated list of tickets # fixed by the PR, if any
31 changes: 31 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: build

on: [push, pull_request]

jobs:
phpunit:
name: PHP ${{ matrix.php }} on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
php: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2']

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
extensions: mbstring
tools: composer:v2
coverage: none

- name: Install dependencies
run: |
composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
- name: Run unit tests
run: vendor/bin/phpunit --colors=always
35 changes: 35 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# phpstorm project files
.idea

# netbeans project files
nbproject

# zend studio for eclipse project files
.buildpath
.project
.settings

# windows thumbnail cache
Thumbs.db

# composer vendor dir
/vendor

/composer.lock

# composer itself is not needed
composer.phar

# Mac DS_Store Files
.DS_Store

# phpunit itself is not needed
phpunit.phar
# local phpunit config
/phpunit.xml
# phpunit cache
.phpunit.result.cache

# test runtime files
/.phpunit.cache
/tests/runtime
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Yii1 translation fallback extension
===================================

1.0.0 Under Development
-----------------------

- Initial release.
32 changes: 32 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
This is free software. It is released under the terms of the
following BSD License.

Copyright © 2023 by Yii1Tech (https://github.com/yii1tech)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Yii1Tech nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<p align="center">
<a href="https://github.com/yii1tech" target="_blank">
<img src="https://avatars.githubusercontent.com/u/134691944" height="100px">
</a>
<h1 align="center">Translation Fallback Extension for Yii1</h1>
<br>
</p>

This extension Provides support for Yii1 translation fallback to another message source.

For license information check the [LICENSE](LICENSE.md)-file.

[![Latest Stable Version](https://img.shields.io/packagist/v/yii1tech/i18n-fallback.svg)](https://packagist.org/packages/yii1tech/i18n-fallback)
[![Total Downloads](https://img.shields.io/packagist/dt/yii1tech/i18n-fallback.svg)](https://packagist.org/packages/yii1tech/i18n-fallback)
[![Build Status](https://github.com/yii1tech/i18n-fallback/workflows/build/badge.svg)](https://github.com/yii1tech/i18n-fallback/actions)


Installation
------------

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
php composer.phar require --prefer-dist yii1tech/i18n-fallback
```

or add

```json
"yii1tech/i18n-fallback": "*"
```

to the "require" section of your composer.json.


Usage
-----

This extension allows
39 changes: 39 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"name": "yii1tech/i18n-fallback",
"description": "Provides support for Yii1 translation fallback to another message source",
"keywords": ["yii1", "i18n", "translation", "fallback", "language", "locale"],
"license": "BSD-3-Clause",
"support": {
"issues": "https://github.com/yii1tech/i18n-fallback/issues",
"wiki": "https://github.com/yii1tech/i18n-fallback/wiki",
"source": "https://github.com/yii1tech/i18n-fallback"
},
"authors": [
{
"name": "Paul Klimov",
"email": "klimov.paul@gmail.com"
}
],
"require": {
"php": ">=7.1",
"yiisoft/yii": "~1.1.0"
},
"require-dev": {
"phpunit/phpunit": "^6.0 || ^7.0 || ^8.0 || ^9.3 || ^10.0.7"
},
"autoload": {
"psr-4": {
"yii1tech\\i18n\\fallback\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"yii1tech\\i18n\\fallback\\test\\": "tests"
}
},
"extra": {
"branch-alias": {
"dev-master": "1.0.x-dev"
}
}
}
15 changes: 15 additions & 0 deletions phpunit.xml.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<phpunit bootstrap="./tests/bootstrap.php"
colors="true"
backupGlobals="false"
backupStaticProperties="false"
processIsolation="false"
cacheDirectory=".phpunit.cache"
stopOnError="false"
stopOnFailure="false">
<testsuites>
<testsuite name="Yii1tech Test Suite">
<directory>./tests</directory>
</testsuite>
</testsuites>
</phpunit>
121 changes: 121 additions & 0 deletions src/MessageSourceFallbackBehavior.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<?php

namespace yii1tech\i18n\fallback;

use CPhpMessageSource;
use Yii;
use CBehavior;

/**
* MessageSourceBehaviorFallback is a behavior for {@see \CMessageSource}, which allows fallback
* to other (default) message source in case the main one can not find a particular translation.
*
* Application configuration example:
*
* ```php
* return [
* 'components' => [
* 'messages' => [
* 'class' => CDbMessageSource::class,
* 'forceTranslation' => true,
* 'behaviors' => [
* 'fallbackBehavior' => [
* 'class' => yii1tech\i18n\fallback\MessageSourceFallbackBehavior::class,
* 'fallbackMessageSource' => [
* 'class' => CPhpMessageSource::class,
* ],
* ],
* ],
* ],
* // ...
* ],
* // ...
* ];
* ```
*
* @property \CMessageSource $owner
* @property \CMessageSource|array $fallbackMessageSource fallback message source.
*
* @author Paul Klimov <klimov.paul@gmail.com>
* @since 1.0
*/
class MessageSourceFallbackBehavior extends CBehavior
{
/**
* @var \CMessageSource|array fallback message source or its array configuration.
*/
private $_fallbackMessageSource = [];

/**
* @var string|null language which should be used to retrieve missing language source.
* If `null` specified - the same previously failed language will be used.
*/
public $fallbackLanguage = null;

/**
* Sets the message source for the translation fallback.
*
* @param \CMessageSource|array $fallbackMessageSource message source instance or its array configuration.
* @return static self reference.
*/
public function setFallbackMessageSource($fallbackMessageSource): self
{
$this->_fallbackMessageSource = $fallbackMessageSource;

return $this;
}

/**
* Returns message source for the translation fallback.
*
* @return \CMessageSource message source.
*/
public function getFallbackMessageSource()
{
if (!is_object($this->_fallbackMessageSource)) {
$this->_fallbackMessageSource = $this->createFallbackMessageSource($this->_fallbackMessageSource);
}

return $this->_fallbackMessageSource;
}

/**
* @param array $config message source configuration.
* @return \CMessageSource message source instance.
*/
protected function createFallbackMessageSource(array $config)
{
if (!array_key_exists('class', $config)) {
$config['class'] = CPhpMessageSource::class;
}
$messageSource = Yii::createComponent($config);
$messageSource->init();

return $messageSource;
}

/**
* {@inheritdoc}
*/
public function events()
{
return [
'onMissingTranslation' => 'missingTranslationHandler',
];
}

/**
* Handles event when a message cannot be translated.
*
* @param \CMissingTranslationEvent $event the event instance.
*/
public function missingTranslationHandler($event): void
{
$language = $this->fallbackLanguage;
if ($language === null) {
$language = $event->language;
}

$event->message = $this->getFallbackMessageSource()->translate($event->category, $event->message, $language);
}
}

0 comments on commit 5b300e8

Please sign in to comment.