<?php

namespace plainview\sdk_eightb_sold_alerts\form2\inputs\traits;

/**
	@brief		Validation handling.
	@details

	Changelog
	---------

	20130814	has_validation_errors()
	20130604	validate_required() has better checking.

	@author		Edward Plainview <edward@plainview.se>
	@copyright	GPL v3
	@version	20130814
**/
trait validation
{
	/**
		@brief		Has this input been validated?
		@see		validate()
		@var		$has_validated
		@since		20130718
	**/
	public $has_validated = false;

	/**
		@brief		An array of validation errors this input has acquired during validation.
		@see		get_validation_errors()
		@see		validate()
		@var		$validation_methods
	**/
	public $validation_errors = array();

	/**
		@brief		An array of methods that will validate this input.
		@see		validate()
		@var		$validation_methods
	**/
	public $validation_methods = array();

	/**
		@brief		Append a validation error.
		@param		\\plainview\\sdk_eightb_sold_alerts\\form2\\validation\\error		$error		Error to append.
		@return		$this		Object chaining.
		@since		20130524
	**/
	public function add_validation_error( $error )
	{
		$this->validation_errors[] = $error;
		return $this;
	}

	/**
		@brief		Add a validation method.
		@details	Accepts either one parameter, $p1, for an internal method. $this->validate_required(), for example.
		If two parameters are used, then the first is the class and the second is the callable method in the class.

		For example:

		$input->add_validation_method( 'string_length' ) will call $input->validate_string_length( $input );
		$input->add_validation_method( $other_class, 'string_length' ) will call $other_class->validate_string_length( $input );

		@param		mixed		$p1				Either an internal input method, or the class which contains the callable.
		@param		string		$callable		The name of the callable method in the first parameter, $p1 (which is an object).
		@return		$this		Object chaining.
		@since		20130524
	**/
	public function add_validation_method( $p1, $callable = null )
	{
		if ( $callable !== null )
			$method = array( $p1, 'validate_' . $callable );
		else
			$method = array( $this, 'validate_' . $p1 );

		$this->validation_methods[] = $method;

		return $this;
	}

	/**
		@brief		Returns an array of validation errors.
		@return		array		An array of \\plainview\\sdk_eightb_sold_alerts\\form2\\validation\\error objects.
		@since		20130524
	**/
	public function get_validation_errors()
	{
		return $this->validation_errors;
	}

	/**
		@brief		Returns if the object has been validated.
		@return		bool		True, if the object has been validated.
		@see		validate()
		@since		20130718
	**/
	public function has_validated()
	{
		return $this->has_validated;
	}

	/**
		@brief		Convenience function to query if the input has any validation errors.
		@details

		This method does not do any validation. To validate + query the result at the same time, use validates().
		@return		bool		True if the input has validation errors.
		@see		validates()
		@since		20130814
	**/
	public function has_validation_errors()
	{
		return count( $this->get_validation_errors() ) > 0;
	}

	/**
		@brief		Returns whether this input requires validation of any kind.
		@return		bool		True if the input requires any sort of validation.
		@since		20130524
	**/
	public function requires_validation()
	{
		return ( $this->is_required() || count( $this->validation_methods ) > 0 );
	}

	/**
		@brief		Creates and returns a brand new validation error.
		@details	Adds it to the list of validation errors and returns it.
		@return		\\plainview\\sdk_eightb_sold_alerts\\form2\\validation\\error		A new validation error.
		@since		20130524
	**/
	public function validation_error()
	{
		$error = new \plainview\sdk_eightb_sold_alerts\form2\validation\error( $this );
		$this->add_validation_error( $error );
		return $error;
	}

	/**
		@brief		Validates the input.
		@details	Goes through all the validation methods and then returns this class.
		@return		this		Object chaining.
		@since		20130524
	**/
	public function validate()
	{
		$this->has_validated = true;
		$this->validation_value = $this->get_post_value();

		// The required attribute requires special treatment because the HTML element itself has a required() global attribute setter.
		if ( $this->is_required() )
			$this->add_validation_method( 'required' );

		foreach( $this->validation_methods as $method )
			call_user_func_array( $method, array( $this ) );

		return $this;
	}

	/**
		@brief		Validates the input according to the required attribute.
		@see		validate()
		@since		20130524
	**/
	public function validate_required()
	{
		$check_value = $this->validation_value;
		$error = false;

		if ( is_string( $check_value ) )
		{
			$check_value = trim( $check_value );
			$error = strlen( $check_value ) < 1;
		}
		else
			$error = $check_value === null;

		if ( $error )
		{
			$text = $this->form()->_( 'Please fill in %s.', '<em>' . $this->get_label()->content . '</em>' );
			$this->validation_error()->set_unfiltered_label_( $text );
		}
	}

	/**
		@brief		Does this input validate?
		@return		bool		True, if the input validates correctly.
		@since		20130524
	**/
	public function validates()
	{
		if ( ! $this->has_validated() )
			$this->validate();
		return count( $this->get_validation_errors() ) < 1;
	}
}