Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Translation][file dump] remove deprecated format method. #15869

Merged
merged 1 commit into from Sep 22, 2015
Merged

[Translation][file dump] remove deprecated format method. #15869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 27 additions & 0 deletions UPGRADE-3.0.md
View file
Open in desktop
Expand Up @@ -728,6 +728,33 @@ UPGRADE FROM 2.x to 3.0
}
```

* The method `FileDumper::format()` was removed. You should use
`FileDumper::formatCatalogue()` instead.

Before:

```php
class CustomDumper extends FileDumper
{
protected function format(MessageCatalogue $messages, $domain)
{
...
}
}
```

After:

```php
class CustomDumper extends FileDumper
{
public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
{
...
}
}
```

### Twig Bridge

* The `twig:lint` command has been deprecated since Symfony 2.7 and will be
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/Translation/CHANGELOG.md
View file
Open in desktop
Expand Up @@ -4,6 +4,7 @@ CHANGELOG
3.0.0
-----

* removed `FileDumper::format()` method.
* Changed the visibility of the locale property in `Translator` from protected to private.

2.8.0
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/CsvFileDumper.php
View file
Open in desktop
Expand Up @@ -23,16 +23,6 @@ class CsvFileDumper extends FileDumper
private $delimiter = ';';
private $enclosure = '"';

/**
* {@inheritdoc}
*/
public function format(MessageCatalogue $messages, $domain = 'messages')
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
24 changes: 1 addition & 23 deletions src/Symfony/Component/Translation/Dumper/FileDumper.php
View file
Open in desktop
Expand Up @@ -89,35 +89,13 @@ public function dump(MessageCatalogue $messages, $options = array())
/**
* Transforms a domain of a message catalogue to its string representation.
*
* Override this function in child class if $options is used for message formatting.
*
* @param MessageCatalogue $messages
* @param string $domain
* @param array $options
*
* @return string representation
*/
public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
{
@trigger_error('The '.__METHOD__.' method will replace the format method in 3.0. You should overwrite it instead of overwriting format instead.', E_USER_DEPRECATED);

return $this->format($messages, $domain);
}

/**
* Transforms a domain of a message catalogue to its string representation.
*
* @param MessageCatalogue $messages
* @param string $domain
*
* @return string representation
*
* @deprecated since version 2.8, to be removed in 3.0. Overwrite formatCatalogue() instead.
*/
protected function format(MessageCatalogue $messages, $domain)
{
throw new \LogicException('The "FileDumper::format" method needs to be overwritten, you should implement either "format" or "formatCatalogue".');
}
abstract public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array());

/**
* Gets the file extension of the dumper.
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/IcuResFileDumper.php
View file
Open in desktop
Expand Up @@ -25,16 +25,6 @@ class IcuResFileDumper extends FileDumper
*/
protected $relativePathTemplate = '%domain%/%locale%.%extension%';

/**
* {@inheritdoc}
*/
public function format(MessageCatalogue $messages, $domain = 'messages')
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/IniFileDumper.php
View file
Open in desktop
Expand Up @@ -20,16 +20,6 @@
*/
class IniFileDumper extends FileDumper
{
/**
* {@inheritdoc}
*/
public function format(MessageCatalogue $messages, $domain = 'messages')
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/JsonFileDumper.php
View file
Open in desktop
Expand Up @@ -20,16 +20,6 @@
*/
class JsonFileDumper extends FileDumper
{
/**
* {@inheritdoc}
*/
public function format(MessageCatalogue $messages, $domain = 'messages')
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/MoFileDumper.php
View file
Open in desktop
Expand Up @@ -21,16 +21,6 @@
*/
class MoFileDumper extends FileDumper
{
/**
* {@inheritdoc}
*/
public function format(MessageCatalogue $messages, $domain = 'messages')
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/PhpFileDumper.php
View file
Open in desktop
Expand Up @@ -20,16 +20,6 @@
*/
class PhpFileDumper extends FileDumper
{
/**
* {@inheritdoc}
*/
protected function format(MessageCatalogue $messages, $domain)
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/PoFileDumper.php
View file
Open in desktop
Expand Up @@ -20,16 +20,6 @@
*/
class PoFileDumper extends FileDumper
{
/**
* {@inheritdoc}
*/
public function format(MessageCatalogue $messages, $domain = 'messages')
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/QtFileDumper.php
View file
Open in desktop
Expand Up @@ -20,16 +20,6 @@
*/
class QtFileDumper extends FileDumper
{
/**
* {@inheritdoc}
*/
public function format(MessageCatalogue $messages, $domain)
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/XliffFileDumper.php
View file
Open in desktop
Expand Up @@ -46,16 +46,6 @@ public function formatCatalogue(MessageCatalogue $messages, $domain, array $opti
throw new \InvalidArgumentException(sprintf('No support implemented for dumping XLIFF version "%s".', $xliffVersion));
}

/**
* {@inheritdoc}
*/
protected function format(MessageCatalogue $messages, $domain)
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down
10 changes: 0 additions & 10 deletions src/Symfony/Component/Translation/Dumper/YamlFileDumper.php
View file
Open in desktop
Expand Up @@ -44,16 +44,6 @@ public function formatCatalogue(MessageCatalogue $messages, $domain, array $opti
return Yaml::dump($data);
}

/**
* {@inheritdoc}
*/
protected function format(MessageCatalogue $messages, $domain)
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED);

return $this->formatCatalogue($messages, $domain);
}

/**
* {@inheritdoc}
*/
Expand Down