initial commit

Author: frederikbosch

.gitignore

@@ -0,0 +1,4 @@
+/.idea
+/output
+/composer.lock
+/vendor

README.md

@@ -0,0 +1,50 @@
+# Genkgo/Favicon - Generate favicon for your website
+
+[![Latest Version](https://img.shields.io/github/release/genkgo/favicon.svg?style=flat-square)](https://github.com/genkgo/favicon/releases)
+
+## Create favicon package quick and easy
+
+```php
+
+use Genkgo\Favicon;
+
+$outputDirectory = '/var/www/html/favicon';
+
+$input = Input::fromFile('/var/www/html/logo.png', InputImageType::PNG);
+// or
+$input = Input::fromFile('/var/www/html/logo.svg', InputImageType::SVG);
+// or
+$input = Favicon\Input::letter('G', '#FFFFFF', '#00aaad');
+
+$generator = new Favicon\FullPackageGenerator($input, '#FFFFFF');
+foreach ($generator->package() as $fileName => $contents) {
+    $pathName = $outputDirectory . '/' . $fileName;
+    file_put_contents($pathName, $contents);
+}
+```
+
+## Default package
+
+- android-chrome-192x192.png
+- android-chrome-512x512.png
+- apple-touch-icon.png
+- browserconfig.xml
+- favicon.ico
+- favicon.png
+- favicon-16x16.png
+- favicon-32x32.png
+- favicon-48x48.ico
+- favicon-48x48.png
+- favicon-57x57.png
+- favicon-76x76.png
+- favicon-96x96.png
+- favicon-128x128.png
+- favicon-192x192.png
+- favicon-228x228.png
+- mstile-70x70.png
+- mstile-150x150.png
+- mstile-310x310.png
+
+## Tests
+
+There are no tests.

asset/genkgo-icon-1024.png

@@ -0,0 +1,66 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types=1);
+
+use Genkgo\Favicon\AggregatePackage;
+use Genkgo\Favicon\AndroidChromePackage;
+use Genkgo\Favicon\AppleTouchIconPackage;
+use Genkgo\Favicon\FullPackageGenerator;
+use Genkgo\Favicon\GenericIcoPackage;
+use Genkgo\Favicon\GenericPngPackage;
+use Genkgo\Favicon\MicrosoftTilePackage;
+use Genkgo\Favicon\Input;
+use Genkgo\Favicon\InputImageType;
+
+function writeln(string $line, string|int ... $values) {
+    echo sprintf($line, ...$values) . "\n";
+}
+
+(function ($arguments) {
+    error_reporting(-1);
+
+    $dir = __DIR__.'/..';
+
+    if (!file_exists($dir.'/autoload.php')) {
+        $dir = __DIR__.'/../vendor';
+    }
+
+    if (!file_exists($dir.'/autoload.php')) {
+        $dir = __DIR__.'/../../..';
+    }
+
+    if (!file_exists($dir.'/autoload.php')) {
+        writeln('Autoload not found.');
+        exit(1);
+    }
+
+    require $dir.'/autoload.php';
+
+    if (!array_key_exists(1, $arguments)) {
+        writeln('[ERROR] Source image is required');
+        exit(1);
+    }
+
+    $sourceFile = $arguments[1];
+    if (!file_exists($sourceFile)) {
+        writeln('[ERROR] Source image %s does not exist', $sourceFile);
+        exit(1);
+    }
+
+//    $input = Input::fromFile($sourceFile, InputImageType::PNG);
+    $input = Input::letter('G', '#FFFFFF', '#00aaad');
+    $outputDirectory = $arguments[2] ?? getcwd();
+    $tileColor = $arguments[3] ?? '#FFFFFF';
+    $rootPrefix = $arguments[4] ?? '/';
+
+    $generator = new FullPackageGenerator($input, $tileColor, $rootPrefix);
+    foreach ($generator->package() as $fileName => $contents) {
+        $pathName = $outputDirectory . '/' . $fileName;
+        $result = file_put_contents($pathName, $contents);
+        if ($result === false) {
+            writeln('[ERROR] Failed to save %s', $pathName);
+        } else {
+            writeln('[INFO] Saved %s with size %s', $pathName, filesize($pathName));
+        }
+    }
+})($argv);

asset/genkgo-rondo-1024.svg

@@ -0,0 +1,20 @@
+{
+  "name": "genkgo/favicon",
+  "description": "Generate browser favicons",
+  "license": "MIT",
+  "require": {
+    "php": "~8.1.0 || ~8.2.0",
+    "ext-imagick": "*",
+    "ext-dom": "*"
+  },
+  "autoload": {
+    "psr-4": {
+      "Genkgo\\Favicon\\": ["src"]
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Genkgo\\TestFavicon\\": ["test"]
+    }
+  }
+}

bin/favicon-generator

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Genkgo\Favicon;
+
+final class AggregatePackage implements PackageAppendInterface
+{
+    /**
+     * @param iterable<int|string, PackageAppendInterface> $generators
+     */
+    public function __construct(private readonly iterable $generators)
+    {
+    }
+
+    /**
+     * @return \Generator<string, string>
+     */
+    public function package(): \Generator
+    {
+        foreach ($this->generators as $generator) {
+            yield from $generator->package();
+        }
+    }
+}

composer.json

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Genkgo\Favicon;
+
+final class AndroidChromePackage implements PackageAppendInterface
+{
+    /**
+     * @param array<int, int> $sizes
+     */
+    public function __construct(
+        private readonly Input $input,
+        private readonly array $sizes = [192, 512],
+        private readonly ?string $backgroundColor = null,
+    ) {
+    }
+
+    public function package(): \Generator
+    {
+        foreach ($this->sizes as $size) {
+            $generator = new PngGenerator($this->input, $size, $this->backgroundColor);
+            yield 'android-chrome-' . $size . 'x' . $size . '.png' => $generator->generate();
+        }
+    }
+}

src/AggregatePackage.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Genkgo\Favicon;
+
+final class AppleTouchIconPackage implements PackageAppendInterface
+{
+    public function __construct(
+        private readonly Input $input,
+        private readonly int $size = 180,
+        private readonly ?string $backgroundColor = null,
+    ) {
+    }
+
+    public function package(): \Generator
+    {
+        $generator = new PngGenerator($this->input, $this->size, $this->backgroundColor);
+        yield 'apple-touch-icon.png' => $generator->generate();
+    }
+}

src/AndroidChromePackage.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Genkgo\Favicon;
+
+final class BrowserConfigXmlGenerator implements GeneratorInterface
+{
+    public function __construct(
+        private readonly string $tileColor,
+        private readonly array $formats,
+        private readonly string $rootPrefix = '/',
+    ) {
+    }
+
+    public function generate(): string
+    {
+        $document = new \DOMDocument('1.0', 'UTF-8');
+        $document->formatOutput = true;
+        $root = $document->createElement('browserconfig');
+        $document->appendChild($root);
+
+        $rootPrefix = $this->rootPrefix;
+        if (\substr($rootPrefix, -1, 1) === '/') {
+            $rootPrefix = \substr($rootPrefix, 0, -1);
+        }
+
+        $msApplication = $document->createElement('msapplication');
+        $tile = $document->createElement('tile');
+        foreach ($this->formats as $size => $file) {
+            $tileType = $document->createElement($size . 'logo');
+            $tileType->setAttribute('src', $rootPrefix . '/' . $file);
+            $tile->appendChild($tileType);
+        }
+
+        $tileColor = $document->createElement('TileColor', $this->tileColor);
+        $tile->appendChild($tileColor);
+        $msApplication->appendChild($tile);
+
+        $root->appendChild($msApplication);
+        return $document->saveXML();
+    }
+}

src/AppleTouchIconPackage.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Genkgo\Favicon;
+
+final class FullPackageGenerator implements PackageAppendInterface
+{
+    public function __construct(
+        private readonly Input $input,
+        private readonly string $tileColor,
+        private readonly string $rootPrefix = '/',
+    ) {
+    }
+
+    public function package(): \Generator
+    {
+        $generator = new AggregatePackage([
+            new GenericIcoPackage($this->input),
+            new GenericPngPackage($this->input),
+            new AppleTouchIconPackage($this->input),
+            new AndroidChromePackage($this->input),
+            new MicrosoftTilePackage($this->input, $this->tileColor, $this->rootPrefix),
+        ]);
+        return $generator->package();
+    }
+}

src/BrowserConfigXmlGenerator.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Genkgo\Favicon;
+
+interface GeneratorInterface
+{
+    /**
+     * @throws \ImagickException
+     */
+    public function generate(): string;
+}

src/FullPackageGenerator.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Genkgo\Favicon;
+
+final class GenericIcoPackage implements PackageAppendInterface
+{
+    /**
+     * @param array<int, int> $sizes
+     */
+    public function __construct(
+        private readonly Input $input,
+        private readonly array $sizes = [48],
+        private readonly ?string $backgroundColor = null,
+    ) {
+    }
+
+    public function package(): \Generator
+    {
+        $first = true;
+        foreach ($this->sizes as $size) {
+            $generator = new IcoGenerator($this->input, $size, $this->backgroundColor);
+            $blob = $generator->generate();
+            if ($first) {
+                yield 'favicon.ico' => $blob;
+            }
+
+            $first = false;
+            yield 'favicon-' . $size . 'x' . $size . '.ico' => $blob;
+        }
+    }
+}