File: getting-started.rst

package info (click to toggle)
php-phpdocumentor-type-resolver 1.11.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,432 kB
  • sloc: php: 26,448; xml: 102; makefile: 50
file content (32 lines) | stat: -rw-r--r-- 1,236 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
===============
Getting started
===============

On this page you will find a brief introduction on how to use the TypeResolver in your project.

Installation
============

The TypeResolver is available on Packagist and can be installed using Composer:

.. code:: bash
    composer require phpdocumentor/type-resolver


General usage
===========

After you installed the TypeResolver you can use it in your project. This can be done by creating a new instance
of the :php:class:`\phpDocumentor\Reflection\TypeResolver` class and calling
:php:method:`\phpDocumentor\Reflection\TypeResolver::resolve()` with the type you want to resolve.

.. code:: php
    $typeResolver = new \phpDocumentor\Reflection\TypeResolver();
    $type = $typeResolver->resolve('string');
    echo get_class($type); // phpDocumentor\Reflection\Types\String_

The real power of this resolver is in its capability to expand partial class names into fully qualified class names;
but in order to do that we need an additional :php:class:`\phpDocumentor\Reflection\Types\Context` class that
will inform the resolver in which namespace the given expression occurs and which namespace aliases (or imports) apply.

Read more about the Context class in the next section.