PHP Replace Dynamic String: Generate a random string from a template

Recommend this page to a friend!
  Info   View files Documentation   View files View files (6)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog (1)    
Last Updated Ratings Unique User Downloads Download Rankings
2020-07-14 (2 months ago) RSS 2.0 feedNot enough user ratingsTotal: 70 All time: 9,701 This week: 259Up
Version License PHP version Categories
dynamicstring 1.0MIT/X Consortium ...5PHP 5, Text processing
Description Author

This package can generate a random string from a template.

It takes as parameter a string with a template defining sections that are fixed and sections that may vary between alternatives given in the template string.

The class returns a new string made of the fixed parts of the string and replaces the variable parts with one of the alternatives given in the template.

Innovation Award
PHP Programming Innovation award nominee
July 2020
Number 9
Sometimes applications need to generate random strings that follow a certain pattern.

This package can generate random strings from a template that contains not only the fixed part of the pattern, but also all the possible alternatives that the variable parts may contain.

This allows applications to define random string patterns as a single string. Then this package can generate many variants of the type of random string that the applications need to be generated.

Manuel Lemos
Picture of Stefano Azzolini
  Performance   Level  
Name: Stefano Azzolini <contact>
Classes: 2 packages by
Country: Italy Italy
Age: 39
All time rank: 3995167 in Italy Italy
Week rank: 625 Up30 in Italy Italy Up
Innovation award
Innovation award
Nominee: 1x

Details

DynamicString

> Generate random strings from templates.

Latest Stable Version Total Downloads Latest Unstable Version License

Installation

Install via composer:

$ composer require lastguest/dynamic-string

How to use

$generator = new DynamicString();
echo $generator->render("I want a (fried|double|spicy) (tuna|salmon|crab) (sushi|(ura|te)maki), please.");

Templates

Use () for define a group that will be replaced by one of the contained alternatives, random selected.

The | character is used as a separator for multiple choices.

This template will render Yes or No randomly :

(Yes|No)

Groups can be nested, they will resolved with a deep-first order.

This template will render Finger, Fingers, Hand, Hands randomly :

(Finge(r|rs)|Han(d|ds))

A complete template for generate random Sushi orders :

I want a (fried|double|spicy) (tuna|salmon|crab) (sushi|(ura|te)maki), please.

Some outputs :

I want a spicy salmon sushi, please.
I want a double tuna uramaki, please.
I want a double salmon temaki, please.
I want a spicy crab sushi, please.

Changing default group envelope and separator

You can change the default group envelope and separator in the DynamicString constructor.

$generator = new DynamicString('<>',',');
echo $generator->render("<public,protected,private> function(<string,array,callable> myVar){};");

Output:

private function(array myVar){};

Other examples

A fun use for DynamicString: a fantasy RPG stories generator.

$generator = new DynamicString();

$name = "(Quick|Fast|Wet|Rusty|Warm|Curved|Old|Terror|Notched|Smelly|Loud|Heavy|Shiny|Sparkling|Fire|Laser|Cold|Fizzle|Power|Bad|Good|Rustle|Dark|Smokey|Super|Fishy|Pointy|Flash|Beauty|Bleeding|Foo|Master|Small|Big|Red|Gray|Hairy|Magic|Broken|Sharp|Grand|Straight)(mind|blower|killer|hand|ey(e|es)|fee(t|ts)|finge(r|rs)|nose|armpi(t|ts)|blaster|rhymes|bar|sword|blade|breath)";

$race = "(lion|human|worm|rat|orc|elf|pixie|walrus|rooster|dog|parrot|rabbit)";
$class = "(rogue|paladin|warrior|cook|cleric|psychopath|fisherman|wolf)";
$player = "$name, the $race $class.";

$sillystory = "(A (sloppy|quick|brave|small|gentle|cruel|fabulous|shiny) $class $race, named $name) (jumped onto|walked to|crawled under|entered|sprinted to|runned into) a( rooftop| bridge|n house| wormhole|n inn| dungeon) (shouting|whispering|saying|barfing|asking for) ((ancient|magic|modern|silly|awkward) (words|names|runes|spells|shouts|rhimes|swears|songs|tacos)).";

Now, we can generate a silly story with :

echo $generator->render($sillystory);

Some examples :

A cruel rogue orc, named Smellyarmpits jumped onto an house barfing magic tacos.
A fabulous paladin pixie, named Graybar jumped onto a rooftop shouting silly runes.
A brave paladin worm, named Pointyblaster runned into an inn saying awkward names.
A brave psychopath rooster, named Wetsword entered a bridge whispering silly words.
A shiny paladin worm, named Darkeyes walked to a bridge asking for awkward names.
A small psychopath rooster, named Bleedingbar crawled under an inn saying magic songs.
A sloppy warrior parrot, named Rustyblower jumped onto an house asking for ancient swears.

Or we can generate some fun names for our characters :

echo $generator->render($player);

Badblade, the rabbit cleric.
Hairykiller, the elf fisherman.
Bleedingblower, the pixie psychopath.
Notchedrhymes, the pixie paladin.
Fastfingers, the human psychopath.
Hairyfeets, the pixie fisherman.

License (MIT)

Copyright (c) 2015 Stefano Azzolini

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

  Files folder image Files  
File Role Description
Files folder imagesrc (1 file)
Accessible without login Plain text file .scrutinizer.yml Data Auxiliary data
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  src  
File Role Description
  Plain text file DynamicString.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:70
This week:0
All time:9,701
This week:259Up

For more information send a message to info at phpclasses dot org.