Download the PHP package onurb/doctrine-metadata-grapher without Composer

On this page you can find all versions of the php package onurb/doctrine-metadata-grapher. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package doctrine-metadata-grapher

Metagatagrapher for Yuml data preparation v 1.1

Build Status Scrutinizer Code Quality Code Coverage Build Status Latest Stable Version Total Downloads

MetadataGrapher formats objects data to prepare data for YUML api to generate visual Entities mapping graphs

Installation

Use

Send an array of Doctrine ClassMetadata to the YUMLMetadataGrapher::generateFromMetadata() method
It returns the string to send to YUML to get the mapping graph from the api
If you're a symfony user, you should install onurb/doctrine-yuml-bundle which already uses this library adding a link into the dev toolbar. if you're Zend framework user, it is included into the DoctrineORMModule if you install zend-developer-tools

Go to this github repo for concrete examples of use to retrieve the array of ClassMetadata

Peronalize the display : Add notes, color your classes, hide or display fields description,

hide specific or all entity column

Fully optional, you can display fieldds description, add color to your map or wwrite notes linked to a specific class. Colored Map with note

To do this, the library provides few Doctrine Annotations, to define color, to add notes, to hide or show attributes properties or display specific methods in the graph All of them are described below

Options use

Display fields description

To display an Entity attributes properties, Use the @ShowAttributesProperties annotation on your entity :

Yuml Graphs

It il also possible to show properties on all Entities and hide it only on less important Entities

To show fields descriptions just turn the $showFieldsDescription to true

It is also possible to hide One Entity (or more) using the @HideAttributesProperties annotation (if $showFieldsDescription turned to true : no effect if false)

Hide Entity columns with annotations : using the @grapher\HideColumns annotation on the class :

Or hide a specific secret column you want to hide, using the @Grapher\HiddenColumn on the Entity attribute : can be usefull to hide you credential logic, or to avoid recurrent fields, like created_at, or updated_at in the graph.

Use colors

you can use the yuml colors and apply it as you wish , on a class or on an entire namespace. color priority is given by hierarchy in the namespace...

Colors usage

The easiest way to define class color is to use annotations in Entities like this :

But doing it on each class can be boring if you want a complete namespace with the same color (to display a zend Module or a Symfony bundle with a specific color for example).

So it is also possible to define default color on namespaces, but not with annotations, only applied on entities.

It is done using the third argument of generateMetadata() method to inject an associated array. Color priority is given to Annotations, user can define a color for the namespace, and specifics colors for classes he want to highlight. It can be passed by parameters options depending of your framework logic to allow final users customization

A complete list of available colors can be found here Color list

Display methods

Final user can display any method he wants in the graph, simply adding an annotation
Class With Methods

Add notes

You can now add a note linked in the mapping to an Entity Note graph

Notes usage

Notes are managed by annotations declared directly on classes to note:

Note color is yellow by default... Maybe because of post-it color... My choice ;)

you can customize it like this :

As we did with colors, you can also inject an array of notes in the generateMetadata method, but it is useless with annotations => we don't put notes on namespaces, only Entities.


All versions of doctrine-metadata-grapher with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.2
doctrine/orm Version ^2.5
doctrine/annotations Version 1.*
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package onurb/doctrine-metadata-grapher contains the following files

Loading the files please wait ....