Download the PHP package paneon/php-to-typescript-bundle without Composer
On this page you can find all versions of the php package paneon/php-to-typescript-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download paneon/php-to-typescript-bundle
More information about paneon/php-to-typescript-bundle
Files in paneon/php-to-typescript-bundle
Package php-to-typescript-bundle
Short Description Symfony-Bundle to use the PHP to Typescript library
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-to-typescript-bundle
PHP Classes to TypeScript Bundle
A Symfony bundle that adds a command to extract TypeScript interface from PHP classes. Based on the example from Martin Vseticka this bundle uses the PHP-Parser library and annotations.
TypeScript is a superscript of JavaScript that adds strong typing and other features on top of JS. Automatically generated classes can be useful, for example when using a simple JSON API to communicate to a JavaScript client. This way you can get typing for your API responses in an easy way.
Feel free to build on this or use as inspiration to build something completely different.
Installation
As a Symfony bundle you'll need to start by add the package to your project with composer:
Usage of the Command 'typescript:generate'
The purpose of the generate Command is to create TypeScript definitions for all Classes in your source root which are under your immediate control (i.e. You can change their source). It will only affect classes which have the @TypeScriptInterface-Annotation.
The command scans directories recursively for all .php files.
It will only generate Type Definitions (interfaces) for files with the appropriate annotation.
The default parameters will scan for alle PHP Classes inside "src/" and output them as TypeScript Interfaces into
"assets/js/interfaces/" while keeping the relative directory structure.
Examples:
| Source File | Output File |
|---|---|
| src/Model/Person.php | assets/js/interfaces/Model/Person.d.ts |
| src/Example.php | assets/js/interfaces/Example.d.ts |
Example source file:
Default output file:
Null-aware Types
Since TypeScript 2.0 Null and optional/undefined types are supported. In the generator bundle, this is an optional feature and null types will be removed by default. To include nullable types use
Output file with null types:
Usage of the Command 'typescript:generate-single'
The purpose of the generate Command is to create TypeScript definitions for Classes from external packages where you can't add the TypeScriptInterface-Annotation but their classes are for example used in your classes. It will only affect a single file and needs a specific target location if you don't want it directly inside assets/js/interfaces.
It's recommended to trigger the generation of interfaces after composer update/install.
All versions of php-to-typescript-bundle with dependencies
paneon/php-to-typescript Version ^1.0|^2.0
symfony/console Version ^4.0|^5.0|^6.0
symfony/framework-bundle Version ^4.0|^5.0|^6.0
symfony/monolog-bundle Version ^1|^2|^3