Download the PHP package betobetok/ask-svg without Composer

ASK - PHP Svg Manipulation

A package to convert an svg graphic file into a Php object. based on Blade UIkit

by using the svg() function we can retrieve an svg file using the file name and convert it into an object of the Svg class and manipulate it as such.

svg file my_svg.svg

The Svg class

 Full name: \ASK\Svg\Svg

the Svg document

Class Svg implements:

Svg Properties

Svg Methods

The SvgElement class

 Full name: \ASK\Svg\SvgElement

An element belonging to a svg structure

This object represents all the elements within an svg document

from the svg parent element to the internal elements or figures such as \<path\>, \<circle\> or \<g\>, passing through configuration elements such as \<style\>, \<defs\> among others

all elements are accessible in order through the attribute $elements, as well as through the array in the property with the name of the element

for example:

• $svg->g returns all <g> elements
• $svg->elements[0] return the first element in the <svg></svg>
• $svg->g[0]->elements[0] return the first element in the <g></g>

Class SvgElement implements:

SvgElement Properties

SvgElement Methods

The abstract class Shape

 Full name: \ASK\Svg\Shapes\Shape

An element that make a Shape in a svg document

Shape Properties

Shape Methods

Class Circle

 Full name: \ASK\Svg\Shapes\Circle

A Circle element in a svg document

Class Circle inherits from class:

Circle Properties

Methods

Class Ellipse

 Full name: \ASK\Svg\Shapes\Ellipse

A Ellipse element in a svg document

Class Ellipse inherits from class:

Ellipse Properties

Methods

Class Line

 Full name: \ASK\Svg\Shapes\Line

A Line element in a svg document

Class Line inherits from class:

Line Properties

Methods

Class Path

 Full name: \ASK\Svg\Shapes\Path

A Path element in a svg document

Class Path inherits from class:

Path Properties

Methods

Class Polygon

 Full name: \ASK\Svg\Shapes\Polygon

A Polygon element in a svg document

Class Polygon inherits from class:

Polygon Properties

Methods

Class Polyline

 Full name: \ASK\Svg\Shapes\Polyline

A Polyline element in a svg document

Class Polyline inherits from class:

Polyline Properties

Methods

Class Rect

 Full name: \ASK\Svg\Shapes\Rect

A Rect element in a svg document

Class Rect inherits from class:

Rect Properties

Methods

Class Text

 Full name: \ASK\Svg\Shapes\Text

a Text element in a svg document

Class Text inherits from class:

Text Properties

Methods

The abstract class Command

 Full name: \ASK\Svg\DCommands\Command

A command in a d attribute of a svg path

There are five line commands for <path> nodes.

• M - Move
• L - Line
• H - Horizontal
• V - Vertical
• Z - Close

und five arc commands.

• C - Cubic Curve
• Q - Quadratic Curve
• S - Short Cubic Curve
• T - Together Multiple Quadratic Curve
• A - Arc

Each command contains a $coordinates array with all the parameters of each point, as well as a reference to the previous command.

Class Command implements:

Command Properties

Command Methods

Class A

 Full name: \ASK\Svg\DCommands\A

A comand "a" in a d attribute of a svg path

Arcs are sections of circles or ellipses. For a given x-radius and y-radius, there are two ellipses that can connect any two points (last end point and (x, y)). Along either of those circles, there are two possible paths that can be taken to connect the points (large way or short way) so in any situation, there are four possible arcs available.

Because of that, arcs require seven parameters: A rx ry x-axis-rotation large-arc-flag sweep-flag x y

a rx ry x-axis-rotation large-arc-flag sweep-flag dx dy

A command hat in aditional to the other commands a getCenter Methode

Class A inherits from class:

A Properties

Methods

Class C

 Full name: \ASK\Svg\DCommands\C

A comand "c" in a d attribute of a svg path

The cubic curve, C, is the slightly more complex curve. Cubic Béziers take in two control points for each point. Therefore, to create a cubic Bézier, three sets of coordinates need to be specified.

C x1 y1, x2 y2, x y c dx1 dy1, dx2 dy2, dx dy

Class C inherits from class:

C Properties

Methods

Class H

 Full name: \ASK\Svg\DCommands\H

A comand "h" in a d attribute of a svg path

A command draws a horizontal line, this command only take one parameter since they only move in one direction.

H x h dx

Class H inherits from class:

H Properties

Methods

Class L

 Full name: \ASK\Svg\DCommands\L

A comand "h" in a d attribute of a svg path

L x y l dx dy

Class L inherits from class:

L Properties

Methods

Class M

 Full name: \ASK\Svg\DCommands\M

A comand "m" in a d attribute of a svg path

M x y m dx dy

Class M inherits from class:

M Properties

Methods

Class Q

 Full name: \ASK\Svg\DCommands\Q

A comand "q" in a d attribute of a svg path

Q x1 y1, x y q dx1 dy1, dx dy

Class Q inherits from class:

Q Properties

Methods

Class S

 Full name: \ASK\Svg\DCommands\S

A comand "s" in a d attribute of a svg path

S x2 y2, x y s dx2 dy2, dx dy

Class S inherits from class:

S Properties

Methods

Class T

 Full name: \ASK\Svg\DCommands\T

A comand "t" in a d attribute of a svg path

T x y t dx dy

Class T inherits from class:

T Properties

Methods

Class V

 Full name: \ASK\Svg\DCommands\V

A comand "v" in a d attribute of a svg path

V y v dy

Class V inherits from class:

V Properties

Methods

Class Z

 Full name: \ASK\Svg\DCommands\Z

A comand "z" in a d attribute of a svg path

Class Z inherits from class:

Z Properties

Methods

alphabetical listing

• Svg - the Svg document.
• SvgElement - # An element belonging to a svg structure.
• Shape - An element that make a Shape in a svg document.
  • Circle - A Circle element in a svg document.
  • Ellipse - A Ellipse element in a svg document.
  • Line - A Line element in a svg document.
  • Path - A Path element in a svg document.
  • Polygon - A Polygon element in a svg document.
  • Polyline - A Polyline element in a svg document.
  • Rect - A Rect element in a svg document.
  • Text - a Text element in a svg document.
• Command - A command in a d attribute of a svg path.
  • A - A comand "a" in a d attribute of a svg path.
  • C - A comand "c" in a d attribute of a svg path.
  • H - A comand "h" in a d attribute of a svg path.
  • L - A comand "h" in a d attribute of a svg path.
  • M - A comand "m" in a d attribute of a svg path.
  • Q - A comand "q" in a d attribute of a svg path.
  • S - A comand "s" in a d attribute of a svg path.
  • T - A comand "t" in a d attribute of a svg path.
  • V - A comand "v" in a d attribute of a svg path.
  • Z - A comand "z" in a d attribute of a svg path.

This file is public domain. Use it for any purpose, including commercial applications. Attribution would be nice, but is not required. There is no warranty of any kind, including its correctness, usefulness, or safety.

Author: Alberto Solorzano Kraemer ( [email protected], @betobetok )

This document was automatically generated from source code comments on 2022-03-25 using phpDocumentor and cvuorinen/phpdoc-markdown-public