<?php
/**
 * Things: GP_Note class
 *
 * @package GlotPress
 * @subpackage Things
 * @since 3.0.0
 */

/**
 * Core class used to implement the notes system.
 *
 * @since 3.0.0
 */
class GP_Note extends GP_Thing {

	/**
	 * Name of the database table.
	 *
	 * @var string $table_basename
	 */
	public $table_basename = 'gp_notes';

	/**
	 * List of field names for a translation.
	 *
	 * @var array $field_names
	 */
	public $field_names = array(
		'id',
		'original_id',
		'translation_id',
		'note',
		'user_id',
		'date_added',
		'date_modified',
	);

	/**
	 * List of field names which have an integer value.
	 *
	 * @var array $int_fields
	 */
	public $int_fields = array(
		'id',
		'original_id',
		'translation_id',
		'user_id',
	);

	/**
	 * List of field names which cannot be updated.
	 *
	 * @var array $non_updatable_attributes
	 */
	public $non_updatable_attributes = array( 'id' );

	/**
	 * SQL string for order by date
	 *
	 * @var array $default_order
	 */
	public $default_order = 'ORDER BY date_added DESC';

	/**
	 * Save the note
	 *
	 * @since 3.0.0
	 *
	 * @param string $args    Parameters that are not used.
	 *
	 * @return object The output of the query.
	 */
	public function save( $args = null ) {
		$original_id    = gp_post( 'original_id' );
		$translation_id = gp_post( 'translation_id' );
		$note           = trim( esc_html( gp_post( 'note' ) ) );

		return $this->create_and_select(
			array(
				'original_id'    => $original_id,
				'translation_id' => $translation_id,
				'note'           => $note,
				'user_id'        => get_current_user_id(),
			)
		);
	}

	/**
	 * Edit the note
	 *
	 * @since 3.0.0
	 *
	 * @param string $note_id     Note ID.
	 * @param string $note        Note object.
	 * @param string $translation Translation object.
	 *
	 * @return object The output of the query.
	 */
	public function edit( $note_id, $note, $translation ) {
		$note_object = GP::$notes->get( $note_id );

		$this->update( array( 'note' => $note ), array( 'id' => $note_id ) );

		return $this->get( $note_id );
	}

	/**
	 * Retrieves the note for this translation id.
	 *
	 * @since 3.0.0
	 *
	 * @param object $translation_id The translation id.
	 * @param object $order The note order.
	 *
	 * @return array notes
	 */
	public function get_by_translation_id( $translation_id, $order = null ) {
		return $this->many(
			$this->select_all_from_conditions_and_order(
				array(
					'translation_id' => $translation_id,
				),
				$order
			)
		);
	}
}

GP::$notes = new GP_Note();