README

再也不用操作XML了！（希望如此。）

请注意：LaravelXML可能存在一些问题。请随时提交pull请求！

此包旨在用于Laravel框架。将来可能会创建一个独立版本。

曾经尝试将各种类型的值转换为XML吗？也许你需要制作“导出为XML”的功能。如果你有，那么你很可能知道XML可以是一个绝对痛苦的事情。

LaravelXML旨在解决这个问题。轻松修改对象转换的方式和时机。你甚至可以编写自己的代码来扩展它！这有多么酷？

如果你在应用程序中使用XML，LaravelXML是你不错的选择！

先决条件

要使用LaravelXML，实际上没有特定的先决条件。只需确保你已经安装了xml PHP扩展！你可以通过运行php -i | grep xml并查看是否有返回结果来检查是否已安装。如果在运行该命令后没有任何结果显示，则需要安装XML扩展。

你还需要PHP 7.0或更高版本。

安装

安装快速且简单。你所要做的就是运行

composer require fetchleo/laravel-xml dev-master

目前，还没有稳定的版本。我将继续进行一些测试，并在我确定一切正常之前避免标记版本。

一旦完成，请确保在config/app.php中注册包的服务提供程序，通过添加以下行

FetchLeo\LaravelXml\XmlServiceProvider::class

实际上，你真的不需要做任何事情！当然，你可以随时修改配置，这将在下面介绍。

配置

如果你想要发布LaravelXML的配置文件，只需运行

php artisan vendor:publish --tag=laravel-xml

使用

默认情况下，LaravelXML应该可以正常工作！无需立即设置任何奇怪的设置。除非你喜欢这样做，在这种情况下，请继续阅读。

转换值

LaravelXML提供了一种快速将值转换为XML的方法。请注意，由于某些限制，某些类型的值无法自己转换。然而，它们可以包含在其他可以转换的值（如数组等）中。

以下类型的值无法自行转换：

整数（或双精度/浮点数）
字符串

这意味着除非它们包含在可以转换的其他值（如数组）中，否则它们不能被转换。因此，调用Xml::convert(1)将抛出异常。这很快就会改变！你将能够指定自己的转换器来处理这些类型。还将提供默认的转换器。

无论如何，让我们继续...

要将值转换为XML，只需调用Xml::convert($value)，并确保导入FetchLeo\LaravelXml\Facades\Xml。在底层，LaravelXML正在尝试定位适合该值的转换器。如果没有找到合适的转换器，将抛出异常。你可以指定并创建自己的转换器；请继续阅读以了解更多信息！

自定义转换器

除了默认提供的转换器外，你还可以创建自己的转换器。

首先，你应该创建一个新类，该类实现了FetchLeo\LaravelXml\Contracts\Converter接口。

它看起来可能像这样

<?php

namespace My\App\Namespace;

use FetchLeo\LaravelXml\Contracts\Converter;    
use SimpleXMLElement;
use FetchLeo\LaravelXml\Exceptions\CantConvertValueException;
    
class MyCustomConverter implements Converter 
{
    /**
     * Convert a value to XML.
     *
     * @param Model $value
     * @param SimpleXMLElement $element
     * @return SimpleXMLElement
     * @throws CantConvertValueException
     */
     public function convert($value, SimpleXMLElement $element) : SimpleXMLElement;
     
     /**
      * Determine if this converter can convert the given value.
      *
      * @param mixed $value
      * @param $type
      * @return bool
      */
      public function canConvert($value, $type) : bool;
}

然后，您可以在您的 config/laravel-xml.php 文件中配置新的转换器。 请注意：如果您没有这个文件，请运行 php artisan vendor:publish --provider=FetchLeo\LaravelXml\XmlServiceProvider。

您需要做的是进入 converters 中的 custom 数组。然后，您想要添加一个新的条目。键应该是类似 models 或 objects 或 arrays 或 collections 或什么的！ 注意：目前，转换器只能处理一种类型的值（除了字符串和数字之外，您选择的任何类型。）这可能在将来改变。

值应该是您新类的名称。如果您使用了 Laravel 的 IOC 容器来注册别名，您可以使用别名。例如

'custom' => [
    // ...
    'models' => 'My\App\Namespace\MyCustomConverter'
]

除了为同一泛型类型的所有值指定一个转换器外，您还可以为某些类指定特定的转换器！所以，如果您只想让类型为 My\App\Namespace\CustomThing 的值应用转换器，您可以这样

'custom' => [
    // ...
    'My\App\Namespace\CustomThing' => 'My\App\Namespace\MyCustomConverter'
]

这将告诉 LaravelXML：“嘿，只有当您给我这个类型的值时才使用这个转换器！”LaravelXML 足够智能，如果找不到适当的自定义转换器，将回退到默认转换器。

注册您的转换器

如果您想为您的转换器使用自定义名称，而不在 IOC 容器中手动注册它，您可以这样做

app('laravelxml.converters.manager')->register('name-here', $converterInstance)

LaravelXML 会为您完成所有工作；它负责将所有内容绑定到容器中，因此您不必担心这些内容。

智能键

LaravelXML 足够智能，能够动态地假设在没有适当键的情况下应使用哪些键。包含此功能的原因是 XML 不接受数字作为键。如果您正在处理对象的数组，您肯定会有数字作为键。为了避免因为无法使用数字键而发火，LaravelXML 将尝试智能地确定要使用的键。它99.99%有效。（可能是100%）

假设您有一个名为 projects 的键的数组（或集合）。在这个数组中，有许多看起来像这样的元素

[
    'id' => 42,
    'name' => 'Testing event',
    'description' => '...',
    'user' => [
        'id' => 56,
        'name' => 'John Doe',
        'email' => 'doe@some-email-provider.com'
    ]
]

现在，这个数组没有任何顶级键 whatsoever。 它只是一堆数组（在数组内部！）通常情况下，如果您尝试将此转换为 XML，您的浏览器会告诉您有语法错误。为什么？因为当没有设置键时，PHP 使用数字作为键。记住，数字不被接受为 XML 标签名称！

因此，而不是发火，LaravelXML 有一个“提供键”系统。当一个基础转换器检测到一个数组时，它会将第三个参数传递给转换函数。第三个参数的值将用作该转换器的键。如果由于某种原因没有设置，它将使用值的类型作为“回退键”。

注意：此功能默认不包含！这是您的责任来实现！ 为了了解它是如何工作的，请查看以下文件中的任何一个： src/FetchLeo/LaravelXml/Converters/ArrayConverter，src/FetchLeo/LaravelXml/Converters/ModelConverter，src/FetchLeo/LaravelXml/Converters/ObjectConverter

转换器列表

以下是默认提供的不同转换器表，以及它们可以处理的值类型。

结论

我希望 LaravelXML 在您的项目中运行良好！我已经花费了很多时间确保它能按预期工作。当然，如果您发现任何错误，请 提交问题，如果您有修复方案，甚至可以创建一个 pull request！

新功能即将推出！

待办事项

增加将非对象类型转换为XML（字符串、数字等）的局部支持 这可能会通过向XML元素添加单个子元素来完成，其中键是值类型，值是...值本身。
向配置文件添加新设置
使外观绑定可选。
公开更多私有API方法（对于其中一些，它们不需要是私有的）

附言。 所有测试都通过！

herinneringenoplinnen / laravel-xml

维护者

详细信息