[2.0] Migrated AnnotationDriver to new annotation parser. Removed addendum vendor library.
This commit is contained in:
parent
08f84793da
commit
2ffc7f17db
@ -37,6 +37,8 @@ class Lexer
|
||||
const T_INTEGER = 3;
|
||||
const T_STRING = 4;
|
||||
const T_IDENTIFIER = 5;
|
||||
const T_TRUE = 6;
|
||||
const T_FALSE = 7;
|
||||
|
||||
/**
|
||||
* Array of scanned tokens.
|
||||
|
@ -1,4 +1,23 @@
|
||||
<?php
|
||||
/*
|
||||
* $Id$
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
* This software consists of voluntary contributions made by many individuals
|
||||
* and is licensed under the LGPL. For more information, see
|
||||
* <http://www.doctrine-project.org>.
|
||||
*/
|
||||
|
||||
namespace Doctrine\Common\Annotations;
|
||||
|
||||
@ -69,7 +88,10 @@ class Parser
|
||||
$this->_lexer->setInput(trim($input, '* /'));
|
||||
$this->_lexer->moveNext();
|
||||
|
||||
return $this->Annotations();
|
||||
if ($this->_lexer->isNextToken('@')) {
|
||||
return $this->Annotations();
|
||||
}
|
||||
return array();
|
||||
}
|
||||
|
||||
/**
|
||||
@ -90,7 +112,7 @@ class Parser
|
||||
}
|
||||
|
||||
if ( ! $isMatch) {
|
||||
$this->syntaxError($token['value']);
|
||||
$this->syntaxError($token['value'], $this->_lexer->lookahead['value']);
|
||||
}
|
||||
|
||||
$this->_lexer->moveNext();
|
||||
@ -102,9 +124,9 @@ class Parser
|
||||
* @param $expected
|
||||
* @throws Exception
|
||||
*/
|
||||
private function syntaxError($expected)
|
||||
private function syntaxError($expected, $got = "")
|
||||
{
|
||||
throw new \Exception("Expected: $expected.");
|
||||
throw new \Exception("Expected: $expected. Got: $got");
|
||||
}
|
||||
|
||||
/**
|
||||
@ -175,6 +197,7 @@ class Parser
|
||||
|
||||
if ( ! $this->_isNestedAnnotation && $this->_lexer->lookahead != null
|
||||
&& $this->_lexer->lookahead['value'] != '('
|
||||
&& $this->_lexer->lookahead['value'] != '@'
|
||||
|| ! is_subclass_of($name, 'Doctrine\Common\Annotations\Annotation')) {
|
||||
return false;
|
||||
}
|
||||
@ -202,22 +225,9 @@ class Parser
|
||||
$values = array();
|
||||
|
||||
$value = $this->Value();
|
||||
if (is_array($value)) {
|
||||
$k = key($value);
|
||||
$v = $value[$k];
|
||||
if (is_string($k)) {
|
||||
// FieldAssignment
|
||||
$values[$k] = $v;
|
||||
} else {
|
||||
$values['value'][] = $value;
|
||||
}
|
||||
} else {
|
||||
$values['value'][] = $value;
|
||||
}
|
||||
|
||||
while ($this->_lexer->isNextToken(',')) {
|
||||
$this->match(',');
|
||||
$value = $this->Value();
|
||||
|
||||
if ($this->_lexer->isNextToken(')')) {
|
||||
// Single value
|
||||
if (is_array($value)) {
|
||||
$k = key($value);
|
||||
$v = $value[$k];
|
||||
@ -225,11 +235,30 @@ class Parser
|
||||
// FieldAssignment
|
||||
$values[$k] = $v;
|
||||
} else {
|
||||
$values['value'][] = $value;
|
||||
$values['value']= $value;
|
||||
}
|
||||
} else {
|
||||
$values['value'][] = $value;
|
||||
$values['value'] = $value;
|
||||
}
|
||||
return $values;
|
||||
} else {
|
||||
// FieldAssignment
|
||||
$k = key($value);
|
||||
$v = $value[$k];
|
||||
$values[$k] = $v;
|
||||
}
|
||||
|
||||
while ($this->_lexer->isNextToken(',')) {
|
||||
$this->match(',');
|
||||
$value = $this->Value();
|
||||
|
||||
if ( ! is_array($value)) {
|
||||
$this->syntaxError('FieldAssignment', $value);
|
||||
}
|
||||
|
||||
$k = key($value);
|
||||
$v = $value[$k];
|
||||
$values[$k] = $v;
|
||||
}
|
||||
|
||||
return $values;
|
||||
@ -269,6 +298,12 @@ class Parser
|
||||
case Lexer::T_FLOAT:
|
||||
$this->match(Lexer::T_FLOAT);
|
||||
return $this->_lexer->token['value'];
|
||||
case Lexer::T_TRUE:
|
||||
$this->match(Lexer::T_TRUE);
|
||||
return true;
|
||||
case Lexer::T_FALSE:
|
||||
$this->match(Lexer::T_FALSE);
|
||||
return false;
|
||||
default:
|
||||
var_dump($this->_lexer->lookahead);
|
||||
throw new \Exception("Invalid value.");
|
||||
|
@ -22,18 +22,15 @@
|
||||
namespace Doctrine\ORM\Mapping\Driver;
|
||||
|
||||
use Doctrine\Common\DoctrineException;
|
||||
use Doctrine\Common\Cache\ArrayCache;
|
||||
use Doctrine\Common\Annotations\AnnotationReader;
|
||||
use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
use Doctrine\ORM\Mapping\MappingException;
|
||||
|
||||
/* Addendum annotation reflection extensions */
|
||||
if ( ! class_exists('Addendum', false)) {
|
||||
require __DIR__ . '/../../../../vendor/addendum/annotations.php';
|
||||
}
|
||||
require __DIR__ . '/DoctrineAnnotations.php';
|
||||
|
||||
/**
|
||||
* The AnnotationDriver reads the mapping metadata from docblock annotations
|
||||
* with the help of the Addendum reflection extensions.
|
||||
* The AnnotationDriver reads the mapping metadata from docblock annotations.
|
||||
*
|
||||
* @author Roman Borschel <roman@code-factory.org>
|
||||
* @since 2.0
|
||||
@ -45,16 +42,17 @@ class AnnotationDriver implements Driver
|
||||
*/
|
||||
public function loadMetadataForClass($className, ClassMetadata $metadata)
|
||||
{
|
||||
$annotClass = new \ReflectionAnnotatedClass($className);
|
||||
$reader = new AnnotationReader(new ArrayCache);
|
||||
$class = $metadata->getReflectionClass();
|
||||
|
||||
// Evaluate DoctrineEntity annotation
|
||||
if (($entityAnnot = $annotClass->getAnnotation('Entity')) === false) {
|
||||
if (($entityAnnot = $reader->getClassAnnotation($class, 'Entity')) === null) {
|
||||
throw DoctrineException::updateMe("$className is no entity.");
|
||||
}
|
||||
$metadata->setCustomRepositoryClass($entityAnnot->repositoryClass);
|
||||
|
||||
// Evaluate DoctrineTable annotation
|
||||
if ($tableAnnot = $annotClass->getAnnotation('Table')) {
|
||||
if ($tableAnnot = $reader->getClassAnnotation($class, 'Table')) {
|
||||
$metadata->setPrimaryTable(array(
|
||||
'name' => $tableAnnot->name,
|
||||
'schema' => $tableAnnot->schema
|
||||
@ -62,12 +60,12 @@ class AnnotationDriver implements Driver
|
||||
}
|
||||
|
||||
// Evaluate InheritanceType annotation
|
||||
if ($inheritanceTypeAnnot = $annotClass->getAnnotation('InheritanceType')) {
|
||||
if ($inheritanceTypeAnnot = $reader->getClassAnnotation($class, 'InheritanceType')) {
|
||||
$metadata->setInheritanceType(constant('\Doctrine\ORM\Mapping\ClassMetadata::INHERITANCE_TYPE_' . $inheritanceTypeAnnot->value));
|
||||
}
|
||||
|
||||
// Evaluate DiscriminatorColumn annotation
|
||||
if ($discrColumnAnnot = $annotClass->getAnnotation('DiscriminatorColumn')) {
|
||||
if ($discrColumnAnnot = $reader->getClassAnnotation($class, 'DiscriminatorColumn')) {
|
||||
$metadata->setDiscriminatorColumn(array(
|
||||
'name' => $discrColumnAnnot->name,
|
||||
'type' => $discrColumnAnnot->type,
|
||||
@ -76,22 +74,22 @@ class AnnotationDriver implements Driver
|
||||
}
|
||||
|
||||
// Evaluate DiscriminatorValue annotation
|
||||
if ($discrValueAnnot = $annotClass->getAnnotation('DiscriminatorValue')) {
|
||||
if ($discrValueAnnot = $reader->getClassAnnotation($class, 'DiscriminatorValue')) {
|
||||
$metadata->setDiscriminatorValue($discrValueAnnot->value);
|
||||
}
|
||||
|
||||
// Evaluate DoctrineSubClasses annotation
|
||||
if ($subClassesAnnot = $annotClass->getAnnotation('SubClasses')) {
|
||||
if ($subClassesAnnot = $reader->getClassAnnotation($class, 'SubClasses')) {
|
||||
$metadata->setSubclasses($subClassesAnnot->value);
|
||||
}
|
||||
|
||||
// Evaluate DoctrineChangeTrackingPolicy annotation
|
||||
if ($changeTrackingAnnot = $annotClass->getAnnotation('ChangeTrackingPolicy')) {
|
||||
if ($changeTrackingAnnot = $reader->getClassAnnotation($class, 'ChangeTrackingPolicy')) {
|
||||
$metadata->setChangeTrackingPolicy($changeTrackingAnnot->value);
|
||||
}
|
||||
|
||||
// Evaluate annotations on properties/fields
|
||||
foreach ($annotClass->getProperties() as $property) {
|
||||
foreach ($class->getProperties() as $property) {
|
||||
if ($metadata->hasField($property->getName())) {
|
||||
continue;
|
||||
}
|
||||
@ -101,7 +99,7 @@ class AnnotationDriver implements Driver
|
||||
|
||||
// Check for JoinColummn/JoinColumns annotations
|
||||
$joinColumns = array();
|
||||
if ($joinColumnAnnot = $property->getAnnotation('JoinColumn')) {
|
||||
if ($joinColumnAnnot = $reader->getPropertyAnnotation($property, 'JoinColumn')) {
|
||||
$joinColumns[] = array(
|
||||
'name' => $joinColumnAnnot->name,
|
||||
'referencedColumnName' => $joinColumnAnnot->referencedColumnName,
|
||||
@ -110,13 +108,23 @@ class AnnotationDriver implements Driver
|
||||
'onDelete' => $joinColumnAnnot->onDelete,
|
||||
'onUpdate' => $joinColumnAnnot->onUpdate
|
||||
);
|
||||
} else if ($joinColumnsAnnot = $property->getAnnotation('JoinColumns')) {
|
||||
$joinColumns = $joinColumnsAnnot->value;
|
||||
} else if ($joinColumnsAnnot = $reader->getPropertyAnnotation($property, 'JoinColumns')) {
|
||||
foreach ($joinColumnsAnnot->value as $joinColumn) {
|
||||
//$joinColumns = $joinColumnsAnnot->value;
|
||||
$joinColumns[] = array(
|
||||
'name' => $joinColumn->name,
|
||||
'referencedColumnName' => $joinColumn->referencedColumnName,
|
||||
'unique' => $joinColumn->unique,
|
||||
'nullable' => $joinColumn->nullable,
|
||||
'onDelete' => $joinColumn->onDelete,
|
||||
'onUpdate' => $joinColumn->onUpdate
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Field can only be annotated with one of:
|
||||
// @Column, @OneToOne, @OneToMany, @ManyToOne, @ManyToMany
|
||||
if ($columnAnnot = $property->getAnnotation('Column')) {
|
||||
if ($columnAnnot = $reader->getPropertyAnnotation($property, 'Column')) {
|
||||
if ($columnAnnot->type == null) {
|
||||
throw DoctrineException::updateMe("Missing type on property " . $property->getName());
|
||||
}
|
||||
@ -126,51 +134,74 @@ class AnnotationDriver implements Driver
|
||||
if (isset($columnAnnot->name)) {
|
||||
$mapping['columnName'] = $columnAnnot->name;
|
||||
}
|
||||
if ($idAnnot = $property->getAnnotation('Id')) {
|
||||
if ($idAnnot = $reader->getPropertyAnnotation($property, 'Id')) {
|
||||
$mapping['id'] = true;
|
||||
}
|
||||
if ($generatedValueAnnot = $property->getAnnotation('GeneratedValue')) {
|
||||
if ($generatedValueAnnot = $reader->getPropertyAnnotation($property, 'GeneratedValue')) {
|
||||
$metadata->setIdGeneratorType(constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_' . $generatedValueAnnot->strategy));
|
||||
}
|
||||
$metadata->mapField($mapping);
|
||||
|
||||
// Check for SequenceGenerator/TableGenerator definition
|
||||
if ($seqGeneratorAnnot = $property->getAnnotation('SequenceGenerator')) {
|
||||
if ($seqGeneratorAnnot = $reader->getPropertyAnnotation($property, 'SequenceGenerator')) {
|
||||
$metadata->setSequenceGeneratorDefinition(array(
|
||||
'sequenceName' => $seqGeneratorAnnot->sequenceName,
|
||||
'allocationSize' => $seqGeneratorAnnot->allocationSize,
|
||||
'initialValue' => $seqGeneratorAnnot->initialValue
|
||||
));
|
||||
} else if ($tblGeneratorAnnot = $property->getAnnotation('TableGenerator')) {
|
||||
} else if ($tblGeneratorAnnot = $reader->getPropertyAnnotation($property, 'TableGenerator')) {
|
||||
throw new DoctrineException("DoctrineTableGenerator not yet implemented.");
|
||||
}
|
||||
|
||||
} else if ($oneToOneAnnot = $property->getAnnotation('OneToOne')) {
|
||||
} else if ($oneToOneAnnot = $reader->getPropertyAnnotation($property, 'OneToOne')) {
|
||||
$mapping['targetEntity'] = $oneToOneAnnot->targetEntity;
|
||||
$mapping['joinColumns'] = $joinColumns;
|
||||
$mapping['mappedBy'] = $oneToOneAnnot->mappedBy;
|
||||
$mapping['cascade'] = $oneToOneAnnot->cascade;
|
||||
$metadata->mapOneToOne($mapping);
|
||||
} else if ($oneToManyAnnot = $property->getAnnotation('OneToMany')) {
|
||||
} else if ($oneToManyAnnot = $reader->getPropertyAnnotation($property, 'OneToMany')) {
|
||||
$mapping['mappedBy'] = $oneToManyAnnot->mappedBy;
|
||||
$mapping['targetEntity'] = $oneToManyAnnot->targetEntity;
|
||||
$mapping['cascade'] = $oneToManyAnnot->cascade;
|
||||
$metadata->mapOneToMany($mapping);
|
||||
} else if ($manyToOneAnnot = $property->getAnnotation('ManyToOne')) {
|
||||
} else if ($manyToOneAnnot = $reader->getPropertyAnnotation($property, 'ManyToOne')) {
|
||||
$mapping['joinColumns'] = $joinColumns;
|
||||
$mapping['cascade'] = $manyToOneAnnot->cascade;
|
||||
$mapping['targetEntity'] = $manyToOneAnnot->targetEntity;
|
||||
$metadata->mapManyToOne($mapping);
|
||||
} else if ($manyToManyAnnot = $property->getAnnotation('ManyToMany')) {
|
||||
} else if ($manyToManyAnnot = $reader->getPropertyAnnotation($property, 'ManyToMany')) {
|
||||
$joinTable = array();
|
||||
if ($joinTableAnnot = $property->getAnnotation('JoinTable')) {
|
||||
if ($joinTableAnnot = $reader->getPropertyAnnotation($property, 'JoinTable')) {
|
||||
$joinTable = array(
|
||||
'name' => $joinTableAnnot->name,
|
||||
'schema' => $joinTableAnnot->schema,
|
||||
'joinColumns' => $joinTableAnnot->joinColumns,
|
||||
'inverseJoinColumns' => $joinTableAnnot->inverseJoinColumns
|
||||
//'joinColumns' => $joinTableAnnot->joinColumns,
|
||||
//'inverseJoinColumns' => $joinTableAnnot->inverseJoinColumns
|
||||
);
|
||||
|
||||
foreach ($joinTableAnnot->joinColumns as $joinColumn) {
|
||||
$joinTable['joinColumns'][] = array(
|
||||
'name' => $joinColumn->name,
|
||||
'referencedColumnName' => $joinColumn->referencedColumnName,
|
||||
'unique' => $joinColumn->unique,
|
||||
'nullable' => $joinColumn->nullable,
|
||||
'onDelete' => $joinColumn->onDelete,
|
||||
'onUpdate' => $joinColumn->onUpdate
|
||||
);
|
||||
}
|
||||
|
||||
foreach ($joinTableAnnot->inverseJoinColumns as $joinColumn) {
|
||||
$joinTable['inverseJoinColumns'][] = array(
|
||||
'name' => $joinColumn->name,
|
||||
'referencedColumnName' => $joinColumn->referencedColumnName,
|
||||
'unique' => $joinColumn->unique,
|
||||
'nullable' => $joinColumn->nullable,
|
||||
'onDelete' => $joinColumn->onDelete,
|
||||
'onUpdate' => $joinColumn->onUpdate
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$mapping['joinTable'] = $joinTable;
|
||||
$mapping['targetEntity'] = $manyToManyAnnot->targetEntity;
|
||||
$mapping['mappedBy'] = $manyToManyAnnot->mappedBy;
|
||||
|
@ -21,25 +21,24 @@
|
||||
|
||||
/* Annotations */
|
||||
|
||||
final class Entity extends \Annotation {
|
||||
final class Entity extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $repositoryClass;
|
||||
}
|
||||
final class InheritanceType extends \Annotation {}
|
||||
final class DiscriminatorColumn extends \Annotation {
|
||||
final class InheritanceType extends \Doctrine\Common\Annotations\Annotation {}
|
||||
final class DiscriminatorColumn extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $name;
|
||||
public $type;
|
||||
public $length;
|
||||
}
|
||||
//final class DiscriminatorMap extends \Annotation {}
|
||||
final class DiscriminatorValue extends \Annotation {}
|
||||
final class SubClasses extends \Annotation {}
|
||||
final class Id extends \Annotation {}
|
||||
final class GeneratedValue extends \Annotation {
|
||||
final class DiscriminatorValue extends \Doctrine\Common\Annotations\Annotation {}
|
||||
final class SubClasses extends \Doctrine\Common\Annotations\Annotation {}
|
||||
final class Id extends \Doctrine\Common\Annotations\Annotation {}
|
||||
final class GeneratedValue extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $strategy;
|
||||
//public $generator;
|
||||
}
|
||||
final class Version extends \Annotation {}
|
||||
final class JoinColumn extends \Annotation {
|
||||
final class Version extends \Doctrine\Common\Annotations\Annotation {}
|
||||
final class JoinColumn extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $name;
|
||||
public $referencedColumnName;
|
||||
public $unique = false;
|
||||
@ -47,57 +46,57 @@ final class JoinColumn extends \Annotation {
|
||||
public $onDelete;
|
||||
public $onUpdate;
|
||||
}
|
||||
final class JoinColumns extends \Annotation {}
|
||||
final class Column extends \Annotation {
|
||||
final class JoinColumns extends \Doctrine\Common\Annotations\Annotation {}
|
||||
final class Column extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $type;
|
||||
public $length;
|
||||
public $unique = false;
|
||||
public $nullable = false;
|
||||
public $name;
|
||||
}
|
||||
final class OneToOne extends \Annotation {
|
||||
final class OneToOne extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $targetEntity;
|
||||
public $mappedBy;
|
||||
public $cascade;
|
||||
public $fetch;
|
||||
public $optional;
|
||||
}
|
||||
final class OneToMany extends \Annotation {
|
||||
final class OneToMany extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $mappedBy;
|
||||
public $targetEntity;
|
||||
public $cascade;
|
||||
public $fetch;
|
||||
}
|
||||
final class ManyToOne extends \Annotation {
|
||||
final class ManyToOne extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $targetEntity;
|
||||
public $cascade;
|
||||
public $fetch;
|
||||
public $optional;
|
||||
}
|
||||
final class ManyToMany extends \Annotation {
|
||||
final class ManyToMany extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $targetEntity;
|
||||
public $mappedBy;
|
||||
public $cascade;
|
||||
public $fetch;
|
||||
}
|
||||
final class ElementCollection extends \Annotation {
|
||||
final class ElementCollection extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $tableName;
|
||||
}
|
||||
final class Table extends \Annotation {
|
||||
final class Table extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $name;
|
||||
public $schema;
|
||||
}
|
||||
final class JoinTable extends \Annotation {
|
||||
final class JoinTable extends \Doctrine\Common\Annotations\Annotation {
|
||||
public $name;
|
||||
public $schema;
|
||||
public $joinColumns;
|
||||
public $inverseJoinColumns;
|
||||
}
|
||||
final class SequenceGenerator extends \Annotation {
|
||||
final class SequenceGenerator extends \Doctrine\Common\Annotations\Annotation {
|
||||
//public $name;
|
||||
public $sequenceName;
|
||||
public $allocationSize = 10;
|
||||
public $initialValue = 1;
|
||||
}
|
||||
final class ChangeTrackingPolicy extends \Annotation {}
|
||||
final class DoctrineX extends \Annotation {}
|
||||
final class ChangeTrackingPolicy extends \Doctrine\Common\Annotations\Annotation {}
|
||||
final class DoctrineX extends \Doctrine\Common\Annotations\Annotation {}
|
||||
|
502
lib/vendor/addendum/LICENSE
vendored
502
lib/vendor/addendum/LICENSE
vendored
@ -1,502 +0,0 @@
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 2.1, February 1999
|
||||
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Libraries
|
||||
|
||||
If you develop a new library, and you want it to be of the greatest
|
||||
possible use to the public, we recommend making it free software that
|
||||
everyone can redistribute and change. You can do so by permitting
|
||||
redistribution under these terms (or, alternatively, under the terms of the
|
||||
ordinary General Public License).
|
||||
|
||||
To apply these terms, attach the following notices to the library. It is
|
||||
safest to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1990
|
||||
Ty Coon, President of Vice
|
||||
|
||||
That's all there is to it!
|
348
lib/vendor/addendum/annotations.php
vendored
348
lib/vendor/addendum/annotations.php
vendored
@ -1,348 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
* Addendum PHP Reflection Annotations
|
||||
* http://code.google.com/p/addendum/
|
||||
*
|
||||
* Copyright (C) 2006 Jan "johno Suchal <johno@jsmf.net>
|
||||
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
**/
|
||||
|
||||
require_once(dirname(__FILE__).'/annotations/annotation_parser.php');
|
||||
|
||||
class Annotation {
|
||||
public $value;
|
||||
private static $creationStack = array();
|
||||
|
||||
public final function __construct($data, $target) {
|
||||
$reflection = new ReflectionClass($this);
|
||||
$class = $reflection->getName();
|
||||
if(isset(self::$creationStack[$class])) {
|
||||
trigger_error("Circular annotation reference on '$class'", E_USER_ERROR);
|
||||
return;
|
||||
}
|
||||
self::$creationStack[$class] = true;
|
||||
foreach($data as $key => $value) {
|
||||
if($reflection->hasProperty($key)) {
|
||||
$this->$key = $value;
|
||||
} else {
|
||||
trigger_error("Property '$key' not defined for annotation '$class'");
|
||||
}
|
||||
}
|
||||
$this->checkTargetConstraints($target);
|
||||
$this->checkConstraints($target);
|
||||
unset(self::$creationStack[$class]);
|
||||
}
|
||||
|
||||
private function checkTargetConstraints($target) {
|
||||
/*$reflection = new ReflectionAnnotatedClass($this);
|
||||
if($reflection->hasAnnotation('Target')) {
|
||||
$value = $reflection->getAnnotation('Target')->value;
|
||||
$values = is_array($value) ? $value : array($value);
|
||||
foreach($values as $value) {
|
||||
if($value == 'class' && $target instanceof ReflectionClass) return;
|
||||
if($value == 'method' && $target instanceof ReflectionMethod) return;
|
||||
if($value == 'property' && $target instanceof ReflectionProperty) return;
|
||||
}
|
||||
trigger_error("Annotation '".get_class($this)."' not allowed on ".$this->createName($target), E_USER_ERROR);
|
||||
}*/
|
||||
}
|
||||
|
||||
private function createName($target) {
|
||||
if($target instanceof ReflectionMethod) {
|
||||
return $target->getDeclaringClass()->getName().'::'.$target->getName();
|
||||
} elseif($target instanceof ReflectionProperty) {
|
||||
return $target->getDeclaringClass()->getName().'::$'.$target->getName();
|
||||
} else {
|
||||
return $target->getName();
|
||||
}
|
||||
}
|
||||
|
||||
protected function checkConstraints($target) {}
|
||||
}
|
||||
|
||||
//class Target extends Annotation {}
|
||||
|
||||
class AnnotationsBuilder {
|
||||
private static $cache = array();
|
||||
|
||||
public function build($targetReflection) {
|
||||
$data = $this->parse($targetReflection);
|
||||
$annotations = array();
|
||||
foreach($data as $class => $parameters) {
|
||||
if(is_subclass_of($class, 'Annotation') && !Addendum::ignores($class)) {
|
||||
foreach($parameters as $params) {
|
||||
$annotationReflection = new ReflectionClass($class);
|
||||
$annotations[$class][] = $annotationReflection->newInstance($params, $targetReflection);
|
||||
}
|
||||
}
|
||||
}
|
||||
return $annotations;
|
||||
}
|
||||
|
||||
private function parse($reflection) {
|
||||
$key = $this->createName($reflection);
|
||||
if(!isset(self::$cache[$key])) {
|
||||
$parser = new AnnotationsMatcher;
|
||||
$parser->matches($this->getDocComment($reflection), $data);
|
||||
self::$cache[$key] = $data;
|
||||
}
|
||||
return self::$cache[$key];
|
||||
}
|
||||
|
||||
private function createName($target) {
|
||||
if($target instanceof ReflectionMethod) {
|
||||
return $target->getDeclaringClass()->getName().'::'.$target->getName();
|
||||
} elseif($target instanceof ReflectionProperty) {
|
||||
return $target->getDeclaringClass()->getName().'::$'.$target->getName();
|
||||
} else {
|
||||
return $target->getName();
|
||||
}
|
||||
}
|
||||
|
||||
protected function getDocComment($reflection) {
|
||||
return Addendum::getDocComment($reflection);
|
||||
}
|
||||
|
||||
public static function clearCache() {
|
||||
self::$cache = array();
|
||||
}
|
||||
}
|
||||
|
||||
class ReflectionAnnotatedClass extends ReflectionClass {
|
||||
private $annotations;
|
||||
|
||||
public function __construct($class) {
|
||||
parent::__construct($class);
|
||||
$this->annotations = $this->createAnnotationBuilder()->build($this);
|
||||
}
|
||||
|
||||
public function hasAnnotation($annotation) {
|
||||
return isset($this->annotations[$annotation]);
|
||||
}
|
||||
|
||||
public function getAnnotation($annotation) {
|
||||
return $this->hasAnnotation($annotation) ? end($this->annotations[$annotation]) : false;
|
||||
}
|
||||
|
||||
public function getAnnotations() {
|
||||
$result = array();
|
||||
foreach($this->annotations as $instances) {
|
||||
$result[] = end($instances);
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getAllAnnotations($restriction = false) {
|
||||
$result = array();
|
||||
foreach($this->annotations as $class => $instances) {
|
||||
if(!$restriction || $restriction == $class) {
|
||||
$result = array_merge($result, $instances);
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getConstructor() {
|
||||
return $this->createReflectionAnnotatedMethod(parent::getConstructor());
|
||||
}
|
||||
|
||||
public function getMethod($name) {
|
||||
return $this->createReflectionAnnotatedMethod(parent::getMethod($name));
|
||||
}
|
||||
|
||||
public function getMethods($filter = -1) {
|
||||
$result = array();
|
||||
foreach(parent::getMethods($filter) as $method) {
|
||||
$result[] = $this->createReflectionAnnotatedMethod($method);
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getProperty($name) {
|
||||
return $this->createReflectionAnnotatedProperty(parent::getProperty($name));
|
||||
}
|
||||
|
||||
public function getProperties($filter = -1) {
|
||||
$result = array();
|
||||
foreach(parent::getProperties($filter) as $property) {
|
||||
$result[] = $this->createReflectionAnnotatedProperty($property);
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getInterfaces() {
|
||||
$result = array();
|
||||
foreach(parent::getInterfaces() as $interface) {
|
||||
$result[] = $this->createReflectionAnnotatedClass($interface);
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getParentClass() {
|
||||
$class = parent::getParentClass();
|
||||
return $this->createReflectionAnnotatedClass($class);
|
||||
}
|
||||
|
||||
protected function createAnnotationBuilder() {
|
||||
return new AnnotationsBuilder();
|
||||
}
|
||||
|
||||
private function createReflectionAnnotatedClass($class) {
|
||||
return ($class !== false) ? new ReflectionAnnotatedClass($class->getName()) : false;
|
||||
}
|
||||
|
||||
private function createReflectionAnnotatedMethod($method) {
|
||||
return ($method !== null) ? new ReflectionAnnotatedMethod($this->getName(), $method->getName()) : null;
|
||||
}
|
||||
|
||||
private function createReflectionAnnotatedProperty($property) {
|
||||
return ($property !== null) ? new ReflectionAnnotatedProperty($this->getName(), $property->getName()) : null;
|
||||
}
|
||||
}
|
||||
|
||||
class ReflectionAnnotatedMethod extends ReflectionMethod {
|
||||
private $annotations;
|
||||
|
||||
public function __construct($class, $name) {
|
||||
parent::__construct($class, $name);
|
||||
$this->annotations = $this->createAnnotationBuilder()->build($this);
|
||||
}
|
||||
|
||||
public function hasAnnotation($annotation) {
|
||||
return isset($this->annotations[$annotation]);
|
||||
}
|
||||
|
||||
public function getAnnotation($annotation) {
|
||||
return ($this->hasAnnotation($annotation)) ? end($this->annotations[$annotation]) : false;
|
||||
}
|
||||
|
||||
public function getAnnotations() {
|
||||
$result = array();
|
||||
foreach($this->annotations as $instances) {
|
||||
$result[] = end($instances);
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getAllAnnotations($restriction = false) {
|
||||
$result = array();
|
||||
foreach($this->annotations as $class => $instances) {
|
||||
if(!$restriction || $restriction == $class) {
|
||||
$result = array_merge($result, $instances);
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getDeclaringClass() {
|
||||
$class = parent::getDeclaringClass();
|
||||
return new ReflectionAnnotatedClass($class->getName());
|
||||
}
|
||||
|
||||
protected function createAnnotationBuilder() {
|
||||
return new AnnotationsBuilder();
|
||||
}
|
||||
}
|
||||
|
||||
class ReflectionAnnotatedProperty extends ReflectionProperty {
|
||||
private $annotations;
|
||||
|
||||
public function __construct($class, $name) {
|
||||
parent::__construct($class, $name);
|
||||
$this->annotations = $this->createAnnotationBuilder()->build($this);
|
||||
}
|
||||
|
||||
public function hasAnnotation($annotation) {
|
||||
return isset($this->annotations[$annotation]);
|
||||
}
|
||||
|
||||
public function getAnnotation($annotation) {
|
||||
return ($this->hasAnnotation($annotation)) ? end($this->annotations[$annotation]) : false;
|
||||
}
|
||||
|
||||
public function getAnnotations() {
|
||||
$result = array();
|
||||
foreach($this->annotations as $instances) {
|
||||
$result[] = end($instances);
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getAllAnnotations($restriction = false) {
|
||||
$result = array();
|
||||
foreach($this->annotations as $class => $instances) {
|
||||
if(!$restriction || $restriction == $class) {
|
||||
$result = array_merge($result, $instances);
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getDeclaringClass() {
|
||||
$class = parent::getDeclaringClass();
|
||||
return new ReflectionAnnotatedClass($class->getName());
|
||||
}
|
||||
|
||||
protected function createAnnotationBuilder() {
|
||||
return new AnnotationsBuilder();
|
||||
}
|
||||
}
|
||||
|
||||
class Addendum {
|
||||
private static $rawMode;
|
||||
private static $ignore;
|
||||
|
||||
public static function getDocComment($reflection) {
|
||||
if(self::checkRawDocCommentParsingNeeded()) {
|
||||
$docComment = new DocComment();
|
||||
return $docComment->get($reflection);
|
||||
} else {
|
||||
return $reflection->getDocComment();
|
||||
}
|
||||
}
|
||||
|
||||
/** Raw mode test */
|
||||
private static function checkRawDocCommentParsingNeeded() {
|
||||
if(self::$rawMode === null) {
|
||||
$reflection = new ReflectionClass('Addendum');
|
||||
$method = $reflection->getMethod('checkRawDocCommentParsingNeeded');
|
||||
self::setRawMode($method->getDocComment() === false);
|
||||
}
|
||||
return self::$rawMode;
|
||||
}
|
||||
|
||||
public static function setRawMode($enabled = true) {
|
||||
if($enabled) {
|
||||
require_once(dirname(__FILE__).'/annotations/doc_comment.php');
|
||||
}
|
||||
self::$rawMode = $enabled;
|
||||
}
|
||||
|
||||
public static function resetIgnoredAnnotations() {
|
||||
self::$ignore = array();
|
||||
}
|
||||
|
||||
public static function ignores($class) {
|
||||
return isset(self::$ignore[$class]);
|
||||
}
|
||||
|
||||
public static function ignore() {
|
||||
foreach(func_get_args() as $class) {
|
||||
self::$ignore[$class] = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
?>
|
@ -1,352 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
* Addendum PHP Reflection Annotations
|
||||
* http://code.google.com/p/addendum/
|
||||
*
|
||||
* Copyright (C) 2006 Jan "johno Suchal <johno@jsmf.net>
|
||||
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
**/
|
||||
|
||||
class CompositeMatcher {
|
||||
protected $matchers = array();
|
||||
private $wasConstructed = false;
|
||||
|
||||
public function add($matcher) {
|
||||
$this->matchers[] = $matcher;
|
||||
}
|
||||
|
||||
public function matches($string, &$value) {
|
||||
if(!$this->wasConstructed) {
|
||||
$this->build();
|
||||
$this->wasConstructed = true;
|
||||
}
|
||||
return $this->match($string, $value);
|
||||
}
|
||||
|
||||
protected function build() {}
|
||||
}
|
||||
|
||||
class ParallelMatcher extends CompositeMatcher {
|
||||
protected function match($string, &$value) {
|
||||
$maxLength = false;
|
||||
$result = null;
|
||||
foreach($this->matchers as $matcher) {
|
||||
$length = $matcher->matches($string, $subvalue);
|
||||
if($maxLength === false || $length > $maxLength) {
|
||||
$maxLength = $length;
|
||||
$result = $subvalue;
|
||||
}
|
||||
}
|
||||
$value = $this->process($result);
|
||||
return $maxLength;
|
||||
}
|
||||
|
||||
protected function process($value) {
|
||||
return $value;
|
||||
}
|
||||
}
|
||||
|
||||
class SerialMatcher extends CompositeMatcher {
|
||||
protected function match($string, &$value) {
|
||||
$results = array();
|
||||
$total_length = 0;
|
||||
foreach($this->matchers as $matcher) {
|
||||
if(($length = $matcher->matches($string, $result)) === false) return false;
|
||||
$total_length += $length;
|
||||
$results[] = $result;
|
||||
$string = substr($string, $length);
|
||||
}
|
||||
$value = $this->process($results);
|
||||
return $total_length;
|
||||
}
|
||||
|
||||
protected function process($results) {
|
||||
return implode('', $results);
|
||||
}
|
||||
}
|
||||
|
||||
class SimpleSerialMatcher extends SerialMatcher {
|
||||
private $return_part_index;
|
||||
|
||||
public function __construct($return_part_index = 0) {
|
||||
$this->return_part_index = $return_part_index;
|
||||
}
|
||||
|
||||
public function process($parts) {
|
||||
return $parts[$this->return_part_index];
|
||||
}
|
||||
}
|
||||
|
||||
class RegexMatcher {
|
||||
private $regex;
|
||||
|
||||
public function __construct($regex) {
|
||||
$this->regex = $regex;
|
||||
}
|
||||
|
||||
public function matches($string, &$value) {
|
||||
if(preg_match("/^{$this->regex}/", $string, $matches)) {
|
||||
$value = $this->process($matches);
|
||||
return strlen($matches[0]);
|
||||
}
|
||||
$value = false;
|
||||
return false;
|
||||
}
|
||||
|
||||
protected function process($matches) {
|
||||
return $matches[0];
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationsMatcher {
|
||||
public function matches($string, &$annotations) {
|
||||
$annotations = array();
|
||||
$annotation_matcher = new AnnotationMatcher;
|
||||
while(true) {
|
||||
if(preg_match('/\s(?=@)/', $string, $matches, PREG_OFFSET_CAPTURE)) {
|
||||
$offset = $matches[0][1] + 1;
|
||||
$string = substr($string, $offset);
|
||||
} else {
|
||||
return; // no more annotations
|
||||
}
|
||||
if(($length = $annotation_matcher->matches($string, $data)) !== false) {
|
||||
$string = substr($string, $length);
|
||||
list($name, $params) = $data;
|
||||
$annotations[$name][] = $params;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationMatcher extends SerialMatcher {
|
||||
protected function build() {
|
||||
$this->add(new RegexMatcher('@'));
|
||||
$this->add(new RegexMatcher('[A-Z][a-zA-Z0-9_]+'));
|
||||
$this->add(new AnnotationParametersMatcher);
|
||||
}
|
||||
|
||||
protected function process($results) {
|
||||
return array($results[1], $results[2]);
|
||||
}
|
||||
}
|
||||
|
||||
class ConstantMatcher extends RegexMatcher {
|
||||
private $constant;
|
||||
|
||||
public function __construct($regex, $constant) {
|
||||
parent::__construct($regex);
|
||||
$this->constant = $constant;
|
||||
}
|
||||
|
||||
protected function process($matches) {
|
||||
return $this->constant;
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationParametersMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new ConstantMatcher('', array()));
|
||||
$this->add(new ConstantMatcher('\(\)', array()));
|
||||
$params_matcher = new SimpleSerialMatcher(1);
|
||||
$params_matcher->add(new RegexMatcher('\(\s*'));
|
||||
$params_matcher->add(new AnnotationValuesMatcher);
|
||||
$params_matcher->add(new RegexMatcher('\s*\)'));
|
||||
$this->add($params_matcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationValuesMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new AnnotationTopValueMatcher);
|
||||
$this->add(new AnnotationHashMatcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationTopValueMatcher extends AnnotationValueMatcher {
|
||||
protected function process($value) {
|
||||
return array('value' => $value);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationValueMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new ConstantMatcher('true', true));
|
||||
$this->add(new ConstantMatcher('false', false));
|
||||
$this->add(new ConstantMatcher('TRUE', true));
|
||||
$this->add(new ConstantMatcher('FALSE', false));
|
||||
$this->add(new AnnotationStringMatcher);
|
||||
$this->add(new AnnotationNumberMatcher);
|
||||
$this->add(new AnnotationArrayMatcher);
|
||||
$this->add(new AnnotationStaticConstantMatcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationKeyMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new RegexMatcher('[a-zA-Z][a-zA-Z0-9_]*'));
|
||||
$this->add(new AnnotationStringMatcher);
|
||||
$this->add(new AnnotationIntegerMatcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationPairMatcher extends SerialMatcher {
|
||||
protected function build() {
|
||||
$this->add(new AnnotationKeyMatcher);
|
||||
$this->add(new RegexMatcher('\s*=\s*'));
|
||||
$this->add(new AnnotationValueMatcher);
|
||||
}
|
||||
|
||||
protected function process($parts) {
|
||||
return array($parts[0] => $parts[2]);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationHashMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new AnnotationPairMatcher);
|
||||
$this->add(new AnnotationMorePairsMatcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationMorePairsMatcher extends SerialMatcher {
|
||||
protected function build() {
|
||||
$this->add(new AnnotationPairMatcher);
|
||||
$this->add(new RegexMatcher('\s*,\s*'));
|
||||
$this->add(new AnnotationHashMatcher);
|
||||
}
|
||||
|
||||
protected function match($string, &$value) {
|
||||
$result = parent::match($string, $value);
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function process($parts) {
|
||||
return array_merge($parts[0], $parts[2]);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationArrayMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new ConstantMatcher('{}', array()));
|
||||
$values_matcher = new SimpleSerialMatcher(1);
|
||||
$values_matcher->add(new RegexMatcher('\s*{\s*'));
|
||||
$values_matcher->add(new AnnotationArrayValuesMatcher);
|
||||
$values_matcher->add(new RegexMatcher('\s*}\s*'));
|
||||
$this->add($values_matcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationArrayValuesMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new AnnotationArrayValueMatcher);
|
||||
$this->add(new AnnotationMoreValuesMatcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationMoreValuesMatcher extends SimpleSerialMatcher {
|
||||
protected function build() {
|
||||
$this->add(new AnnotationArrayValueMatcher);
|
||||
$this->add(new RegexMatcher('\s*,\s*'));
|
||||
$this->add(new AnnotationArrayValuesMatcher);
|
||||
}
|
||||
|
||||
protected function match($string, &$value) {
|
||||
$result = parent::match($string, $value);
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function process($parts) {
|
||||
return array_merge($parts[0], $parts[2]);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationArrayValueMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new AnnotationValueInArrayMatcher);
|
||||
$this->add(new AnnotationPairMatcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationValueInArrayMatcher extends AnnotationValueMatcher {
|
||||
public function process($value) {
|
||||
return array($value);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationStringMatcher extends ParallelMatcher {
|
||||
protected function build() {
|
||||
$this->add(new AnnotationSingleQuotedStringMatcher);
|
||||
$this->add(new AnnotationDoubleQuotedStringMatcher);
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationNumberMatcher extends RegexMatcher {
|
||||
public function __construct() {
|
||||
parent::__construct("-?[0-9]*\.?[0-9]*");
|
||||
}
|
||||
|
||||
protected function process($matches) {
|
||||
$isFloat = strpos($matches[0], '.') !== false;
|
||||
return $isFloat ? (float) $matches[0] : (int) $matches[0];
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationIntegerMatcher extends RegexMatcher {
|
||||
public function __construct() {
|
||||
parent::__construct("-?[0-9]*");
|
||||
}
|
||||
|
||||
protected function process($matches) {
|
||||
return (int) $matches[0];
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationSingleQuotedStringMatcher extends RegexMatcher {
|
||||
public function __construct() {
|
||||
parent::__construct("'([^']*)'");
|
||||
}
|
||||
|
||||
protected function process($matches) {
|
||||
return $matches[1];
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationDoubleQuotedStringMatcher extends RegexMatcher {
|
||||
public function __construct() {
|
||||
parent::__construct('"([^"]*)"');
|
||||
}
|
||||
|
||||
protected function process($matches) {
|
||||
return $matches[1];
|
||||
}
|
||||
}
|
||||
|
||||
class AnnotationStaticConstantMatcher extends RegexMatcher {
|
||||
public function __construct() {
|
||||
parent::__construct('(\w+::\w+)');
|
||||
}
|
||||
|
||||
protected function process($matches) {
|
||||
$name = $matches[1];
|
||||
if(!defined($name)) {
|
||||
trigger_error("Constant '$name' used in annotation was not defined.");
|
||||
return false;
|
||||
}
|
||||
return constant($name);
|
||||
}
|
||||
|
||||
}
|
||||
?>
|
130
lib/vendor/addendum/annotations/doc_comment.php
vendored
130
lib/vendor/addendum/annotations/doc_comment.php
vendored
@ -1,130 +0,0 @@
|
||||
<?php
|
||||
class DocComment {
|
||||
private static $classes = array();
|
||||
private static $methods = array();
|
||||
private static $fields = array();
|
||||
private static $parsedFiles = array();
|
||||
|
||||
public static function clearCache() {
|
||||
self::$classes = array();
|
||||
self::$methods = array();
|
||||
self::$fields = array();
|
||||
self::$parsedFiles = array();
|
||||
}
|
||||
|
||||
public function get($reflection) {
|
||||
if($reflection instanceof ReflectionClass) {
|
||||
return $this->forClass($reflection);
|
||||
} elseif($reflection instanceof ReflectionMethod) {
|
||||
return $this->forMethod($reflection);
|
||||
} elseif($reflection instanceof ReflectionProperty) {
|
||||
return $this->forProperty($reflection);
|
||||
}
|
||||
}
|
||||
|
||||
public function forClass($reflection) {
|
||||
$this->process($reflection->getFileName());
|
||||
$name = $reflection->getName();
|
||||
return isset(self::$classes[$name]) ? self::$classes[$name] : false;
|
||||
}
|
||||
|
||||
public function forMethod($reflection) {
|
||||
$this->process($reflection->getDeclaringClass()->getFileName());
|
||||
$class = $reflection->getDeclaringClass()->getName();
|
||||
$method = $reflection->getName();
|
||||
return isset(self::$methods[$class][$method]) ? self::$methods[$class][$method] : false;
|
||||
}
|
||||
|
||||
public function forProperty($reflection) {
|
||||
$this->process($reflection->getDeclaringClass()->getFileName());
|
||||
$class = $reflection->getDeclaringClass()->getName();
|
||||
$field = $reflection->getName();
|
||||
return isset(self::$fields[$class][$field]) ? self::$fields[$class][$field] : false;
|
||||
}
|
||||
|
||||
private function process($file) {
|
||||
if(!isset(self::$parsedFiles[$file])) {
|
||||
$this->parse($file);
|
||||
self::$parsedFiles[$file] = true;
|
||||
}
|
||||
}
|
||||
|
||||
protected function parse($file) {
|
||||
$tokens = $this->getTokens($file);
|
||||
$currentClass = false;
|
||||
$currentBlock = false;
|
||||
$max = count($tokens);
|
||||
$i = 0;
|
||||
while($i < $max) {
|
||||
$token = $tokens[$i];
|
||||
if(is_array($token)) {
|
||||
list($code, $value) = $token;
|
||||
switch($code) {
|
||||
case T_DOC_COMMENT:
|
||||
$comment = $value;
|
||||
break;
|
||||
|
||||
case T_CLASS:
|
||||
$class = $this->getString($tokens, $i, $max);
|
||||
if($comment !== false) {
|
||||
self::$classes[$class] = $comment;
|
||||
$comment = false;
|
||||
}
|
||||
break;
|
||||
|
||||
case T_VARIABLE:
|
||||
if($comment !== false) {
|
||||
$field = substr($token[1], 1);
|
||||
self::$fields[$class][$field] = $comment;
|
||||
$comment = false;
|
||||
}
|
||||
break;
|
||||
|
||||
case T_FUNCTION:
|
||||
if($comment !== false) {
|
||||
$function = $this->getString($tokens, $i, $max);
|
||||
self::$methods[$class][$function] = $comment;
|
||||
$comment = false;
|
||||
}
|
||||
|
||||
break;
|
||||
|
||||
// ignore
|
||||
case T_WHITESPACE:
|
||||
case T_PUBLIC:
|
||||
case T_PROTECTED:
|
||||
case T_PRIVATE:
|
||||
case T_ABSTRACT:
|
||||
case T_FINAL:
|
||||
case T_VAR:
|
||||
break;
|
||||
|
||||
default:
|
||||
$comment = false;
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
$comment = false;
|
||||
}
|
||||
$i++;
|
||||
}
|
||||
}
|
||||
|
||||
private function getString($tokens, &$i, $max) {
|
||||
do {
|
||||
$token = $tokens[$i];
|
||||
$i++;
|
||||
if(is_array($token)) {
|
||||
if($token[0] == T_STRING) {
|
||||
return $token[1];
|
||||
}
|
||||
}
|
||||
} while($i <= $max);
|
||||
return false;
|
||||
}
|
||||
|
||||
private function getTokens($file) {
|
||||
return token_get_all(file_get_contents($file));
|
||||
}
|
||||
}
|
||||
?>
|
@ -1,289 +0,0 @@
|
||||
<?php
|
||||
require_once('simpletest/autorun.php');
|
||||
require_once('simpletest/mock_objects.php');
|
||||
|
||||
require_once(dirname(__FILE__).'/../../annotations.php');
|
||||
|
||||
interface DummyInterface {}
|
||||
|
||||
class ParentExample {}
|
||||
|
||||
/** @FirstAnnotation @SecondAnnotation */
|
||||
class Example extends ParentExample implements DummyInterface {
|
||||
/** @SecondAnnotation */
|
||||
private $exampleProperty;
|
||||
|
||||
public $publicOne;
|
||||
|
||||
public function __construct() {}
|
||||
|
||||
/** @FirstAnnotation */
|
||||
public function exampleMethod() {
|
||||
}
|
||||
|
||||
private function justPrivate() {}
|
||||
}
|
||||
|
||||
/** @FirstAnnotation(1) @FirstAnnotation(2) @SecondAnnotation(3) */
|
||||
class MultiExample {
|
||||
/** @FirstAnnotation(1) @FirstAnnotation(2) @SecondAnnotation(3) */
|
||||
public $property;
|
||||
|
||||
/** @FirstAnnotation(1) @FirstAnnotation(2) @SecondAnnotation(3) */
|
||||
public function aMethod() {}
|
||||
}
|
||||
|
||||
class FirstAnnotation extends Annotation {}
|
||||
class SecondAnnotation extends Annotation {}
|
||||
|
||||
class NoAnnotation {}
|
||||
|
||||
/** @NoAnnotation @FirstAnnotation */
|
||||
class ExampleWithInvalidAnnotation {}
|
||||
|
||||
/** @SelfReferencingAnnotation */
|
||||
class SelfReferencingAnnotation extends Annotation {}
|
||||
|
||||
/** @IndirectReferenceLoopAnnotationHelper */
|
||||
class IndirectReferenceLoopAnnotation extends Annotation {}
|
||||
|
||||
/** @IndirectReferenceLoopAnnotation */
|
||||
class IndirectReferenceLoopAnnotationHelper extends Annotation {}
|
||||
|
||||
|
||||
class Statics {
|
||||
const A_CONSTANT = 'constant';
|
||||
static public $static = 'static';
|
||||
}
|
||||
|
||||
/** @FirstAnnotation(Statics::A_CONSTANT) */
|
||||
class ClassAnnotatedWithStaticConstant {}
|
||||
|
||||
/** @FirstAnnotation(Statics::UNKNOWN_CONSTANT) */
|
||||
class ClassAnnotatedWithNonExistingConstant {}
|
||||
|
||||
class TestOfAnnotations extends UnitTestCase {
|
||||
public function testReflectionAnnotatedClass() {
|
||||
$reflection = new ReflectionAnnotatedClass('Example');
|
||||
$this->assertTrue($reflection->hasAnnotation('FirstAnnotation'));
|
||||
$this->assertTrue($reflection->hasAnnotation('SecondAnnotation'));
|
||||
$this->assertFalse($reflection->hasAnnotation('NonExistentAnnotation'));
|
||||
$this->assertIsA($reflection->getAnnotation('FirstAnnotation'), 'FirstAnnotation');
|
||||
$this->assertIsA($reflection->getAnnotation('SecondAnnotation'), 'SecondAnnotation');
|
||||
|
||||
$annotations = $reflection->getAnnotations();
|
||||
$this->assertEqual(count($annotations), 2);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[1], 'SecondAnnotation');
|
||||
$this->assertFalse($reflection->getAnnotation('NonExistentAnnotation'));
|
||||
|
||||
$this->assertIsA($reflection->getConstructor(), 'ReflectionAnnotatedMethod');
|
||||
$this->assertIsA($reflection->getMethod('exampleMethod'), 'ReflectionAnnotatedMethod');
|
||||
foreach($reflection->getMethods() as $method) {
|
||||
$this->assertIsA($method, 'ReflectionAnnotatedMethod');
|
||||
}
|
||||
|
||||
$this->assertIsA($reflection->getProperty('exampleProperty'), 'ReflectionAnnotatedProperty');
|
||||
foreach($reflection->getProperties() as $property) {
|
||||
$this->assertIsA($property, 'ReflectionAnnotatedProperty');
|
||||
}
|
||||
|
||||
foreach($reflection->getInterfaces() as $interface) {
|
||||
$this->assertIsA($interface, 'ReflectionAnnotatedClass');
|
||||
}
|
||||
|
||||
$this->assertIsA($reflection->getParentClass(), 'ReflectionAnnotatedClass');
|
||||
}
|
||||
|
||||
public function testReflectionAnnotatedMethod() {
|
||||
$reflection = new ReflectionAnnotatedMethod('Example', 'exampleMethod');
|
||||
$this->assertTrue($reflection->hasAnnotation('FirstAnnotation'));
|
||||
$this->assertFalse($reflection->hasAnnotation('NonExistentAnnotation'));
|
||||
$this->assertIsA($reflection->getAnnotation('FirstAnnotation'), 'FirstAnnotation');
|
||||
$this->assertFalse($reflection->getAnnotation('NonExistentAnnotation'));
|
||||
|
||||
$annotations = $reflection->getAnnotations();
|
||||
$this->assertEqual(count($annotations), 1);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
|
||||
$this->assertIsA($reflection->getDeclaringClass(), 'ReflectionAnnotatedClass');
|
||||
}
|
||||
|
||||
public function testReflectionAnnotatedProperty() {
|
||||
$reflection = new ReflectionAnnotatedProperty('Example', 'exampleProperty');
|
||||
$this->assertTrue($reflection->hasAnnotation('SecondAnnotation'));
|
||||
$this->assertFalse($reflection->hasAnnotation('FirstAnnotation'));
|
||||
$this->assertIsA($reflection->getAnnotation('SecondAnnotation'), 'SecondAnnotation');
|
||||
$this->assertFalse($reflection->getAnnotation('NonExistentAnnotation'));
|
||||
|
||||
$annotations = $reflection->getAnnotations();
|
||||
$this->assertEqual(count($annotations), 1);
|
||||
$this->assertIsA($annotations[0], 'SecondAnnotation');
|
||||
|
||||
$this->assertIsA($reflection->getDeclaringClass(), 'ReflectionAnnotatedClass');
|
||||
}
|
||||
|
||||
public function testReflectionClassCanFilterMethodsByAccess() {
|
||||
$reflection = new ReflectionAnnotatedClass('Example');
|
||||
$privateMethods = $reflection->getMethods(ReflectionMethod::IS_PRIVATE);
|
||||
$this->assertEqual(count($privateMethods), 1);
|
||||
$this->assertEqual($privateMethods[0]->getName(), 'justPrivate');
|
||||
}
|
||||
|
||||
public function testReflectionClassCanFilterPropertiesByAccess() {
|
||||
$reflection = new ReflectionAnnotatedClass('Example');
|
||||
$privateProperties = $reflection->getProperties(ReflectionProperty::IS_PUBLIC);
|
||||
$this->assertEqual(count($privateProperties), 1);
|
||||
$this->assertEqual($privateProperties[0]->getName(), 'publicOne');
|
||||
}
|
||||
|
||||
public function testReflectionClassShouldReturnAllMethodsWithNoFilter() {
|
||||
$reflection = new ReflectionAnnotatedClass('Example');
|
||||
$methods = $reflection->getMethods();
|
||||
$this->assertEqual(count($methods), 3);
|
||||
}
|
||||
|
||||
public function testReflectionClassShouldReturnAllPropertiesWithNoFilter() {
|
||||
$reflection = new ReflectionAnnotatedClass('Example');
|
||||
$properties = $reflection->getProperties();
|
||||
$this->assertEqual(count($properties), 2);
|
||||
}
|
||||
|
||||
public function testMultipleAnnotationsOnClass() {
|
||||
$reflection = new ReflectionAnnotatedClass('MultiExample');
|
||||
$annotations = $reflection->getAllAnnotations();
|
||||
$this->assertEqual(count($annotations), 3);
|
||||
$this->assertEqual($annotations[0]->value, 1);
|
||||
$this->assertEqual($annotations[1]->value, 2);
|
||||
$this->assertEqual($annotations[2]->value, 3);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[1], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[2], 'SecondAnnotation');
|
||||
}
|
||||
|
||||
public function testMultipleAnnotationsOnClassWithRestriction() {
|
||||
$reflection = new ReflectionAnnotatedClass('MultiExample');
|
||||
$annotations = $reflection->getAllAnnotations('FirstAnnotation');
|
||||
$this->assertEqual(count($annotations), 2);
|
||||
$this->assertEqual($annotations[0]->value, 1);
|
||||
$this->assertEqual($annotations[1]->value, 2);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[1], 'FirstAnnotation');
|
||||
}
|
||||
|
||||
public function testMultipleAnnotationsOnProperty() {
|
||||
$reflection = new ReflectionAnnotatedClass('MultiExample');
|
||||
$reflection = $reflection->getProperty('property');
|
||||
$annotations = $reflection->getAllAnnotations();
|
||||
$this->assertEqual(count($annotations), 3);
|
||||
$this->assertEqual($annotations[0]->value, 1);
|
||||
$this->assertEqual($annotations[1]->value, 2);
|
||||
$this->assertEqual($annotations[2]->value, 3);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[1], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[2], 'SecondAnnotation');
|
||||
}
|
||||
|
||||
public function testMultipleAnnotationsOnPropertyWithRestriction() {
|
||||
$reflection = new ReflectionAnnotatedClass('MultiExample');
|
||||
$reflection = $reflection->getProperty('property');
|
||||
$annotations = $reflection->getAllAnnotations('FirstAnnotation');
|
||||
$this->assertEqual(count($annotations), 2);
|
||||
$this->assertEqual($annotations[0]->value, 1);
|
||||
$this->assertEqual($annotations[1]->value, 2);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[1], 'FirstAnnotation');
|
||||
}
|
||||
|
||||
public function testMultipleAnnotationsOnMethod() {
|
||||
$reflection = new ReflectionAnnotatedClass('MultiExample');
|
||||
$reflection = $reflection->getMethod('aMethod');
|
||||
$annotations = $reflection->getAllAnnotations();
|
||||
$this->assertEqual(count($annotations), 3);
|
||||
$this->assertEqual($annotations[0]->value, 1);
|
||||
$this->assertEqual($annotations[1]->value, 2);
|
||||
$this->assertEqual($annotations[2]->value, 3);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[1], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[2], 'SecondAnnotation');
|
||||
}
|
||||
|
||||
public function testMultipleAnnotationsOnMethodWithRestriction() {
|
||||
$reflection = new ReflectionAnnotatedClass('MultiExample');
|
||||
$reflection = $reflection->getMethod('aMethod');
|
||||
$annotations = $reflection->getAllAnnotations('FirstAnnotation');
|
||||
$this->assertEqual(count($annotations), 2);
|
||||
$this->assertEqual($annotations[0]->value, 1);
|
||||
$this->assertEqual($annotations[1]->value, 2);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
$this->assertIsA($annotations[1], 'FirstAnnotation');
|
||||
}
|
||||
|
||||
public function testClassWithNoAnnotationParentShouldNotBeParsed() {
|
||||
$reflection = new ReflectionAnnotatedClass('ExampleWithInvalidAnnotation');
|
||||
$annotations = $reflection = $reflection->getAnnotations();
|
||||
$this->assertEqual(count($annotations), 1);
|
||||
$this->assertIsA($annotations[0], 'FirstAnnotation');
|
||||
}
|
||||
|
||||
public function testCircularReferenceShouldThrowError() {
|
||||
$this->expectError("Circular annotation reference on 'SelfReferencingAnnotation'");
|
||||
$reflection = new ReflectionAnnotatedClass('SelfReferencingAnnotation');
|
||||
$reflection->getAnnotations();
|
||||
|
||||
$this->expectError("Circular annotation reference on 'IndirectReferenceLoopAnnotationHelper'");
|
||||
$reflection = new ReflectionAnnotatedClass('IndirectReferenceLoopAnnotation');
|
||||
$reflection->getAnnotations();
|
||||
}
|
||||
|
||||
public function testConstInAnnotationShouldReturnCorrectValue() {
|
||||
$reflection = new ReflectionAnnotatedClass('ClassAnnotatedWithStaticConstant');
|
||||
$annotation = $reflection->getAnnotation('FirstAnnotation');
|
||||
$this->assertEqual($annotation->value, Statics::A_CONSTANT);
|
||||
}
|
||||
|
||||
public function testBadConstInAnnotationShouldCauseError() {
|
||||
$this->expectError("Constant 'Statics::UNKNOWN_CONSTANT' used in annotation was not defined.");
|
||||
$reflection = new ReflectionAnnotatedClass('ClassAnnotatedWithNonExistingConstant');
|
||||
$annotation = $reflection->getAnnotation('FirstAnnotation');
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Mock::generatePartial('AnnotationsBuilder', 'MockedAnnotationsBuilder', array('getDocComment'));
|
||||
|
||||
class TestOfPerformanceFeatures extends UnitTestCase {
|
||||
public function setUp() {
|
||||
AnnotationsBuilder::clearCache();
|
||||
}
|
||||
|
||||
public function tearDown() {
|
||||
AnnotationsBuilder::clearCache();
|
||||
}
|
||||
|
||||
public function testBuilderShouldCacheResults() {
|
||||
$builder = new MockedAnnotationsBuilder;
|
||||
$reflection = new ReflectionClass('Example');
|
||||
$builder->build($reflection);
|
||||
$builder->build($reflection);
|
||||
$builder->expectOnce('getDocComment');
|
||||
}
|
||||
}
|
||||
|
||||
class TestOfSupportingFeatures extends UnitTestCase {
|
||||
public function setUp() {
|
||||
Addendum::resetIgnoredAnnotations();
|
||||
}
|
||||
|
||||
public function tearDown() {
|
||||
Addendum::resetIgnoredAnnotations();
|
||||
}
|
||||
|
||||
public function testIgnoredAnnotationsAreNotUsed() {
|
||||
Addendum::ignore('FirstAnnotation', 'SecondAnnotation');
|
||||
$reflection = new ReflectionAnnotatedClass('Example');
|
||||
$this->assertFalse($reflection->hasAnnotation('FirstAnnotation'));
|
||||
$this->assertFalse($reflection->hasAnnotation('SecondAnnotation'));
|
||||
}
|
||||
}
|
||||
?>
|
@ -1,28 +0,0 @@
|
||||
<?php
|
||||
require_once('simpletest/unit_tester.php');
|
||||
require_once('simpletest/reporter.php');
|
||||
|
||||
require_once(dirname(__FILE__).'/acceptance_test.php');
|
||||
require_once(dirname(__FILE__).'/annotation_test.php');
|
||||
require_once(dirname(__FILE__).'/constrained_annotation_test.php');
|
||||
require_once(dirname(__FILE__).'/annotation_parser_test.php');
|
||||
require_once(dirname(__FILE__).'/doc_comment_test.php');
|
||||
|
||||
$suite = new TestSuite('All tests');
|
||||
$suite->add(new TestOfAnnotations);
|
||||
$suite->add(new TestOfPerformanceFeatures);
|
||||
$suite->add(new TestOfSupportingFeatures);
|
||||
$suite->add(new TestOfAnnotation);
|
||||
$suite->add(new TestOfConstrainedAnnotation);
|
||||
$suite->add(new TestOfMatchers);
|
||||
$suite->add(new TestOfAnnotationMatchers);
|
||||
$suite->add(new TestOfDocComment);
|
||||
|
||||
$reporter = TextReporter::inCli() ? new TextReporter() : new HtmlReporter();
|
||||
|
||||
Addendum::setRawMode(false);
|
||||
$suite->run($reporter);
|
||||
|
||||
Addendum::setRawMode(true);
|
||||
$suite->run($reporter);
|
||||
?>
|
@ -1,334 +0,0 @@
|
||||
<?php
|
||||
require_once('simpletest/autorun.php');
|
||||
require_once(dirname(__FILE__).'/../annotation_parser.php');
|
||||
|
||||
class TestOfMatchers extends UnitTestCase {
|
||||
public function testRegexMatcherShouldMatchPatternAndReturnLengthOfMatch() {
|
||||
$matcher = new RegexMatcher('[0-9]+');
|
||||
$this->assertIdentical($matcher->matches('1234a', $value), 4);
|
||||
$this->assertIdentical($value, '1234');
|
||||
}
|
||||
|
||||
public function testRegexMatcherShouldReturnFalseOnNoMatch() {
|
||||
$matcher = new RegexMatcher('[0-9]+');
|
||||
$this->assertFalse($matcher->matches('abc123', $value));
|
||||
}
|
||||
|
||||
public function testParallelMatcherShouldMatchLongerStringOnColision() {
|
||||
$matcher = new ParallelMatcher;
|
||||
$matcher->add(new RegexMatcher('true'));
|
||||
$matcher->add(new RegexMatcher('.+'));
|
||||
$this->assertEqual($matcher->matches('truestring', $value), 10);
|
||||
$this->assertEqual($value, 'truestring');
|
||||
}
|
||||
|
||||
public function testSerialMatcherShouldMatchAllParts() {
|
||||
$matcher = new SerialMatcher;
|
||||
$matcher->add(new RegexMatcher('[a-zA-Z0-9_]+'));
|
||||
$matcher->add(new RegexMatcher('='));
|
||||
$matcher->add(new RegexMatcher('[0-9]+'));
|
||||
$this->assertEqual($matcher->matches('key=20', $value), 6);
|
||||
$this->assertEqual($value, 'key=20');
|
||||
}
|
||||
|
||||
public function testSerialMatcherShouldFailIfAnyPartDoesNotMatch() {
|
||||
$matcher = new SerialMatcher;
|
||||
$matcher->add(new RegexMatcher('[a-zA-Z0-9_]+'));
|
||||
$matcher->add(new RegexMatcher('='));
|
||||
$matcher->add(new RegexMatcher('[0-9]+'));
|
||||
$this->assertFalse($matcher->matches('key=a20', $value));
|
||||
}
|
||||
|
||||
public function testSimpleSerialMatcherShouldReturnRequestedPartOnMatch() {
|
||||
$matcher = new SimpleSerialMatcher(1);
|
||||
$matcher->add(new RegexMatcher('\('));
|
||||
$matcher->add(new RegexMatcher('[0-9]+'));
|
||||
$matcher->add(new RegexMatcher('\)'));
|
||||
$this->assertEqual($matcher->matches('(1234)', $value), 6);
|
||||
$this->assertEqual($value, '1234');
|
||||
}
|
||||
}
|
||||
|
||||
class StaticClass {
|
||||
const A_CONSTANT = 'constant';
|
||||
}
|
||||
|
||||
|
||||
class TestOfAnnotationMatchers extends UnitTestCase {
|
||||
public function testAnnotationsMatcherShouldMatchAnnotationWithGarbage() {
|
||||
$expected = array('Annotation' => array(
|
||||
array('value' => true),
|
||||
));
|
||||
$matcher = new AnnotationsMatcher;
|
||||
$this->assertMatcherResult($matcher, '/** asd bla bla @Annotation(true) */@', $expected);
|
||||
}
|
||||
|
||||
public function testAnnotationsMatcherShouldNotMatchEmail() {
|
||||
$matcher = new AnnotationsMatcher;
|
||||
$this->assertMatcherResult($matcher, 'johno@example.com', array());
|
||||
}
|
||||
|
||||
public function testAnnotationsMatcherShouldMatchMultipleAnnotations() {
|
||||
$expected = array('Annotation' => array(
|
||||
array('value' => true),
|
||||
array('value' => false)
|
||||
));
|
||||
$matcher = new AnnotationsMatcher;
|
||||
$this->assertMatcherResult($matcher, ' ss @Annotation(true) @Annotation(false)', $expected);
|
||||
}
|
||||
|
||||
public function testAnnotationsMatcherShouldMatchMultipleAnnotationsOnManyLines() {
|
||||
$expected = array('Annotation' => array(
|
||||
array('value' => true),
|
||||
array('value' => false)
|
||||
));
|
||||
$block = "/**
|
||||
@Annotation(true)
|
||||
@Annotation(false)
|
||||
**/";
|
||||
$matcher = new AnnotationsMatcher;
|
||||
$this->assertMatcherResult($matcher, $block, $expected);
|
||||
}
|
||||
|
||||
public function testAnnotationMatcherShouldMatchMultilineAnnotations() {
|
||||
$block= '/**
|
||||
* @Annotation(
|
||||
paramOne="value1",
|
||||
paramTwo={
|
||||
"value2" ,
|
||||
{"one", "two"}
|
||||
},
|
||||
paramThree="three"
|
||||
)
|
||||
*/';
|
||||
$expected = array('Annotation' => array(
|
||||
array(
|
||||
'paramOne' => 'value1',
|
||||
'paramTwo' => array('value2', array('one', 'two')),
|
||||
'paramThree' => 'three',
|
||||
)
|
||||
));
|
||||
$matcher = new AnnotationsMatcher;
|
||||
$this->assertMatcherResult($matcher, $block, $expected);
|
||||
}
|
||||
|
||||
public function testAnnotationMatcherShouldMatchSimpleAnnotation() {
|
||||
$matcher = new AnnotationMatcher;
|
||||
$this->assertNotFalse($matcher->matches('@Namespace_Annotation', $value));
|
||||
$this->assertEqual($value, array('Namespace_Annotation', array()));
|
||||
}
|
||||
|
||||
public function testAnnotationMatcherShouldNotMatchAnnotationWithSmallStartingLetter() {
|
||||
$matcher = new AnnotationMatcher;
|
||||
$this->assertFalse($matcher->matches('@annotation', $value));
|
||||
}
|
||||
|
||||
public function testAnnotationMatcherShouldMatchAlsoBrackets() {
|
||||
$matcher = new AnnotationMatcher;
|
||||
$this->assertEqual($matcher->matches('@Annotation()', $value), 13);
|
||||
$this->assertEqual($value, array('Annotation', array()));
|
||||
}
|
||||
|
||||
public function testAnnotationMatcherShouldMatchValuedAnnotation() {
|
||||
$matcher = new AnnotationMatcher;
|
||||
$this->assertMatcherResult($matcher, '@Annotation(true)', array('Annotation', array('value' => true)));
|
||||
}
|
||||
|
||||
public function testAnnotationMatcherShouldMatchMultiValuedAnnotation() {
|
||||
$matcher = new AnnotationMatcher;
|
||||
$this->assertMatcherResult($matcher, '@Annotation(key=true, key2=3.14)', array('Annotation', array('key' => true, 'key2' => 3.14)));
|
||||
}
|
||||
|
||||
public function testParametersMatcherShouldMatchEmptyStringAndReturnEmptyArray() {
|
||||
$matcher = new AnnotationParametersMatcher;
|
||||
$this->assertIdentical($matcher->matches('', $value), 0);
|
||||
$this->assertEqual($value, array());
|
||||
}
|
||||
|
||||
public function testParametersMatcherShouldMatchEmptyBracketsAndReturnEmptyArray() {
|
||||
$matcher = new AnnotationParametersMatcher;
|
||||
$this->assertIdentical($matcher->matches('()', $value), 2);
|
||||
$this->assertEqual($value, array());
|
||||
}
|
||||
|
||||
public function testParametersMatcherShouldMatchMultilinedParameters() {
|
||||
$matcher = new AnnotationParametersMatcher;
|
||||
$block = "(
|
||||
key = true,
|
||||
key2 = false
|
||||
)";
|
||||
$this->assertMatcherResult($matcher, $block, array('key' => true, 'key2' => false));
|
||||
}
|
||||
|
||||
public function testValuesMatcherShouldMatchSimpleValueOrHash() {
|
||||
$matcher = new AnnotationValuesMatcher;
|
||||
$this->assertNotFalse($matcher->matches('true', $value));
|
||||
$this->assertNotFalse($matcher->matches('key=true', $value));
|
||||
}
|
||||
|
||||
public function testValueMatcherShouldMatchConstants() {
|
||||
$matcher = new AnnotationValueMatcher;
|
||||
$this->assertMatcherResult($matcher, 'true', true);
|
||||
$this->assertMatcherResult($matcher, 'false', false);
|
||||
$this->assertMatcherResult($matcher, 'TRUE', true);
|
||||
$this->assertMatcherResult($matcher, 'FALSE', false);
|
||||
}
|
||||
|
||||
public function testValueMatcherShouldMatchStrings() {
|
||||
$matcher = new AnnotationValueMatcher;
|
||||
$this->assertMatcherResult($matcher, '"string"', 'string');
|
||||
$this->assertMatcherResult($matcher, "'string'", 'string');
|
||||
}
|
||||
|
||||
public function testValueMatcherShouldMatchNumbers() {
|
||||
$matcher = new AnnotationValueMatcher;
|
||||
$this->assertMatcherResult($matcher, '-3.14', -3.14);
|
||||
$this->assertMatcherResult($matcher, '100', 100);
|
||||
}
|
||||
|
||||
public function testValueMatcherShouldMatchArray() {
|
||||
$matcher = new AnnotationValueMatcher;
|
||||
$this->assertMatcherResult($matcher, '{1}', array(1));
|
||||
}
|
||||
|
||||
public function testValueMatcherShouldMatchStaticConstant() {
|
||||
$matcher = new AnnotationValueMatcher;
|
||||
$this->assertMatcherResult($matcher, 'StaticClass::A_CONSTANT', StaticClass::A_CONSTANT);
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchEmptyArray() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, '{}', array());
|
||||
}
|
||||
|
||||
public function testValueInArrayMatcherReturnsAValueInArray() {
|
||||
$matcher = new AnnotationValueInArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, '1', array(1));
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchSimpleValueInArray() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, '{1}', array(1));
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchSimplePair() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, '{key=5}', array('key' => 5));
|
||||
}
|
||||
|
||||
public function TODO_testArrayMatcherShouldMatchPairWithNumericKeys() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, '{1="one", 2="two"}', array(1 => 'one', 2 => 'two'));
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchMultiplePairs() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, '{key=5, "bla"=false}', array('key' => 5, 'bla' => false));
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchValuesMixedWithPairs() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, '{key=5, 1, 2, key2="ff"}', array('key' => 5, 1, 2, 'key2' => "ff"));
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchMoreValuesInArrayWithWhiteSpace() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, "{1 , 2}", array(1, 2));
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchNestedArray() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, "{1 , {2, 3}, 4}", array(1, array(2, 3), 4));
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchWithMoreWhiteSpace() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, "{ 1 , 2 , 3 }", array(1, 2, 3));
|
||||
}
|
||||
|
||||
public function testArrayMatcherShouldMatchWithMultilineWhiteSpace() {
|
||||
$matcher = new AnnotationArrayMatcher;
|
||||
$this->assertMatcherResult($matcher, "\n{1, 2, 3\n}", array(1, 2, 3));
|
||||
}
|
||||
|
||||
public function testNumberMatcherShouldMatchInteger() {
|
||||
$matcher = new AnnotationNumberMatcher;
|
||||
$this->assertMatcherResult($matcher, '-314', -314);
|
||||
}
|
||||
|
||||
public function testNumberMatcherShouldMatchFloat() {
|
||||
$matcher = new AnnotationNumberMatcher;
|
||||
$this->assertMatcherResult($matcher, '-3.14', -3.14);
|
||||
}
|
||||
|
||||
public function testHashMatcherShouldMatchSimpleHash() {
|
||||
$matcher = new AnnotationHashMatcher;
|
||||
$this->assertMatcherResult($matcher, 'key=true', array('key' => true));
|
||||
}
|
||||
|
||||
public function testHashMatcherShouldMatchAlsoMultipleKeys() {
|
||||
$matcher = new AnnotationHashMatcher;
|
||||
$this->assertMatcherResult($matcher, 'key=true,key2=false', array('key' => true, 'key2' => false));
|
||||
}
|
||||
|
||||
public function testHashMatcherShouldMatchAlsoMultipleKeysWithWhiteSpace() {
|
||||
$matcher = new AnnotationHashMatcher;
|
||||
$this->assertMatcherResult($matcher, "key=true\n\t\r ,\n\t\r key2=false", array('key' => true, 'key2' => false));
|
||||
}
|
||||
|
||||
public function testPairMatcherShouldMatchNumericKey() {
|
||||
$matcher = new AnnotationPairMatcher;
|
||||
$this->assertMatcherResult($matcher, '2 = true', array(2 => true));
|
||||
}
|
||||
|
||||
public function testPairMatcherShouldMatchAlsoWhitespace() {
|
||||
$matcher = new AnnotationPairMatcher;
|
||||
$this->assertMatcherResult($matcher, 'key = true', array('key' => true));
|
||||
}
|
||||
|
||||
public function testKeyMatcherShouldMatchSimpleKeysOrStrings() {
|
||||
$matcher = new AnnotationKeyMatcher;
|
||||
$this->assertNotFalse($matcher->matches('key', $value));
|
||||
$this->assertNotFalse($matcher->matches('"key"', $value));
|
||||
$this->assertNotFalse($matcher->matches("'key'", $value));
|
||||
}
|
||||
|
||||
public function testKeyMatcherShouldMatchIntegerKeys() {
|
||||
$matcher = new AnnotationKeyMatcher;
|
||||
$this->assertMatcherResult($matcher, '123', 123);
|
||||
}
|
||||
|
||||
public function testStringMatcherShouldMatchDoubleAndSingleQuotedStringsAndHandleEscapes() {
|
||||
$matcher = new AnnotationStringMatcher;
|
||||
$this->assertMatcherResult($matcher, '"string string"', 'string string');
|
||||
$this->assertMatcherResult($matcher, "'string string'", "string string");
|
||||
}
|
||||
|
||||
public function TODO_testStringMatcherShouldMatchEscapedStringsCorrectly() {
|
||||
$matcher = new AnnotationStringMatcher;
|
||||
$this->assertMatcherResult($matcher, '"string\"string"', 'string"string');
|
||||
$this->assertMatcherResult($matcher, "'string\'string'", "string'string");
|
||||
}
|
||||
|
||||
public function testStaticConstantMatcherShouldMatchConstants() {
|
||||
$matcher = new AnnotationStaticConstantMatcher;
|
||||
$this->assertMatcherResult($matcher, 'StaticClass::A_CONSTANT', StaticClass::A_CONSTANT);
|
||||
}
|
||||
|
||||
public function testStaticConstantMatcherShouldThrowErrorOnBadConstant() {
|
||||
$this->expectError("Constant 'StaticClass::NO_CONSTANT' used in annotation was not defined.");
|
||||
$matcher = new AnnotationStaticConstantMatcher;
|
||||
$matcher->matches('StaticClass::NO_CONSTANT', $value);
|
||||
}
|
||||
|
||||
|
||||
private function assertNotFalse($value) {
|
||||
$this->assertNotIdentical($value, false);
|
||||
}
|
||||
|
||||
private function assertMatcherResult($matcher, $string, $expected) {
|
||||
$this->assertNotIdentical($matcher->matches($string, $value), false);
|
||||
$this->assertIdentical($value, $expected);
|
||||
}
|
||||
}
|
||||
?>
|
@ -1,27 +0,0 @@
|
||||
<?php
|
||||
require_once('simpletest/autorun.php');
|
||||
require_once(dirname(__FILE__).'/../../annotations.php');
|
||||
|
||||
class TestingAnnotation extends Annotation {
|
||||
public $optional = 'default';
|
||||
public $required;
|
||||
}
|
||||
|
||||
class TestOfAnnotation extends UnitTestCase {
|
||||
public function testConstructorsFillsParameters() {
|
||||
$annotation = new TestingAnnotation(array('optional' => 1, 'required' => 2), $this);
|
||||
$this->assertEqual($annotation->optional, 1);
|
||||
$this->assertEqual($annotation->required, 2);
|
||||
}
|
||||
|
||||
public function testConstructorThrowsErrorOnInvalidParameter() {
|
||||
$this->expectError("Property 'unknown' not defined for annotation 'TestingAnnotation'");
|
||||
$annotation = new TestingAnnotation(array('unknown' => 1), $this);
|
||||
}
|
||||
|
||||
public function TODO_testConstructorThrowsErrorWithoutSpecifingRequiredParameters() {
|
||||
$this->expectError("Property 'required' in annotation 'TestingAnnotation' is required");
|
||||
$annotation = new TestingAnnotation();
|
||||
}
|
||||
}
|
||||
?>
|
@ -1,71 +0,0 @@
|
||||
<?php
|
||||
require_once('simpletest/autorun.php');
|
||||
require_once(dirname(__FILE__).'/../../annotations.php');
|
||||
|
||||
/** @Target("class") */
|
||||
class ClassRestrictedAnnotation extends Annotation {}
|
||||
|
||||
/** @Target("method") */
|
||||
class MethodRestrictedAnnotation extends Annotation {}
|
||||
|
||||
/** @Target("property") */
|
||||
class PropertyRestrictedAnnotation extends Annotation {}
|
||||
|
||||
/** @Target({"class", "property"}) */
|
||||
class ClassOrPropertyRestrictedAnnotation extends Annotation {}
|
||||
|
||||
|
||||
class BadlyAnnotatedClass {
|
||||
/** @ClassRestrictedAnnotation */
|
||||
private $property;
|
||||
|
||||
/** @ClassRestrictedAnnotation */
|
||||
public function method() {}
|
||||
|
||||
/** @ClassOrPropertyRestrictedAnnotation */
|
||||
public function method2() {}
|
||||
}
|
||||
|
||||
/** @ClassRestrictedAnnotation */
|
||||
class SuccesfullyAnnotatedClass {
|
||||
/** @PropertyRestrictedAnnotation */
|
||||
private $property;
|
||||
|
||||
/** @ClassOrPropertyRestrictedAnnotation */
|
||||
private $property2;
|
||||
|
||||
/** @MethodRestrictedAnnotation */
|
||||
public function method() {}
|
||||
}
|
||||
|
||||
class TestOfConstrainedAnnotation extends UnitTestCase {
|
||||
public function testClassAnnotationThrowsErrorWhenOnMethod() {
|
||||
$this->expectError("Annotation 'ClassRestrictedAnnotation' not allowed on BadlyAnnotatedClass::method");
|
||||
$reflection = new ReflectionAnnotatedClass('BadlyAnnotatedClass');
|
||||
$method = $reflection->getMethod('method');
|
||||
}
|
||||
|
||||
public function testClassAnnotationThrowsErrorWhenOnProperty() {
|
||||
$this->expectError("Annotation 'ClassRestrictedAnnotation' not allowed on BadlyAnnotatedClass::\$property");
|
||||
$reflection = new ReflectionAnnotatedClass('BadlyAnnotatedClass');
|
||||
$method = $reflection->getProperty('property');
|
||||
}
|
||||
|
||||
public function testSingleTargetAnnotationThrowsNoErrorWhenOnRightPlace() {
|
||||
$reflection = new ReflectionAnnotatedClass('SuccesfullyAnnotatedClass');
|
||||
$method = $reflection->getMethod('method');
|
||||
$property = $reflection->getProperty('property');
|
||||
}
|
||||
|
||||
public function testMultiTargetAnnotationThrowsErrorWhenOnWrongPlace() {
|
||||
$this->expectError("Annotation 'ClassOrPropertyRestrictedAnnotation' not allowed on BadlyAnnotatedClass::method2");
|
||||
$reflection = new ReflectionAnnotatedClass('BadlyAnnotatedClass');
|
||||
$method = $reflection->getMethod('method2');
|
||||
}
|
||||
|
||||
public function testMultiTargetAnnotationThrowsNoErrorWhenOnRightPlace() {
|
||||
$reflection = new ReflectionAnnotatedClass('SuccesfullyAnnotatedClass');
|
||||
$method = $reflection->getProperty('property2');
|
||||
}
|
||||
}
|
||||
?>
|
@ -1,87 +0,0 @@
|
||||
<?php
|
||||
require_once('simpletest/autorun.php');
|
||||
require_once('simpletest/mock_objects.php');
|
||||
|
||||
require_once(dirname(__FILE__).'/../doc_comment.php');
|
||||
|
||||
Mock::generatePartial('DocComment', 'MockDocComment', array('parse'));
|
||||
|
||||
/** class doccomment */
|
||||
class SomeClass {
|
||||
/** field doccomment */
|
||||
private $field1;
|
||||
|
||||
private $field2;
|
||||
|
||||
/** method1 doccomment */
|
||||
public function method1() {
|
||||
|
||||
}
|
||||
|
||||
public function method2() {}
|
||||
/** bad one */
|
||||
}
|
||||
|
||||
class SomeOtherClass {
|
||||
/** field doccomment */
|
||||
private $field1;
|
||||
}
|
||||
|
||||
class TestOfDocComment extends UnitTestCase {
|
||||
public function setUp() {
|
||||
DocComment::clearCache();
|
||||
}
|
||||
|
||||
public function testFinderFindsClassDocBlock() {
|
||||
$reflection = new ReflectionClass('SomeClass');
|
||||
$finder = new DocComment();
|
||||
$this->assertEqual($finder->get($reflection), '/** class doccomment */');
|
||||
}
|
||||
|
||||
public function testFinderFindsFieldDocBlock() {
|
||||
$reflection = new ReflectionClass('SomeClass');
|
||||
$property = $reflection->getProperty('field1');
|
||||
$finder = new DocComment();
|
||||
$this->assertEqual($finder->get($property), '/** field doccomment */');
|
||||
$property = $reflection->getProperty('field2');
|
||||
$finder = new DocComment();
|
||||
$this->assertFalse($finder->get($property));
|
||||
}
|
||||
|
||||
public function testFinderFindsMethodDocBlock() {
|
||||
$reflection = new ReflectionClass('SomeClass');
|
||||
$method = $reflection->getMethod('method1');
|
||||
$finder = new DocComment();
|
||||
$this->assertEqual($finder->get($method), '/** method1 doccomment */');
|
||||
$method = $reflection->getMethod('method2');
|
||||
$finder = new DocComment();
|
||||
$this->assertFalse($finder->get($method));
|
||||
}
|
||||
|
||||
public function testMisplacedDocCommentDoesNotCausesDisaster() {
|
||||
$reflection = new ReflectionClass('SomeOtherClass');
|
||||
$finder = new DocComment();
|
||||
$this->assertEqual($finder->get($reflection), false);
|
||||
}
|
||||
|
||||
public function testUnanotatedClassCanHaveAnotatedField() {
|
||||
$reflection = new ReflectionClass('SomeOtherClass');
|
||||
$property = $reflection->getProperty('field1');
|
||||
$finder = new DocComment();
|
||||
$this->assertEqual($finder->get($property), '/** field doccomment */');
|
||||
}
|
||||
|
||||
public function testParserIsOnlyCalledOncePerFile() {
|
||||
$reflection = new ReflectionClass('SomeClass');
|
||||
$finder = new MockDocComment();
|
||||
$finder->expectOnce('parse');
|
||||
$this->assertEqual($finder->get($reflection), false);
|
||||
$this->assertEqual($finder->get($reflection), false);
|
||||
|
||||
$reflection = new ReflectionClass('SomeClass');
|
||||
$finder = new MockDocComment();
|
||||
$finder->expectNever('parse');
|
||||
$this->assertEqual($finder->get($reflection), false);
|
||||
}
|
||||
}
|
||||
?>
|
@ -31,8 +31,7 @@ class AnnotationReaderTest extends \Doctrine\Tests\DoctrineTestCase
|
||||
$methodAnnots = $reader->getMethodAnnotations($getField1Method);
|
||||
$this->assertEquals(1, count($methodAnnots));
|
||||
$this->assertTrue($methodAnnots[$annotName] instanceof DummyAnnotation);
|
||||
$this->assertEquals("methodHello", $methodAnnots[$annotName]->dummyValue);
|
||||
$this->assertEquals(array(array(1, 2, "three")), $methodAnnots[$annotName]->value);
|
||||
$this->assertEquals(array(1, 2, "three"), $methodAnnots[$annotName]->value);
|
||||
|
||||
$field2Prop = $class->getProperty('field2');
|
||||
$propAnnots = $reader->getPropertyAnnotations($field2Prop);
|
||||
@ -81,7 +80,7 @@ class DummyClass {
|
||||
* Gets the value of field1.
|
||||
*
|
||||
* @return mixed
|
||||
* @DummyAnnotation({1,2,"three"}, dummyValue="methodHello")
|
||||
* @DummyAnnotation({1,2,"three"})
|
||||
*/
|
||||
public function getField1() {
|
||||
}
|
||||
|
@ -28,25 +28,19 @@ class ParserTest extends \Doctrine\Tests\DoctrineTestCase
|
||||
$this->assertTrue(isset($annot->foo['key1']));
|
||||
|
||||
// Nested arrays with nested annotations
|
||||
$result = $parser->parse('@Name(foo=1, 2, 3, {1,2, {"key"=@Name}})');
|
||||
$result = $parser->parse('@Name(foo={1,2, {"key"=@Name}})');
|
||||
$annot = $result['Doctrine\Tests\Common\Annotations\Name'];
|
||||
|
||||
|
||||
$this->assertTrue($annot instanceof Name);
|
||||
$this->assertEquals(3, count($annot->value));
|
||||
$this->assertEquals(1, $annot->foo);
|
||||
$this->assertEquals(2, $annot->value[0]);
|
||||
$this->assertEquals(3, $annot->value[1]);
|
||||
$this->assertTrue(is_array($annot->value[2]));
|
||||
$this->assertNull($annot->value);
|
||||
$this->assertEquals(3, count($annot->foo));
|
||||
$this->assertEquals(1, $annot->foo[0]);
|
||||
$this->assertEquals(2, $annot->foo[1]);
|
||||
$this->assertTrue(is_array($annot->foo[2]));
|
||||
|
||||
$nestedArray = $annot->value[2];
|
||||
$this->assertEquals(3, count($nestedArray));
|
||||
$this->assertEquals(1, $nestedArray[0]);
|
||||
$this->assertEquals(2, $nestedArray[1]);
|
||||
$this->assertTrue(is_array($nestedArray[2]));
|
||||
|
||||
$nestedArray2 = $nestedArray[2];
|
||||
$this->assertTrue(isset($nestedArray2['key']));
|
||||
$this->assertTrue($nestedArray2['key'] instanceof Name);
|
||||
$nestedArray = $annot->foo[2];
|
||||
$this->assertTrue(isset($nestedArray['key']));
|
||||
$this->assertTrue($nestedArray['key'] instanceof Name);
|
||||
|
||||
// Complete docblock
|
||||
$docblock = <<<DOCBLOCK
|
||||
|
@ -40,8 +40,8 @@ class CmsUser
|
||||
/**
|
||||
* @ManyToMany(targetEntity="CmsGroup", cascade={"save"})
|
||||
* @JoinTable(name="cms_users_groups",
|
||||
joinColumns={{"name"="user_id", "referencedColumnName"="id"}},
|
||||
inverseJoinColumns={{"name"="group_id", "referencedColumnName"="id"}})
|
||||
joinColumns={@JoinColumn(name="user_id", referencedColumnName="id")},
|
||||
inverseJoinColumns={@JoinColumn(name="group_id", referencedColumnName="id")})
|
||||
*/
|
||||
public $groups;
|
||||
|
||||
|
@ -35,8 +35,8 @@ class CompanyPerson
|
||||
/**
|
||||
* @ManyToMany(targetEntity="CompanyPerson")
|
||||
* @JoinTable(name="company_persons_friends",
|
||||
joinColumns={{"name"="person_id", "referencedColumnName"="id"}},
|
||||
inverseJoinColumns={{"name"="friend_id", "referencedColumnName"="id"}})
|
||||
joinColumns={@JoinColumn(name="person_id", referencedColumnName="id")},
|
||||
inverseJoinColumns={@JoinColumn(name="friend_id", referencedColumnName="id")})
|
||||
*/
|
||||
private $friends;
|
||||
|
||||
|
@ -35,8 +35,8 @@ class ECommerceCart
|
||||
/**
|
||||
* @ManyToMany(targetEntity="ECommerceProduct", cascade={"save"})
|
||||
* @JoinTable(name="ecommerce_carts_products",
|
||||
joinColumns={{"name"="cart_id", "referencedColumnName"="id"}},
|
||||
inverseJoinColumns={{"name"="product_id", "referencedColumnName"="id"}})
|
||||
joinColumns={@JoinColumn(name="cart_id", referencedColumnName="id")},
|
||||
inverseJoinColumns={@JoinColumn(name="product_id", referencedColumnName="id")})
|
||||
*/
|
||||
private $products;
|
||||
|
||||
|
@ -40,8 +40,8 @@ class ECommerceProduct
|
||||
/**
|
||||
* @ManyToMany(targetEntity="ECommerceCategory", cascade={"save"})
|
||||
* @JoinTable(name="ecommerce_products_categories",
|
||||
joinColumns={{"name"="product_id", "referencedColumnName"="id"}},
|
||||
inverseJoinColumns={{"name"="category_id", "referencedColumnName"="id"}})
|
||||
joinColumns={@JoinColumn(name="product_id", referencedColumnName="id")},
|
||||
inverseJoinColumns={@JoinColumn(name="category_id", referencedColumnName="id")})
|
||||
*/
|
||||
private $categories;
|
||||
|
||||
@ -50,8 +50,8 @@ class ECommerceProduct
|
||||
* simplicity.
|
||||
* @ManyToMany(targetEntity="ECommerceProduct", cascade={"save"})
|
||||
* @JoinTable(name="ecommerce_products_related",
|
||||
joinColumns={{"name"="product_id", "referencedColumnName"="id"}},
|
||||
inverseJoinColumns={{"name"="related_id", "referencedColumnName"="id"}})
|
||||
joinColumns={@JoinColumn(name="product_id", referencedColumnName="id")},
|
||||
inverseJoinColumns={@JoinColumn(name="related_id", referencedColumnName="id")})
|
||||
*/
|
||||
private $related;
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user