319 lines
8.3 KiB
PHP
319 lines
8.3 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Component.Builder
|
|
*
|
|
* @created 4th September, 2022
|
|
* @author Llewellyn van der Merwe <https://dev.vdm.io>
|
|
* @git Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
|
|
* @copyright Copyright (C) 2015 Vast Development Method. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
namespace VDM\Joomla\Componentbuilder\Compiler\Library;
|
|
|
|
|
|
use Joomla\CMS\Filesystem\Folder as JoomlaFolder;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Factory as Compiler;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Config;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Registry;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Interfaces\EventInterface;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Component;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Content;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Utilities\Counter;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Utilities\Paths;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Utilities\Folder;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Utilities\File;
|
|
use VDM\Joomla\Componentbuilder\Compiler\Utilities\Indent;
|
|
use VDM\Joomla\Utilities\ObjectHelper;
|
|
use VDM\Joomla\Utilities\ArrayHelper;
|
|
use VDM\Joomla\Utilities\StringHelper;
|
|
use VDM\Joomla\Utilities\FileHelper;
|
|
|
|
|
|
/**
|
|
* Library Structure Builder Class
|
|
*
|
|
* @since 3.2.0
|
|
*/
|
|
class Structure
|
|
{
|
|
/**
|
|
* Compiler Config
|
|
*
|
|
* @var Config
|
|
* @since 3.2.0
|
|
*/
|
|
protected Config $config;
|
|
|
|
/**
|
|
* The compiler registry
|
|
*
|
|
* @var Registry
|
|
* @since 3.2.0
|
|
*/
|
|
protected Registry $registry;
|
|
|
|
/**
|
|
* Compiler Event
|
|
*
|
|
* @var EventInterface
|
|
* @since 3.2.0
|
|
*/
|
|
protected EventInterface $event;
|
|
|
|
/**
|
|
* Compiler Component
|
|
*
|
|
* @var Component
|
|
* @since 3.2.0
|
|
**/
|
|
protected Component $component;
|
|
|
|
/**
|
|
* Compiler Content
|
|
*
|
|
* @var Content
|
|
* @since 3.2.0
|
|
**/
|
|
protected Content $content;
|
|
|
|
/**
|
|
* Compiler Counter
|
|
*
|
|
* @var Counter
|
|
* @since 3.2.0
|
|
*/
|
|
protected Counter $counter;
|
|
|
|
/**
|
|
* Compiler Utilities Paths
|
|
*
|
|
* @var Paths
|
|
* @since 3.2.0
|
|
*/
|
|
protected Paths $paths;
|
|
|
|
/**
|
|
* Compiler Utilities Folder
|
|
*
|
|
* @var Folder
|
|
* @since 3.2.0
|
|
*/
|
|
protected Folder $folder;
|
|
|
|
/**
|
|
* Compiler Utilities File
|
|
*
|
|
* @var File
|
|
* @since 3.2.0
|
|
*/
|
|
protected File $file;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param Config|null $config The compiler config object.
|
|
* @param Registry|null $registry The compiler registry object.
|
|
* @param EventInterface|null $event The compiler event api object.
|
|
* @param Component|null $component The component class.
|
|
* @param Content|null $content The compiler content object.
|
|
* @param Counter|null $counter The compiler counter object.
|
|
* @param Paths|null $paths The compiler paths object.
|
|
* @param Folder|null $folder The compiler folder object.
|
|
* @param File|null $file The compiler file object.
|
|
*
|
|
* @since 3.2.0
|
|
*/
|
|
public function __construct(?Config $config = null, ?Registry $registry = null,
|
|
?EventInterface $event = null, ?Component $component = null,
|
|
?Content $content = null,?Counter $counter = null,
|
|
?Paths $paths = null, ?Folder $folder = null,
|
|
?File $file = null)
|
|
{
|
|
$this->config = $config ?: Compiler::_('Config');
|
|
$this->registry = $registry ?: Compiler::_('Registry');
|
|
$this->event = $event ?: Compiler::_('Event');
|
|
$this->component = $component ?: Compiler::_('Component');
|
|
$this->content = $content ?: Compiler::_('Content');
|
|
$this->counter = $counter ?: Compiler::_('Utilities.Counter');
|
|
$this->paths = $paths ?: Compiler::_('Utilities.Paths');
|
|
$this->folder = $folder ?: Compiler::_('Utilities.Folder');
|
|
$this->file = $file ?: Compiler::_('Utilities.File');
|
|
}
|
|
|
|
/**
|
|
* Build the Libraries files, folders, url's and config
|
|
*
|
|
* @return void
|
|
* @since 3.2.0
|
|
*/
|
|
public function build()
|
|
{
|
|
if (($libraries_ = $this->registry->get('builder.libraries')) !== null)
|
|
{
|
|
// for plugin event TODO change event api signatures
|
|
$component_context = $this->config->component_context;
|
|
|
|
// Trigger Event: jcb_ce_onBeforeSetLibraries
|
|
$this->event->trigger(
|
|
'jcb_ce_onBeforeSetLibraries',
|
|
array(&$component_context, &$libraries_)
|
|
);
|
|
|
|
// creat the main component folder
|
|
if (!JoomlaFolder::exists($this->paths->component_path))
|
|
{
|
|
JoomlaFolder::create($this->paths->component_path);
|
|
|
|
// count the folder created
|
|
$this->counter->folder++;
|
|
$this->file->html('');
|
|
}
|
|
|
|
// create media path if not set
|
|
$this->folder->create($this->paths->component_path . '/media');
|
|
foreach ($libraries_ as $id => &$library)
|
|
{
|
|
if (ObjectHelper::check($library))
|
|
{
|
|
// check if this lib has files
|
|
if (isset($library->files)
|
|
&& ArrayHelper::check($library->files))
|
|
{
|
|
// add to component files
|
|
foreach ($library->files as $file)
|
|
{
|
|
$this->component->appendArray('files', $file);
|
|
}
|
|
}
|
|
|
|
// check if this lib has folders
|
|
if (isset($library->folders)
|
|
&& ArrayHelper::check(
|
|
$library->folders
|
|
))
|
|
{
|
|
// add to component folders
|
|
foreach ($library->folders as $folder)
|
|
{
|
|
$this->component->appendArray('folders', $folder);
|
|
}
|
|
}
|
|
|
|
// check if this lib has urls
|
|
if (isset($library->urls)
|
|
&& ArrayHelper::check($library->urls))
|
|
{
|
|
// build media folder path
|
|
$libFolder = strtolower(
|
|
preg_replace(
|
|
'/\s+/', '-',
|
|
(string) StringHelper::safe(
|
|
$library->name, 'filename', ' ', false
|
|
)
|
|
)
|
|
);
|
|
$mediaPath = '/media/' . $libFolder;
|
|
|
|
// should we add the local folder
|
|
$addLocalFolder = false;
|
|
|
|
// add to component urls
|
|
foreach ($library->urls as $n => &$url)
|
|
{
|
|
if (isset($url['type']) && $url['type'] > 1
|
|
&& isset($url['url'])
|
|
&& StringHelper::check(
|
|
$url['url']
|
|
))
|
|
{
|
|
// create media/lib path if not set
|
|
$this->folder->create(
|
|
$this->paths->component_path . $mediaPath
|
|
);
|
|
|
|
// add local folder
|
|
$addLocalFolder = true;
|
|
|
|
// set file name
|
|
$fileName = basename((string) $url['url']);
|
|
|
|
// get the file contents
|
|
$data = FileHelper::getContent(
|
|
$url['url']
|
|
);
|
|
|
|
// build sub path
|
|
if (strpos($fileName, '.js') !== false)
|
|
{
|
|
$path = '/js';
|
|
}
|
|
elseif (strpos($fileName, '.css') !== false)
|
|
{
|
|
$path = '/css';
|
|
}
|
|
else
|
|
{
|
|
$path = '';
|
|
}
|
|
|
|
// create sub media path if not set
|
|
$this->folder->create(
|
|
$this->paths->component_path . $mediaPath . $path
|
|
);
|
|
|
|
// set the path to library file
|
|
$url['path'] = $mediaPath . $path . '/'
|
|
. $fileName; // we need this for later
|
|
|
|
// set full path
|
|
$path = $this->paths->component_path . $url['path'];
|
|
|
|
// write data to path
|
|
$this->file->write($path, $data);
|
|
|
|
// count the file created
|
|
$this->counter->file++;
|
|
}
|
|
}
|
|
|
|
// only add if local
|
|
if ($addLocalFolder)
|
|
{
|
|
// add folder to xml of media folders
|
|
$this->content->add('EXSTRA_MEDIA_FOLDERS',
|
|
PHP_EOL . Indent::_(2) . "<folder>"
|
|
. $libFolder . "</folder>");
|
|
}
|
|
}
|
|
|
|
// if config fields are found load into component config (avoiding duplicates)
|
|
if (isset($library->how) && $library->how > 1
|
|
&& isset($library->config)
|
|
&& ArrayHelper::check($library->config))
|
|
{
|
|
foreach ($library->config as $cofig)
|
|
{
|
|
$found = array_filter(
|
|
$this->component->get('config'),
|
|
fn($item) => $item['field'] == $cofig['field']
|
|
);
|
|
|
|
// set the config data if not found
|
|
if (!ArrayHelper::check($found))
|
|
{
|
|
$this->component->appendArray('config', $cofig);
|
|
}
|
|
}
|
|
}
|
|
|
|
// update the global value just in case for now
|
|
$this->registry->set("builder.libraries.$id", $library);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
|