uksarkar/petname-generator

A PHP package for generating random pet names.

v1.0.2 2024-10-29 12:52 UTC

MIT

• Utpal Sarkar

README

PetNameGenerator is a simple and fun PHP library for generating random pet names. It combines adverbs, adjectives, and animal names to create unique and playful names for pets.

Installation

To install this package, use Composer:

composer require uksarkar/petname-generator

Usage

After installation, you can use the PetNameGenerator class to generate random pet names.

Basic Example

<?php

require __DIR__ . '/vendor/autoload.php';

use PetNameGenerator\PetNameGenerator;

echo PetNameGenerator::generate(); // e.g., "panda"

Custom Word Count and Separator

The generate method allows you to specify the number of words in the name and the separator between words.

<?php

use PetNameGenerator\PetNameGenerator;

// Generate a name with 3 words, separated by a dash
echo PetNameGenerator::generate(3, '-'); // e.g., "merrily-bouncy-tiger"

// Generate a name with 4 words, separated by an underscore
echo PetNameGenerator::generate(4, '_'); // e.g., "quickly_silly_fox_brave"

API

generate(int $wordCount = 2, string $separator = ' '): string

Generates a random pet name.

• $wordCount: (optional) The number of words in the generated name. Default is 1.
• $separator: (optional) The separator to use between words. Default is a -.

Returns: A string representing the generated pet name.

Customization

You can easily modify the source code to add more adverbs, adjectives, or animals to personalize the names generated by the library.

Contributing

Feel free to open issues or submit pull requests if you'd like to contribute. Contributions are always welcome!

License

This project is licensed under the MIT License. See the LICENSE file for details.

Enjoy generating fun names for pets!