invoiceninja/app/Utils/Traits/ClientGroupSettingsSaver.php

<?php
/**
 * Invoice Ninja (https://invoiceninja.com)
 *
 * @link https://github.com/invoiceninja/invoiceninja source repository
 *
 * @copyright Copyright (c) 2019. Invoice Ninja LLC (https://invoiceninja.com)
 *
 * @license https://opensource.org/licenses/AAL
 */

namespace App\Utils\Traits;

use App\DataMapper\CompanySettings;

/**
 * Class ClientGroupSettingsSaver
 * @package App\Utils\Traits
 */
trait ClientGroupSettingsSaver
{

	/**
	 * Saves a setting object
	 *
	 * Works for groups|clients|companies
	 * @param  array $settings The request input settings array
	 * @param  object $entity   The entity which the settings belongs to
	 * @return void           
	 */
	public function saveSettings($settings, $entity)
	{

		if(!$settings)
			return;

		$entity_settings = $this->settings;

		//unset protected properties.
		foreach(CompanySettings::$protected_fields as $field)
			unset($settings[$field]);


		/**
		 * for clients and group settings, if a field is not set or is set to a blank value,
		 * we unset it from the settings object
		 */
		foreach($settings as $key => $value)
		{

			if(!isset($settings->{$key}) || empty($settings->{$key}) || (!is_object($settings->{$key}) && strlen($settings->{$key}) == 0))
				unset($settings->{$key});
			
		}


		$settings = $this->checkSettingType($settings);

		//iterate through set properties with new values;
		foreach($settings as $key => $value)
			$entity_settings->{$key} = $value;

		$entity->settings = $entity_settings;
		$entity->save();

		return $entity_settings;
	}

	/**
	 * Used for custom validation of inbound
	 * settings request.
	 *
	 * Returns an array of errors, or boolean TRUE
	 * on successful validation
	 * @param  array $settings The request() settings array
	 * @return array|bool      Array on failure, boolean TRUE on success
	 */
	public function validateSettings($settings)
	{
		$settings = (object)$settings;
		$casts = CompanySettings::$casts;

		ksort($casts);

		foreach($settings as $key => $value)
		{

			if(!isset($settings->{$key}) || empty($settings->{$key}) || (!is_object($settings->{$key}) && strlen($settings->{$key}) == 0))
				unset($settings->{$key});
			
		}

		foreach ($casts as $key => $value){

			/*Separate loop if it is a _id field which is an integer cast as a string*/
			if(substr($key, -3) == '_id' || substr($key, -14) == 'number_counter'){
				$value = "integer";
				
				if(!property_exists($settings, $key)){
					continue;
				}
				else if(!$this->checkAttribute($value, $settings->{$key})){
					return [$key, $value];
				}

				continue;
			}

			/* Handles unset settings or blank strings */
			if(!property_exists($settings, $key) || is_null($settings->{$key}) || !isset($settings->{$key}) || $settings->{$key} == '')
				continue;
			

			/*Catch all filter */
			if(!$this->checkAttribute($value, $settings->{$key}))
				return [$key, $value];
			

		}

		return true;
	}

	/**
	 * Checks the settings object for 
	 * correct property types.
	 *
	 * The method will drop invalid types from 
	 * the object and will also settype() the property
	 * so that it can be saved cleanly
	 * 
	 * @param  array $settings The settings request() array
	 * @return object          stdClass object
	 */
	private function checkSettingType($settings) : \stdClass
	{
		$settings = (object)$settings;
		$casts = CompanySettings::$casts;
		
		foreach ($casts as $key => $value){

			/*Separate loop if it is a _id field which is an integer cast as a string*/
			if(substr($key, -3) == '_id' || substr($key, -14) == 'number_counter'){
				$value = "integer";
				
				if(!property_exists($settings, $key)){
					continue;
				}
				elseif($this->checkAttribute($value, $settings->{$key})){

					if(substr($key, -3) == '_id')
						settype($settings->{$key}, 'string');
					else
						settype($settings->{$key}, $value);
					
				}
				else {
					unset($settings->{$key});
				}

				continue;
			}

			/* Handles unset settings or blank strings */
			if(!property_exists($settings, $key) || is_null($settings->{$key}) || !isset($settings->{$key}) || $settings->{$key} == ''){
				continue;
			}

			/*Catch all filter */
			if($this->checkAttribute($value, $settings->{$key})){

				if($value == 'string' && is_null($settings->{$key}))
					$settings->{$key} = '';

				settype($settings->{$key}, $value);
			}
			else {
				unset($settings->{$key});
			}

		}
		return $settings;
	}
	

	/**
	 * Type checks a object property.
	 * @param  string $key   The type
	 * @param  string $value The object property
	 * @return bool        TRUE if the property is the expected type
	 */
	private function checkAttribute($key, $value) :bool
	{
		switch ($key)
		{
			case 'int':
			case 'integer':
				return ctype_digit(strval($value));
			case 'real':
			case 'float':
			case 'double':
				return is_float($value) || is_numeric(strval($value));
			case 'string':
				return method_exists($value, '__toString' ) || is_null($value) || is_string($value);
			case 'bool':
			case 'boolean':
				return is_bool($value) || (int) filter_var($value, FILTER_VALIDATE_BOOLEAN);
			case 'object':
				return is_object($value);
			case 'array':
				return is_array($value);
			case 'json':
				json_decode($string);
 					return (json_last_error() == JSON_ERROR_NONE);
			default:
				return false;
		}
	}

}