Maslosoft Sprite API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
<?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/sprite
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link http://maslosoft.com/sprite/
*/
namespace Maslosoft\Sprite\Models;
use Maslosoft\Sprite\Generators\CheatSheetGenerator;
use Maslosoft\Sprite\Generators\ConstantsGenerator;
use Maslosoft\Sprite\Generators\CssGenerator;
use Maslosoft\Sprite\Generators\ImgGenerator;
/**
* Configuration
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class Configuration extends Package
{
/**
* Path for temporary files
*
* @var string
*/
public $runtimePath = 'runtime';
/**
* Path for result sprite files
*
* @var string
*/
public $generatedPath = 'generated';
/**
* Base name for generated files
* For example value of `sprite` will result in generating files:
*
* * sprite.css
* * sprite.png
* * sprite.html
*
* @var string
*/
public $basename = 'sprite';
/**
* CSS class name prefix used for all icons.
* This should be something distinctive
* or might match many CSS elements.
*
* @var string
*/
public $iconCssClass = 'icon';
/**
* optimizer: pngcrush {src} {dst}
* @var string
*/
public $optimizer = 'pngquant --ext .png --force {src}';
/**
* Generator classes used to generate files
*
* @var string[]
*/
public $generators = [
CssGenerator::class,
ImgGenerator::class,
CheatSheetGenerator::class,
ConstantsGenerator::class
];
}
API documentation generated by ApiGen