如何扩展Webklex\PHPIMAP\Folder对象以添加自定义属性？

最优方案：利用包的自定义类映射功能 #

Webklex/php-imap（laravel_imap包的底层依赖）支持通过配置替换默认的Folder类，这样从IMAP服务器获取数据时，会直接返回你的自定义子类实例，完美解决继承后无法获取实例的问题。

步骤如下：

1. 创建自定义Folder类，继承原Webklex\PHPIMAP\Folder：

<?php

namespace App\Imap;

use Webklex\PHPIMAP\Folder as BaseFolder;

class CustomFolder extends BaseFolder {
    // 添加自定义变量
    protected $customTag;

    // 自定义方法示例
    public function setCustomTag(string $tag) {
        $this->customTag = $tag;
        return $this;
    }

    public function getCustomTag() {
        return $this->customTag;
    }

    // 重写原方法扩展功能（可选）
    public function getName() {
        // 先执行父类逻辑
        $name = parent::getName();
        // 添加自定义处理
        return "[自定义前缀]".$name;
    }
}

2. 配置laravel_imap包使用自定义类：
   • 若未发布过配置文件，先执行命令：php artisan vendor:publish --provider="Webklex\IMAP\Providers\LaravelServiceProvider"
   • 打开config/imap.php，在options数组中添加或修改folder.class配置：

'options' => [
    // ...其他原有配置
    'folder.class' => App\Imap\CustomFolder::class,
],

配置完成后，调用$client->getFolders()等方法时，返回的就是CustomFolder实例集合，可直接使用自定义属性和方法。

备选方案：装饰器模式（优化你提到的第一种方式） #

如果无法修改包的配置，装饰器模式是更优雅的替代方案，比存数组更合理：

<?php

namespace App\Imap;

use Webklex\PHPIMAP\Folder;

class FolderDecorator {
    protected $originalFolder;
    protected $customProperty;

    public function __construct(Folder $folder) {
        $this->originalFolder = $folder;
    }

    // 自定义属性的getter/setter
    public function setCustomProperty($value) {
        $this->customProperty = $value;
        return $this;
    }

    public function getCustomProperty() {
        return $this->customProperty;
    }

    // 魔术方法：代理原Folder对象的所有方法调用
    public function __call($method, $arguments) {
        return $this->originalFolder->$method(...$arguments);
    }

    // 魔术方法：代理原Folder对象的属性访问
    public function __get($property) {
        return $this->originalFolder->$property;
    }
}

使用时将原Folder对象包装成装饰器：

$originalFolders = $client->getFolders();
$customFolders = collect($originalFolders)->map(function($folder) {
    return new FolderDecorator($folder);
});

这种方式既保留原Folder的所有功能，又能添加自定义逻辑，无需修改原包代码。

不推荐其他方案的原因 #

• 直接继承但不配置类映射：原包的实例化逻辑硬编码使用默认Folder类，无法自动返回子类实例，重写实例化逻辑会增加维护成本。
• 存入数组：会丢失原Folder对象的方法和类型特性，操作繁琐且容易出错。

内容的提问来源于stack exchange，提问作者FryingPan