<?php

namespace common\fixtures;

/**
 * GetOrderListEvent 辅助类
 * 
 * @package common\fixtures
 */
class ListData
{
    /**
     * 数据列表
     *
     * @var array
     */
    protected $list;

    /**
     * 对应的内部主键字段
     *
     * @var string
     */
    protected $key;

    /**
     * 对应的外部主键字段
     *
     * @var string
     */
    protected $foreign_key;

    /**
     * 插件名称
     *
     * @var string
     */
    protected $ads_name;

    /**
     * 默认值
     *
     * @var mixed
     */
    protected $default_value = false;

    /**
     * @param array $list           数据列表
     * @param string $ads_name      插件名称
     * @param string $key           对应的内部主键字段
     * @param string $foreign_key   对应的外部主键字段
     */
    public function __construct(array $list, string $ads_name, string $key, string $foreign_key = 'id')
    {
        $this->list         = $list;
        $this->ads_name     = $ads_name;
        $this->key          = $key;
        $this->foreign_key  = $foreign_key;
    }

    /**
     * @return array
     */
    public function getList() :array
    {
        return $this->list;
    }

    /**
     * @return string
     */
    public function getKey() :string
    {
        return $this->key;
    }

    /**
     * @return string
     */
    public function getForeignKey() :string
    {
        return $this->foreign_key;
    }

    /**
     * @return string
     */
    public function getAdsName() :string
    {
        return $this->ads_name;
    }

    /**
     * @param mixed $default_value
     * @return void
     */
    public function setDefaultValue($default_value)
    {
        $this->default_value = $default_value;
    }

    /**
     * @return mixed
     */
    public function getDefaultValue()
    {
        return $this->default_value;
    }
}