Skip to content

varunsridharan/php-classmap-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

PHP Classmap Generator

Simple & Lightweight PHP Classmap Generator

Latest Stable Version Latest Unstable Version Total Downloads License composer.lock available

Installation

The preferred way to install this extension is through Composer.

To install PHP_Classmap_Generator library, simply:

$ composer require varunsridharan/php-classmap-generator

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require varunsridharan/php-classmap-generator --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/varunsridharan/php-classmap-generator.git

Or install it manually:

Download PHP_Classmap_Generator.zip:

$ wget https://github.com/varunsridharan/php-classmap-generator/archive/master.zip

Usage

Config Arguments

Key Description
namespace Which name space to search for. leave empty to get all classes
source string / array of places to search for php classes
output Location & File type to save classmap data
excluded Namespace / File Paths to exclude
fullpath set true to provide full path

CMD Line

/**
 * Arguments Order.
 * 1. PHP Class Source
 * 2. PHP Classmap File Output
 * 3. Namespace (Leave Empty To Get All)
 * 4. exclude_namespace
 * 5. exclude_path
 * 6. fullpath
 */
composer classmap-generator "your-path-to-php-class" "class-map-output/files.php"

Sample Outputs

PHP

<?php
/**
 * Last Updated: Wed 02-Oct-2019 / 10:23:12:am
 * Total Class:  3
 * Namespace: 
 */

return array (
  'Namespace\\Class1' => 'your-path/class1.php',
  'Namespace\\Deep1\\Class2' => 'your-path/deep1/class2.php',
  'Simple_Class' => 'simple_class.php',
);

JSON

{
  "Namespace\\Class1"      : "your-path/class1.php",
  "Namespace\\Deep1\\Class2" : "your-path/deep1/class2.php",
  "Simple_Class" : "simple_class.php"
}

πŸ“ Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🀝 Contributing

If you would like to help, please take a look at the list of issues.

πŸ“œ License & Conduct

πŸ“£ Feedback

  • ⭐ This repository if this project helped you! πŸ˜‰
  • Create An πŸ”§ Issue if you need help / found a bug

πŸ’° Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

  • β˜• How about we get to know each other over coffee? Buy me a cup for just $9.99
  • β˜•οΈβ˜•οΈ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
  • πŸ”° We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
  • πŸš€ Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

Connect & Say πŸ‘‹


Built With β™₯ By Varun Sridharan