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 84 85 86 87 <?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\Helpers\ConstantsFactory;
use Maslosoft\Sprite\Helpers\Namer;
/**
* CheatSheetSprite
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class CheatSheetSprite
{
/**
* Source image as base64 data URL
* @var string
*/
public $image = '';
/**
* Any CSS class, usually first one
* @var string
*/
public $cssClass = '';
/**
* All CSS classes at which icon is available
* @var string[]
*/
public $cssClasses = [];
/**
* All class constants at which sprite is available
* @var string[]
*/
public $constants = [];
/**
* All class constants at which sprite is available - short notation
* @var string[]
*/
public $shortConstants = [];
/**
* Whether has constants
* @var bool
*/
public $hasConstants = false;
public function __construct(SpriteImage $sprite)
{
foreach ($sprite->packages as $package)
{
$this->cssClasses[] = Namer::nameCssClass($package, $sprite);
}
$this->cssClass = $this->cssClasses[0];
$this->cssClasses = array_unique($this->cssClasses);
$this->image = file_get_contents($sprite->getFullPath());
$classes = ConstantsFactory::create([$sprite]);
foreach ($classes as $class)
{
foreach ($class->constants as $const)
{
$name = $const->name;
$this->constants[] = sprintf('%s\\%s::%s', $class->ns, $class->name, $name);
$this->shortConstants[] = sprintf('%s::%s', $class->name, $name);
$this->hasConstants = true;
}
}
}
}
API documentation generated by ApiGen