PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of jawira   PHP Case Convert   README.md   Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Case Convert
Convert strings between many naming conventions
Author: By
Last change:
Date: 5 years ago
Size: 6,231 bytes
 

Contents

Class file image Download

Case converter

Use this library to convert string between:

| Name | Method | Output example | | ------------- | --------------- | ----------------- | | ? Camel case | toCamel() | myNameIsBond | | ??? Pascal case | toPascal() | MyNameIsBond | | ? Snake case | toSnake() | my_name_is_bond | | ??? Ada case | toAda() | My_Name_Is_Bond | | ?? Macro case | toMacro() | MY_NAME_IS_BOND | | ? Kebab case | toKebab() | my-name-is-bond | | ? Train case | toTrain() | My-Name-Is-Bond | | ? Cobol case | toCobol() | MY-NAME-IS-BOND | | ? Lower case | toLower() | my name is bond | | ? Upper case | toUpper() | MY NAME IS BOND | | ? Title case | toTitle() | My Name Is Bond | | ?? Sentence case | toSentence() | My name is bond | | ?? Dot notation | toDot() | my.name.is.bond |

Features:

  • ? [automatic case detection][detection algorithm]
  • ? [factory][]
  • ? i18n

Latest Stable Version PHP from Packagist Build Status Maintainability Test Coverage Total Downloads Monthly Downloads Daily Downloads PHPPackages Rank PHPPackages Referenced By Average time to resolve an issue Percentage of issues still open License composer.lock PDS Skeleton Issues

Usage

Input string (i.e. _john-connor_) format is going to be [detected automatically][detection algorithm]. Here's an example:

use Jawira\CaseConverter\Convert;

$hero = new Convert('john-connor');

echo $hero->toCamel();   // output: johnConnor

Of course you can explicitly set the format of input string:

echo $hero->fromKebab()->toSnake();   // output: john_connor

You can also use the [provided factory][factory] to instantiate Convert class. A list of [all public methods] is also available.

i18n

Fully compatible with non-english alphabets:

// Spanish
$esp = new Convert('DON_RAMÓN_Y_ÑOÑO');
echo $esp->toCamel();   // output: donRamónYÑoño

// Greek
$grc = new Convert('????-????');
echo $grc->toCamel();   // output: ????????

// Russian
$rus = new Convert('?????_???????');
echo $rus->toCamel();   // output: ????????????

case-converter is compatible with _Simple Case-Mapping_ and _Full Case-Mapping_. [Learn more about Case-Mapping][Case-Mapping].

Installation

$ composer require jawira/case-converter

Documentation

<https://jawira.github.io/case-converter/>

Contributing

If you liked this project, ? star it on [GitHub].

License

This library is licensed under the [MIT LICENSE].

<!--mkdocs: Do not use relative path for links and images-->

[all public methods]: https://jawira.github.io/case-converter/api.html [CONTRIBUTING.md]: https://jawira.github.io/case-converter/contributing.html [Countable interface]: https://php.net/manual/en/class.countable.php [Case-Mapping]: https://jawira.github.io/case-converter/case-mapping.html [magic method]: https://www.php.net/manual/en/language.oop5.magic.php#object.tostring [MIT LICENSE]: https://jawira.github.io/case-converter/license.html [open an issue]: https://github.com/jawira/case-converter/issues/new [detection algorithm]: https://jawira.github.io/case-converter/detection-algorithm.html [factory]: https://jawira.github.io/case-converter/using-the-factory.html [GitHub]: https://github.com/jawira/case-converter/

*

Packages from jawira

<dl>

<dt><a href="https://packagist.org/packages/jawira/emoji-catalog">jawira/emoji-catalog</a> (library)</dt> <dd>Get access to +3000 emojis as class constants.</dd>

<dt><a href="https://packagist.org/packages/jawira/phing-visualizer">jawira/phing-visualizer</a> (library)</dt> <dd>Graphical representation of Phing's buildfile.</dd>

<dt><a href="https://packagist.org/packages/jawira/phing-open-task">jawira/phing-open-task</a> (library)</dt> <dd>Phing task to open files, directories, and URLs with your favorite software.</dd>

<dt><a href="https://packagist.org/packages/jawira/">more...</a></dt> </dl>