espocrm/application/Espo/Core/Utils/File/ClassParser.php

<?php

namespace Espo\Core\Utils\File;

use \Espo\Core\Utils\Util;

class ClassParser 
{
	private $fileManager;

	private $config;

	private $metadata;

	protected $cacheFile = null;

	protected $allowedMethods = array(
		'run',
	);

	public function __construct(\Espo\Core\Utils\File\Manager $fileManager, \Espo\Core\Utils\Config $config, \Espo\Core\Utils\Metadata $metadata)
	{
		$this->fileManager = $fileManager;
		$this->config = $config;
		$this->metadata = $metadata;
	}

	protected function getFileManager()
	{
		return $this->fileManager;
	}

	protected function getConfig()
	{
		return $this->config;
	}

	protected function getMetadata()
	{
		return $this->metadata;
	}

	public function setAllowedMethods(array $methods)
	{
		$this->allowedMethods = $methods;
	}



	/**
	 * Return path data of classes
	 * @param  string  $cacheFile full path for a cache file, ex. data/cache/application/entryPoints.php
	 * @param  string | array $paths in format array(
	 *	'corePath' => '',
     *	'modulePath' => '',
     *	'customPath' => '',
	 * );
	 * @return array 
	 */
	public function getData($paths, $cacheFile = false)
	{		
		$data = null;

		if (is_string($paths)) {
			$paths = array(
				'corePath' => $paths,	
			);	
		}

		if ($cacheFile && file_exists($cacheFile) && $this->getConfig()->get('useCache')) {
			$data = $this->getFileManager()->getContents($cacheFile);
		} else {					
			$data = $this->getClassNameHash( $this->getInitPaths($paths) );

			if (isset($paths['modulePath'])) {
				foreach ($this->getMetadata()->getModuleList() as $moduleName) {
		    		$path = str_replace('{*}', $moduleName, $paths['modulePath']);	    		

					$data = array_merge($data, $this->getClassNameHash(array($path)));
		    	}	
			}
	    	
	    	if ($cacheFile && $this->getConfig()->get('useCache')) {
				$result = $this->getFileManager()->putContentsPHP($cacheFile, $data);
				if ($result == false) {
			    	throw new \Espo\Core\Exceptions\Error();
				}
			}
		}

		return $data;
	}
	

	protected function getClassNameHash(array $dirs)
	{
		$data = array();
		foreach ($dirs as $dir) {	      
			if (file_exists($dir)) {
	        	$fileList = $this->getFileManager()->getFileList($dir, false, '\.php$', 'file');	        	

	            foreach ($fileList as $file) {					
					$filePath = Util::concatPath($dir, $file);
                	$className = Util::getClassName($filePath);       
                	$fileName = $this->getFileManager()->getFileName($filePath); 
                	$fileName = ucfirst($fileName); 

					foreach ($this->allowedMethods as $methodName) {	
						if (method_exists($className, $methodName)) {							
							$data[$fileName] = $className;
						}
					}					
					
	            }
			}
		}
		return $data;
	}  

	/**
	 * Get init paths like corePath and/or customPath
	 * @param  array  $paths 
	 * @return array        
	 */
	protected function getInitPaths(array $paths)
	{
		$allowedInitPath = array(
			'corePath', 
			'customPath', 
		);

		$initPaths = array();

		foreach ($allowedInitPath as $pathName) {
			if (isset($paths[$pathName])) {
				$initPaths[] = $paths[$pathName];	
			}
		}

		return $initPaths;
	}
}