<?php
/**
 * The settings of one channel (stored under the channel's own key; see Settings\Settings::for_channel()).
 *
 * @package Tidelist
 */

namespace Tidelist\Channel;

/**
 * Channel settings.
 */
interface ChannelSettings {

	/**
	 * All values of the channel (defaults from its schema applied by the caller).
	 */
	public function all(): array;

	/**
	 * One value.
	 *
	 * @param string $key Key.
	 * @return mixed
	 */
	public function get( string $key );

	/**
	 * Saves changed values.
	 *
	 * @param array $changes Key => value.
	 */
	public function update( array $changes ): void;

	/**
	 * Encrypts a secret for storing.
	 *
	 * @param string $plain Secret.
	 */
	public function seal( string $plain ): string;

	/**
	 * Decrypts a stored secret, or null when it cannot be read.
	 *
	 * @param string $sealed Stored value.
	 */
	public function unseal( string $sealed ): ?string;
}