7 comments

1. 

   Flyingmana · October 9, 2015 - 4:32 pm · Reply→

   I created an experimental script to make adding the urn to file mapping a bit faster for phpstorm.
   Still needs a bit quality work, but may help some people already.

   
   

   	<?php
   	/**
   	* license is MIT, you will find the text of it in the internet
   	*/
   	echo "start generation script\n";
   	function getAllSchemaFilePaths()
   	{
   	$basedir = getcwd().DIRECTORY_SEPARATOR;
   	$Directory = new RecursiveDirectoryIterator($basedir);
   	$Iterator = new RecursiveIteratorIterator($Directory);
   	$Regex = new RegexIterator($Iterator, '/^.+\.xsd$/i', RecursiveRegexIterator::GET_MATCH);
   	$paths = [];
   	foreach ($Regex as $k => $v) {
   	$paths[] = $k;
   	}
   	return $paths;
   	}
   	function transformXsdPathToMagentoUri($path)
   	{
   	$result = null;
   	$parts = explode(DIRECTORY_SEPARATOR, $path);
   	$parts = array_reverse($parts);
   	if (strpos($path, 'app/code') !== false) {
   	if ($parts[1] == 'etc') {
   	$result = 'urn:magento:module:'.$parts[3].'_'.$parts[2].':etc/'.$parts[0];
   	} elseif ($parts[2] == 'etc') {
   	$result = 'urn:magento:module:'.$parts[4].'_'.$parts[3].':etc/'.$parts[1].'/'.$parts[0];
   	}
   	}
   	if (strpos($path, 'Magento/Framework') !== false) {
   	if ($parts[1] == 'etc') {
   	$result = 'urn:magento:framework:'.$parts[2].'/etc/'.$parts[0];
   	} elseif ($parts[3] == 'Framework') {
   	$result = 'urn:magento:framework:'.$parts[2].'/'.$parts[1].'/'.$parts[0];
   	}
   	}
   	return $result;
   	}
   	function mapFullArray($paths)
   	{
   	$result = [];
   	foreach ($paths as $path) {
   	$transformed = transformXsdPathToMagentoUri($path);
   	if ($transformed !== null) {
   	$result[$path] = $transformed;
   	}
   	}
   	return $result;
   	}
   	function unitTest()
   	{
   	echo "start unitTest:\n";
   	$testArray = [
   	'/work/sandbox/magento2/lib/internal/Magento/Framework/Event/etc/events.xsd' => 'urn:magento:framework:Event/etc/events.xsd',
   	'/work/sandbox/magento2/app/code/Magento/Integration/etc/integration/config.xsd' => 'urn:magento:module:Magento_Integration:etc/integration/config.xsd',
   	'/work/sandbox/magento2/app/code/Magento/Store/etc/config.xsd' => 'urn:magento:module:Magento_Store:etc/config.xsd',
   	];
   	echo PHP_EOL;
   	foreach ($testArray as $input => $expected) {
   	$result = transformXsdPathToMagentoUri($input);
   	$messages = [];
   	if ($result === $expected) {
   	echo '.';
   	} else {
   	echo 'F';
   	$messages[] = $result . ' does not match ' . $expected;
   	}
   	}
   	echo PHP_EOL;
   	if (!empty($messages)) {
   	var_dump($messages);
   	}
   	echo "finish unitTest:\n";
   	}
   	function findUnresolvedPaths()
   	{
   	echo "show unresolved Paths:\n";
   	$paths = getAllSchemaFilePaths();
   	foreach ($paths as $path) {
   	$urn = transformXsdPathToMagentoUri($path);
   	if ($urn === null) {
   	var_dump($path);
   	}
   	}
   	echo 'paths with "/_files/" and also "argument/types.xsd" seem not to require translation?'."\n";
   	foreach (array(
   	'/design/adminhtml/Magento/backend/etc/view.xsd',
   	) as $file) {
   	echo "is '$file' used somewhere via urn?\n";
   	}
   	echo "that were all unresolved Paths:\n";
   	}
   	/**
   	* @param $map
   	*
   	* in phpstorm 8.0 inside .idea/misc.xml
   	* the element <project version="4"> contains an <component name="ProjectResources"> element
   	* with all the mappings for local xsd files
   	*
   	* @return string|void
   	*/
   	function transformMapToPhpstormConfigString($map)
   	{
   	$cwd = getcwd();
   	if (!file_exists($cwd.'/.idea')) {
   	echo "thats not an phpstorm project directory\n";
   	return;
   	}
   	$xml = '';
   	foreach ($map as $path => $urn) {
   	$xml .= '<resource url="'.$urn.'" location="'.str_replace($cwd, '$PROJECT_DIR$', $path).'" />'.PHP_EOL;
   	}
   	$xml = '<component name="ProjectResources">'.PHP_EOL.$xml.PHP_EOL.'</component>';
   	return $xml;
   	}
   	var_dump(transformMapToPhpstormConfigString(mapFullArray(getAllSchemaFilePaths())));
   	//unitTest();
   	//findUnresolvedPaths();
   	echo "finish generation script\n";

   view raw
   
   generate_magento_urn_to_xsd_mapping.php
   
   hosted with ❤ by GitHub

   Thought it makes sense to link it here 🙂

   1. 

      Flyingmana · October 9, 2015 - 4:34 pm · Reply→

      seems Iam not allowed to post an url here <.<

      gist.github.com/Flyingmana
      /c83a09288b666225b5d0

      1. 

         Eugene Tulika · October 30, 2015 - 12:36 pm ·

         Great idea! We pushed it forward and generated a URN catalog for PhpStorm. Can you please take a look? http://magento.stackexchange.com/questions/88242/magento-2-xml-validation/88413#88413

      2. 

         vrann · October 30, 2015 - 12:42 pm ·

         Replied to your comment below.

2. 

   vrann · October 30, 2015 - 12:39 pm · Reply→

   Great idea! We moved it forward and generate complete URN catalog in the PhpStorm format. Can you please take a look? http://magento.stackexchange.com/questions/88242/magento-2-xml-validation/88413#88413

   Also would be helpful to add generation for other IDEs.

3. 

   Dmytro · January 11, 2016 - 7:03 am · Reply→

   Just install https://plugins.jetbrains.com/plugin/8024 go to plugin settings and click “Regenerate urn map” button.
   For feature requests/additional information please refer to https://github.com/dkvashninbay/magento2plugin

4. 

   Magento 2 Developer · August 1, 2016 - 1:21 am · Reply→

   Another tip for phpstorm full support autocomplete in Magento 2:

   http://magento2developer.com/blog/create-class-autocomplete-with-get-in-object-manager-magento2-for-phpstorm.html