Ubuntu
*/
protected $localize = [];
/**
* @var array{after:string[], before:string[]}
*/
protected $inlineScripts = ['after' => [], 'before' => []];
/**
* @var bool
*/
protected $inFooter = \true;
/**
* @var array{domain:string, path:string|null}
*/
protected $translation = ['domain' => '', 'path' => null];
/**
* @var bool
*/
protected $resolvedDependencyExtractionPlugin = \false;
/**
* @return array
*/
public function localize(): array
{
$output = [];
foreach ($this->localize as $objectName => $data) {
$output[$objectName] = is_callable($data) ? $data() : $data;
}
return $output;
}
/**
* @param string $objectName
* @param string|int|array|callable $data
*
* @return static
*
* phpcs:disable Inpsyde.CodeQuality.ArgumentTypeDeclaration
*/
public function withLocalize(string $objectName, $data): \Inpsyde\Assets\Script
{
// phpcs:enable Inpsyde.CodeQuality.ArgumentTypeDeclaration
$this->localize[$objectName] = $data;
return $this;
}
/**
* @return bool
*/
public function inFooter(): bool
{
return $this->inFooter;
}
/**
* @return static
*/
public function isInFooter(): \Inpsyde\Assets\Script
{
$this->inFooter = \true;
return $this;
}
/**
* @return static
*/
public function isInHeader(): \Inpsyde\Assets\Script
{
$this->inFooter = \false;
return $this;
}
/**
* @return array{before:string[], after:string[]}
*/
public function inlineScripts(): array
{
return $this->inlineScripts;
}
/**
* @param string $jsCode
*
* @return static
*/
public function prependInlineScript(string $jsCode): \Inpsyde\Assets\Script
{
$this->inlineScripts['before'][] = $jsCode;
return $this;
}
/**
* @param string $jsCode
*
* @return static
*/
public function appendInlineScript(string $jsCode): \Inpsyde\Assets\Script
{
$this->inlineScripts['after'][] = $jsCode;
return $this;
}
/**
* @return array{domain:string, path:string|null}
*/
public function translation(): array
{
return $this->translation;
}
/**
* @param string $domain
* @param string|null $path
*
* @return static
*/
public function withTranslation(string $domain = 'default', string $path = null): \Inpsyde\Assets\Script
{
$this->translation = ['domain' => $domain, 'path' => $path];
return $this;
}
/**
* Wrapper function to set AsyncScriptOutputFilter as filter.
*
* @return static
* @deprecated use Script::withAttributes(['async' => true]);
*/
public function useAsyncFilter(): \Inpsyde\Assets\Script
{
$this->withAttributes(['async' => \true]);
return $this;
}
/**
* Wrapper function to set DeferScriptOutputFilter as filter.
*
* @return static
* @deprecated use Script::withAttributes(['defer' => true]);
*/
public function useDeferFilter(): \Inpsyde\Assets\Script
{
$this->withAttributes(['defer' => \true]);
return $this;
}
/**
* {@inheritDoc}
*/
protected function defaultHandler(): string
{
return ScriptHandler::class;
}
/**
* @deprecated when calling Script::version() or Script::dependencies(),
* we will automatically resolve the dependency extraction plugin files.
* This method will be removed in future.
*
* @see https://github.com/WordPress/gutenberg/tree/master/packages/dependency-extraction-webpack-plugin
*/
public function useDependencyExtractionPlugin(): \Inpsyde\Assets\Script
{
return $this;
}
/**
* {@inheritDoc}
*/
public function version(): ?string
{
$this->resolveDependencyExtractionPlugin();
return parent::version();
}
/**
* {@inheritDoc}
*/
public function dependencies(): array
{
$this->resolveDependencyExtractionPlugin();
return parent::dependencies();
}
/**
* @return bool
*
* phpcs:disable WordPress.PHP.NoSilencedErrors.Discouraged
* phpcs:disable VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
* @psalm-suppress MixedArrayAccess
* @psalm-suppress PossiblyFalseArgument
* @psalm-suppress UnresolvableInclude
*/
protected function resolveDependencyExtractionPlugin(): bool
{
if ($this->resolvedDependencyExtractionPlugin) {
return \false;
}
$this->resolvedDependencyExtractionPlugin = \true;
$depsFile = $this->findDepdendencyFile();
if (!$depsFile) {
return \false;
}
$depsFilePath = $depsFile->getPathname();
$data = $depsFile->getExtension() === 'json' ? @json_decode(@file_get_contents($depsFilePath), \true) : @require $depsFilePath;
/** @var string[] $dependencies */
$dependencies = $data['dependencies'] ?? [];
/** @var string|null $version */
$version = $data['version'] ?? null;
$this->withDependencies(...$dependencies);
if (!$this->version && $version) {
$this->withVersion($version);
}
return \true;
}
/**
* Searching for in directory of the Script:
*
* - {fileName}.asset.json
* - {fileName}.{hash}.asset.json
* - {fileName}.asset.php
* - {fileName}.{hash}.asset.php
*
* @return \DirectoryIterator|null
*/
protected function findDepdendencyFile(): ?\DirectoryIterator
{
try {
$filePath = $this->filePath();
if ($filePath === '') {
return null;
}
$path = dirname($filePath) . '/';
$fileName = str_replace([$path, '.js'], '', $filePath);
// It might be possible that the script file contains a version hash as well.
// So we need to split it apart and just use the first part of the file.
$fileNamePieces = explode('.', $fileName);
$fileName = $fileNamePieces[0];
$regex = '/' . $fileName . '(?:\.[a-zA-Z0-9]+)?\.asset\.(json|php)/';
$depsFile = null;
foreach (new \DirectoryIterator($path) as $fileInfo) {
if ($fileInfo->isDot() || $fileInfo->isDir() || !in_array($fileInfo->getExtension(), ['json', 'php'], \true)) {
continue;
}
if (preg_match($regex, $fileInfo->getFilename())) {
$depsFile = $fileInfo;
break;
}
}
return $depsFile;
} catch (\Throwable $exception) {
return null;
}
}
}