<?php
/**
 * Result of a publish, status check, update, takedown or re-listing.
 *
 * @package Tidelist
 */

namespace Tidelist\Channel;

/**
 * Channel call result.
 */
final class Outcome {

	/**
	 * New listing status (ListingStatus::*), or "" when unchanged.
	 *
	 * @var string
	 */
	public $state = '';

	/**
	 * Advert ID at the marketplace ("" if none).
	 *
	 * @var string
	 */
	public $remote_id = '';

	/**
	 * Raw status at the marketplace (new, active, limited, removed_by_user, …).
	 *
	 * @var string
	 */
	public $remote_status = '';

	/**
	 * Category the advert is in at the marketplace (0 = unknown).
	 *
	 * @var int
	 */
	public $remote_category = 0;

	/**
	 * Public advert URL.
	 *
	 * @var string
	 */
	public $url = '';

	/**
	 * Valid until (Y-m-d H:i:s), or "".
	 *
	 * @var string
	 */
	public $valid_to = '';

	/**
	 * True when nothing was sent because dry-run is on.
	 *
	 * @var bool
	 */
	public $simulated = false;

	/**
	 * True when an advert with this external ID already existed (nothing new was created).
	 *
	 * @var bool
	 */
	public $already_existed = false;

	/**
	 * Fields to store on the listing row.
	 */
	public function fields(): array {
		$fields = array();
		if ( '' !== $this->state ) {
			$fields['status'] = $this->state;
		}
		if ( '' !== $this->remote_id ) {
			$fields['remote_id'] = $this->remote_id;
		}
		if ( '' !== $this->remote_status ) {
			$fields['remote_status'] = $this->remote_status;
		}
		if ( $this->remote_category > 0 ) {
			$fields['remote_category'] = $this->remote_category;
		}
		if ( '' !== $this->url ) {
			$fields['remote_url'] = $this->url;
		}
		if ( '' !== $this->valid_to ) {
			$fields['valid_to'] = $this->valid_to;
		}
		return $fields;
	}
}