Create beautiful generative background images from a string. Based on jasonlong/geo_pattern

Redeye Group

Last update: Aug 17, 2022

Related tags

Imagery geopattern-php

Overview

GeoPattern

This is a PHP port of jasonlong/geo_pattern.

Generate beautiful tiling SVG patterns from a string. The string is converted into a SHA and a color and pattern are determined based on the values in the hash. The color is determined by shifting the hue and saturation from a default (or passed in) base color. One of 16 patterns is used (or you can specify one) and the sizing of the pattern elements is also determined by the hash values.

You can use the generated pattern as the background-image for a container. Using the base64 representation of the pattern still results in SVG rendering, so it looks great on retina displays.

See the GitHub Guides site as an example of what this library can do. (GitHub Guides uses the original ruby version).

Installation

Run this command in your root project:

composer require redeyeventures/geopattern

Installation (without composer)

Download or clone the src directory from GitHub.

Rename the src folder to GeoPattern and put it somewhere your app can access it from.

Add this line to your code:

require_once('path/to/folder/geopattern_loader.php');

You can then follow the usage instructions below.

Usage

Make a new pattern:

$geopattern = new \RedeyeVentures\GeoPattern\GeoPattern();
$geopattern->setString('Mastering Markdown');

To specify a base background color (with a hue and saturation that adjusts depending on the string):

$geopattern->setBaseColor('#ffcc00');

To use a specific background color (w/o any hue or saturation adjustments):

$geopattern->setColor('#ffcc00');

To use a specific pattern generator:

$geopattern->setGenerator('sine_waves');

Get the SVG string:

$svg = $geopattern->toSVG();

Get the Base64 encoded string:

$base64 = $geopattern->toBase64();

Get a data URI:

$dataURI = $geopattern->toDataURI(); #data:image/svg+xml;base64,...

Get a data URL:

$dataURL = $geopattern->toDataURL(); #url("data:image/svg+xml;base64,...")

You can use the data URL string to set the background:

The setString, setBaseColor, setGenerator methods are chainable. You can also pass an array to the GeoPattern constructor containing the string, baseColor, color, and/or generator values.

If the GeoPattern object is cast as a string, it will provide the SVG string.

Contributing

Fork it ( http://github.com/redeyeventures/geopattern-php/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Original Project

See https://github.com/jasonlong/geo_pattern for more info and links to ports for other languages.

Based on jasonlong/geo_pattern @ ac27b5bb50a8d2061ff63254c915e9ca96a40480.

Comments

Add option to specify exact color

The baseColor option only specifies a relative color that is then shifted in hue and saturation. This adds a new color option that gets passed straight through without further processing.

ref: jasonlong/geo_pattern#31

opened by retlehs 5
1.2.x Update for GeoPattern
As discussed in #5, this is the pull request to merge the updates from my fork. The following summarizes the changes made:

used GeoPattern as the main namespace

removed the geopattern_loader.php loader

updated the library to PSR-2 & PSR-4 compliant

Added Laravel Service Provider and Facade (library still usable without using Laravel)

moved test into the test folder.

This means that test needs to be run using the command phpunit -c test instead.

removed PHPUnit 3.7 from the require-dev in composer.json. Please use composer global require phpunit/phpunit=4.3.* to get phpunit installed.

Added PHP 5.3, 5.4, 5.5, 5.6 for Travis-CI Testing

added PHP CS checking in Travis-CI (found in test/phpcs.xml)

Future Improvements (not in this pull request):

Additional tests required. The current test only tests the SVG class, and methods coverage only at a staggering 51.72%.

Reduce LOC on GeoPattern class. 1200+ lines of code is horrendous. I saw a lot of repeated code, maybe we can abstract them better.
opened by mauris 0
How to change size or zoom of SVG?

I would like the pattern to appear larger in the image. I am converting the SVG to a PNG but when increasing the size of SVG with Intervention it loses its quality.

opened by syclone 0
Allow user to get HSL values for generated base colour

Moves the colour generation into its own function that is public.

This lets the user (me) get the colour that geo pattern decided to use for the background and use it elsewhere. For my uses I wanted links on the page to match the colour of the pattern for the page title.

opened by Arcath 1
Syntax error after adding first time

Hi,

Thanks for your efforts, it looks awesome!

I added the library without composer exactly as mentioned in readme. Hovewer i got this error, here is the stack:

Parse error: syntax error, unexpected '[' in /lib/GeoPattern/GeoPattern/SVGElements/Circle.php on line 9 Call Stack: 0.0016 802496 1. {main}() /www/store/mustafa/index.php:0 0.0017 803008 2. require_once('/lib/GeoPattern/geopattern_loader.php')

Do you think it is my fault or a bug?

opened by diki 6

Releases(v1.1.2)

v1.1.2(Mar 16, 2021)

Source code(tar.gz)
Source code(zip)
v1.1.1(Oct 21, 2014)

XML generated is now fully valid. Thanks @abbert
Source code(tar.gz)
Source code(zip)
v1.1.0(Jul 23, 2014)

Added option to manually specify the exact color used.
Source code(tar.gz)
Source code(zip)
v1.0.0(Feb 26, 2014)

First stable release
Source code(tar.gz)
Source code(zip)