2017 © Pedro Peláez
 

library cosmos

A library for representing and manipulating PHP symbols.

image

eloquent/cosmos

A library for representing and manipulating PHP symbols.

  • Wednesday, October 7, 2015
  • by ezzatron
  • Repository
  • 1 Watchers
  • 13 Stars
  • 5,619 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 1 Forks
  • 2 Open issues
  • 11 Versions
  • 0 % Grown

The README.md

Cosmos

A library for representing and manipulating PHP class names., (*1)

![Build Status] ![Test Coverage], (*2)

Installation

Available as Composer package eloquent/cosmos., (*3)

What is Cosmos?

Cosmos is a library for representing and manipulating PHP class names. It includes a ClassName object, as well as tools to help in resolving class names against a set of namespace and use statements., (*4)

ClassName object

This object is designed to represent any valid PHP class or namespace name. There are two ways to create a new ClassName object. From a string or from an array representing the parts of the class name, or 'atoms'. ClassName objects cannot be instatiated directly., (*5)

The two methods are demostrated below:, (*6)

use Eloquent\Cosmos\ClassName;

$earth = ClassName::fromString('\MilkyWay\SolarSystem\Earth');
$mars = ClassName::fromAtoms(array('MilkyWay', 'SolarSystem', 'Mars'), true);

Note the second parameter in the fromAtoms() method. This boolean value determines whether the class name is absolute (starts with a namespace separator)., (*7)

From here the ClassName object can be used to manipulate the class name or extract information about its constituent parts., (*8)

ClassName::atoms()

Returns the parts of the class name as an array of strings., (*9)

ClassName::isAbsolute()

Returns boolean true if the class name is absolute (begins with a namespace separator) or boolean false if it does not., (*10)

ClassName::isShortName()

Returns boolean true if the class name is not absolute and has only one atom. If either of these conditions is not met, false is returned., (*11)

ClassName::isEqualTo(ClassName $className)

Returns boolean true if the supplied class name is exactly equal to this class name. The supplied class name must have identical atoms and match the absolute-ness of this class name., (*12)

ClassName::isRuntimeEquivalentTo(ClassName $className)

Returns boolean true if the supplied class name is equivalent to this class name in a runtime context. The supplied class name must have identical atoms but absolute and relative class names are treated identically by PHP at runtime., (*13)

ClassName::join(ClassName $className)

Appends $className to the end of this class name and returns the result as a new ClassName object. Note that absolute class names cannot be joined., (*14)

ClassName::joinAtoms($atom, ...)

Appends the supplied atoms to the end of this class name and returns the result as a new ClassName object., (*15)

ClassName::joinAtomsArray(array $atoms)

Appends the supplied array of atoms to the end of this class name and returns the result as a new ClassName object., (*16)

ClassName::hasParent()

Returns boolean true if the class name has a parent namespace, or boolean false if it does not., (*17)

ClassName::parent()

Returns the parent namespace of this class name as a new ClassName object., (*18)

ClassName::shortName()

Returns the last atom of this class name as a new ClassName object., (*19)

ClassName::toAbsolute()

Returns the absolute version of this class name as a ClassName object. If this class name is already absolute, it will simply return itself., (*20)

ClassName::toRelative()

Returns the relative version of this class name as a ClassName object. If this class name is already relative, it will simply return itself., (*21)

ClassName::hasDescendant(ClassName $className)

Returns boolean true if this class name is one of the parent namespaces of $className or boolean false if it is not., (*22)

ClassName::stripNamespace(ClassName $namespaceName)

Strips $namespaceName from this class name and returns the result as a new, ClassName object relative to the supplied namespace name., (*23)

ClassName::exists($useAutoload = true)

Returns boolean true if the class name exists. Note that this does not take into account if the class name is absolute or relative. The $useAutoload parameter can be specified to prevent autoloading if necessary., (*24)

ClassName::string()

Returns a string representation of this class name. ClassName also implements __toString() which simply returns the result of this method., (*25)

Class name resolver

To use the class name resolver, first create a new resolver to represent the set of namespace and use statements to resolve against., (*26)

The first parameter represents the namespace statement. It must be supplied as a fully-qualified ClassName object. The second parameter is an array of tuples representing the use statements., (*27)

