<?php

// Copyright (C) 2024 Combodo SAS
//
//   This file is part of iTop.
//
//   iTop is free software; you can redistribute it and/or modify
//   it under the terms of the GNU Affero General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
//   iTop is distributed in the hope that it will be useful,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//   GNU Affero General Public License for more details.
//
//   You should have received a copy of the GNU Affero General Public License
//   along with iTop. If not, see <http://www.gnu.org/licenses/>

/**
 * Usage:
 * require_once(...'introspection.class.inc.php');
 */

require_once('attributedef.class.inc.php');

class Introspection
{
	protected $aAttributeHierarchy = []; // class => child classes
	protected $aAttributes = [];

	public function __construct()
	{
		$this->InitAttributes();
	}

	protected function InitAttributes()
	{
		foreach (get_declared_classes() as $sPHPClass) {
			$oRefClass = new ReflectionClass($sPHPClass);
			if ($sPHPClass == 'AttributeDefinition' || $oRefClass->isSubclassOf('AttributeDefinition')) {
				if ($oParentClass = $oRefClass->getParentClass()) {
					$sParentClass = $oParentClass->getName();
					if (!array_key_exists($sParentClass, $this->aAttributeHierarchy)) {
						$this->aAttributeHierarchy[$sParentClass] = [];
					}
					$this->aAttributeHierarchy[$sParentClass][] = $sPHPClass;
				} else {
					$sParentClass = null;
				}
				$this->aAttributes[$sPHPClass] = [
					'parent' => $sParentClass,
					'LoadInObject' => $sPHPClass::LoadInObject(),
					'LoadFromDB' => $sPHPClass::LoadFromDB(),
					'IsBasedOnDBColumns' => $sPHPClass::IsBasedOnDBColumns(),
					'IsBasedOnOQLExpression' => $sPHPClass::IsBasedOnOQLExpression(),
					'IsExternalField' => $sPHPClass::IsExternalField(),
					'IsScalar' => $sPHPClass::IsScalar(),
					'IsLinkset' => $sPHPClass::IsLinkset(),
					'IsHierarchicalKey' => $sPHPClass::IsHierarchicalKey(),
				];
			}
		}
	}
	public function GetAttributes()
	{
		return $this->aAttributes;
	}
	public function GetAttributeHierarchy()
	{
		return $this->aAttributeHierarchy;
	}
	public function EnumAttributeCharacteristics()
	{
		return [
			'LoadInObject' => 'Is the value stored in the object itself?',
			'LoadFromDB' => 'Is the value read from the DB?',
			'IsBasedOnDBColumns' => 'Is this a value stored within one or several columns?',
			'IsBasedOnOQLExpression' => 'Is this a value computed after other attributes, by the mean of an OQL expression?',
			'IsExternalField' => 'Is this a value stored on a related object (external key)?',
			'IsScalar' => 'Is this a value that makes sense in a SQL/OQL expression?',
			'IsLinkset' => 'Is this a collection (1-N or N-N)?',
			'IsHierarchicalKey' => 'Is this attribute an external key pointing to the host class?',
		];
	}
}