If a 1-tuple is supplied, it represents a use statement without an as clause. A 2-tuple represents a use statement with an attached as clause. The first element of the tuple is always a fully-qualified ClassName object. If present, the second element must be a short ClassName object. That is, one without any namespace separators., (*28)

use Eloquent\Cosmos\ClassName;
use Eloquent\Cosmos\ClassNameResolver;

$resolver = new ClassNameResolver(
    ClassName::fromString('\MilkyWay\SolarSystem'), // namespace
    array(
        array(
            ClassName::fromString('\MilkyWay\AlphaCentauri\ProximaCentauri'), // use
        ),
        array(
            ClassName::fromString('\Andromeda\GalacticCenter'), // use
            ClassName::fromString('Andromeda'), // as
        ),
    )
);

The above resolver is analogous to the following PHP code:, (*29)

namespace MilkyWay\SolarSystem;

use MilkyWay\AlphaCentauri\ProximaCentauri;
use Andromeda\GalacticCenter as Andromeda;

The created resolver can now be used to determine the canonical version of any class name. Note that in the example below, ClassName objects are returned, not plain strings., (*30)

echo $resolver->resolve(ClassName::fromString('Earth'));
// outputs '\MilkyWay\SolarSystem\Earth'

echo $resolver->resolve(ClassName::fromString('ProximaCentauri'));
// outputs '\MilkyWay\AlphaCentauri\ProximaCentauri'

echo $resolver->resolve(ClassName::fromString('Andromeda'));
// outputs '\Andromeda\GalacticCenter'

echo $resolver->resolve(ClassName::fromString('TNO\Pluto'));
// outputs '\MilkyWay\SolarSystem\TNO\Pluto'

echo $resolver->resolve(ClassName::fromString('\Betelgeuse'));
// outputs '\Betelgeuse'

The Versions

07/10 2015

dev-feature/rewrite

dev-feature/rewrite https://github.com/eloquent/cosmos

A library for representing and manipulating PHP symbols.

  Sources   Download

MIT

The Requires

  • php >=5.3

 

The Development Requires

by Erin Millard

function php class resolver name symbol use namespace statement solver classname

07/07 2014

dev-feature/pathogen-based

dev-feature/pathogen-based https://github.com/eloquent/cosmos

A library for representing and manipulating PHP symbols.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Erin Millard

function php class resolver name symbol use namespace statement solver classname

04/03 2013

dev-master

9999999-dev https://github.com/eloquent/cosmos

A library for representing and manipulating PHP class names.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Erin Millard

php class resolver name namespace solver classname

04/03 2013

dev-develop

dev-develop https://github.com/eloquent/cosmos

A library for representing and manipulating PHP class names.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Erin Millard

php class resolver name namespace solver classname

04/03 2013

2.3.1

2.3.1.0 https://github.com/eloquent/cosmos

A library for representing and manipulating PHP class names.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Erin Millard

php class resolver name namespace solver classname

19/01 2013

2.3.0

2.3.0.0 https://github.com/eloquent/cosmos

A library for representing and manipulating PHP class names.

  Sources   Download

MIT

The Requires

 

The Development Requires

  • icecave/testing ~1

by Erin Millard

php class resolver name namespace solver classname

18/01 2013

2.2.0

2.2.0.0 https://github.com/eloquent/cosmos

A class name resolver for PHP namespaces.

  Sources   Download

MIT

The Requires

 

The Development Requires

  • icecave/testing ~1

by Erin Millard

php class resolver name namespace solver classname

15/01 2013

2.1.0

2.1.0.0 https://github.com/eloquent/cosmos

A class name resolver for PHP namespaces.

  Sources   Download

MIT

The Requires

 

The Development Requires

  • icecave/testing ~1

by Erin Millard

php class resolver name namespace solver classname

14/01 2013

2.0.0

2.0.0.0 https://github.com/eloquent/cosmos

A class name resolver for PHP namespaces.

  Sources   Download

MIT

The Requires

 

The Development Requires

  • icecave/testing ~1

by Erin Millard

php class resolver name namespace solver classname

05/08 2012

1.0.1

1.0.1.0 https://github.com/eloquent/cosmos

A class name resolver for PHP namespaces.

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

by Erin Millard

php class resolver name namespace solver classname

04/08 2012

1.0.0

1.0.0.0 https://github.com/eloquent/cosmos

A class name resolver for PHP namespaces.

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

by Erin Millard

php class resolver name namespace solver classname