Vendor update && Started using DoctrineMigrations
This commit is contained in:
@@ -0,0 +1,50 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<container xmlns="http://symfony.com/schema/dic/services"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
|
||||
|
||||
<parameters>
|
||||
<parameter key="jms_di_extra.metadata.driver.annotation_driver.class">JMS\DiExtraBundle\Metadata\Driver\AnnotationDriver</parameter>
|
||||
|
||||
<parameter key="jms_di_extra.metadata.metadata_factory.class">Metadata\MetadataFactory</parameter>
|
||||
<parameter key="jms_di_extra.metadata.cache.file_cache.class">Metadata\Cache\FileCache</parameter>
|
||||
|
||||
<parameter key="jms_di_extra.metadata.converter.class">JMS\DiExtraBundle\Metadata\MetadataConverter</parameter>
|
||||
<parameter key="jms_di_extra.controller_resolver.class">JMS\DiExtraBundle\HttpKernel\ControllerResolver</parameter>
|
||||
|
||||
<parameter key="jms_di_extra.template_listener.class">JMS\DiExtraBundle\EventListener\TemplateListener</parameter>
|
||||
<parameter key="jms_di_extra.controller_listener.class">JMS\DiExtraBundle\EventListener\ControllerListener</parameter>
|
||||
</parameters>
|
||||
|
||||
<services>
|
||||
<!-- Metadata Drivers -->
|
||||
<service id="jms_di_extra.metadata.driver.annotation_driver" class="%jms_di_extra.metadata.driver.annotation_driver.class%" public="false">
|
||||
<argument type="service" id="annotation_reader" />
|
||||
</service>
|
||||
<service id="jms_di_extra.metadata_driver" alias="jms_di_extra.metadata.driver.annotation_driver" public="false" />
|
||||
|
||||
<!-- Metadata Factory -->
|
||||
<service id="jms_di_extra.metadata.cache.file_cache" class="%jms_di_extra.metadata.cache.file_cache.class%" public="false">
|
||||
<argument /><!-- Directory -->
|
||||
</service>
|
||||
<service id="jms_di_extra.metadata.cache" alias="jms_di_extra.metadata.cache.file_cache" public="false" />
|
||||
<service id="jms_di_extra.metadata.metadata_factory" class="%jms_di_extra.metadata.metadata_factory.class%">
|
||||
<argument type="service" id="jms_di_extra.metadata_driver" />
|
||||
<argument>Metadata\ClassHierarchyMetadata</argument>
|
||||
<argument>%kernel.debug%</argument>
|
||||
<call method="setCache">
|
||||
<argument type="service" id="jms_di_extra.metadata.cache" on-invalid="ignore" />
|
||||
</call>
|
||||
</service>
|
||||
|
||||
<service id="jms_di_extra.metadata.converter" class="%jms_di_extra.metadata.converter.class%" />
|
||||
|
||||
<service id="jms_di_extra.controller_resolver" class="%jms_di_extra.controller_resolver.class%" public="false">
|
||||
<tag name="monolog.logger" channel="request" />
|
||||
<argument type="service" id="service_container" />
|
||||
<argument type="service" id="controller_name_converter" />
|
||||
<argument type="service" id="logger" on-invalid="ignore" />
|
||||
</service>
|
||||
</services>
|
||||
</container>
|
@@ -0,0 +1,290 @@
|
||||
========
|
||||
Overview
|
||||
========
|
||||
|
||||
This bundle allows you to configure dependency injection using annotations.
|
||||
|
||||
Installation
|
||||
------------
|
||||
Add the following to your ``deps`` file::
|
||||
|
||||
[JMSDiExtraBundle]
|
||||
git=https://github.com/schmittjoh/JMSDiExtraBundle.git
|
||||
target=/bundles/JMS/DiExtraBundle
|
||||
|
||||
; Dependencies:
|
||||
;--------------
|
||||
[metadata]
|
||||
git=https://github.com/schmittjoh/metadata.git
|
||||
version=1.1.0 ; <- make sure to get 1.1, not 1.0
|
||||
|
||||
Then register the bundle with your kernel::
|
||||
|
||||
// in AppKernel::registerBundles()
|
||||
$bundles = array(
|
||||
// ...
|
||||
new JMS\DiExtraBundle\JMSDiExtraBundle($this),
|
||||
// ...
|
||||
);
|
||||
|
||||
In addition, this bundle also requires the JMSAopBundle. See its documentation for
|
||||
installation instructions::
|
||||
|
||||
https://github.com/schmittjoh/JMSAopBundle/blob/master/Resources/doc/index.rst
|
||||
|
||||
|
||||
Make sure that you also register the namespaces with the autoloader::
|
||||
|
||||
// app/autoload.php
|
||||
$loader->registerNamespaces(array(
|
||||
// ...
|
||||
'JMS' => __DIR__.'/../vendor/bundles',
|
||||
'Metadata' => __DIR__.'/../vendor/metadata/src',
|
||||
// ...
|
||||
));
|
||||
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
For optimal development performance (in production there is no difference either way),
|
||||
it is recommended to explicitly configure the directories which should be scanned for
|
||||
service classes (by default no directory is scanned)::
|
||||
|
||||
jms_di_extra:
|
||||
locations:
|
||||
all_bundles: false
|
||||
bundles: [FooBundle, AcmeBlogBundle, etc.]
|
||||
directories: [%kernel.root_dir%/../src, some/other/dir]
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Non-Controller Classes
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Non-controller classes are configured, and managed by Symfony's DIC just like any
|
||||
other service that you configure using YML, XML, or PHP. The only difference is
|
||||
that you can do it via annotations which is a lot more convenient.
|
||||
|
||||
You can use these annotations on services (for examples, see below):
|
||||
@Service, @Inject, @InjectParams, @Observe, @Tag
|
||||
|
||||
Note that you cannot use the @Inject annotation on private, or protected properties.
|
||||
Likewise, the @InjectParams annotation does not work on protected, or private methods.
|
||||
|
||||
|
||||
Controllers
|
||||
~~~~~~~~~~~
|
||||
|
||||
Controllers are a special type of class which is also treated specially by this
|
||||
bundle. The most notable difference is that you do not need to define these
|
||||
classes as services. Yes, no services, but don't worry you can still use all of
|
||||
the DIC's features, and even some more.
|
||||
|
||||
- Constructor/Setter Injection::
|
||||
|
||||
<?php
|
||||
|
||||
use JMS\DiExtraBundle\Annotation as DI;
|
||||
|
||||
class Controller
|
||||
{
|
||||
private $em;
|
||||
private $session;
|
||||
|
||||
/**
|
||||
* @DI\InjectParams({
|
||||
* "em" = @DI\Inject("doctrine.orm.entity_manager"),
|
||||
* "session" = @DI\Inject("session")
|
||||
* })
|
||||
*/
|
||||
public function __construct($em, $session)
|
||||
{
|
||||
$this->em = $em;
|
||||
$this->session = $session;
|
||||
}
|
||||
// ... some actions
|
||||
}
|
||||
|
||||
**Note:** Constructor Injection is not possible when a parent definition
|
||||
also defines a constructor which is configured for injection.
|
||||
|
||||
- Property Injection::
|
||||
|
||||
<?php
|
||||
|
||||
use JMS\DiExtraBundle\Annotation as DI;
|
||||
|
||||
class Controller
|
||||
{
|
||||
/** @DI\Inject("doctrine.orm.entity_manager")
|
||||
private $em;
|
||||
|
||||
/** @DI\Inject("session")
|
||||
private $session;
|
||||
}
|
||||
|
||||
- Method/Getter Injection::
|
||||
|
||||
<?php
|
||||
|
||||
use JMS\DiExtraBundle\Annotation as DI;
|
||||
|
||||
class Controller
|
||||
{
|
||||
public function myAction()
|
||||
{
|
||||
// ...
|
||||
if ($condition) {
|
||||
$mailer = $this->getMailer();
|
||||
}
|
||||
}
|
||||
|
||||
/** @DI\LookupMethod("mailer") */
|
||||
protected function getMailer() { /* empty body here */ }
|
||||
}
|
||||
|
||||
You can use this type of injection if you have a dependency that you do not
|
||||
always need in the controller, and which is costly to initialize, like the
|
||||
mailer in the example above.
|
||||
|
||||
|
||||
Annotations
|
||||
-----------
|
||||
|
||||
@Inject
|
||||
~~~~~~~~~
|
||||
This marks a property, or parameter for injection::
|
||||
|
||||
use JMS\DiExtraBundle\Annotation\Inject;
|
||||
|
||||
class Controller
|
||||
{
|
||||
/**
|
||||
* @Inject("security.context", required = false)
|
||||
*/
|
||||
private $securityContext;
|
||||
|
||||
/**
|
||||
* @Inject("%kernel.cache_dir%")
|
||||
*/
|
||||
private $cacheDir;
|
||||
|
||||
/**
|
||||
* @Inject
|
||||
*/
|
||||
private $session;
|
||||
}
|
||||
|
||||
If you do not specify the service explicitly, we will try to guess it based on the name
|
||||
of the property or the parameter.
|
||||
|
||||
@InjectParams
|
||||
~~~~~~~~~~~~~~~
|
||||
This marks the parameters of a method for injection::
|
||||
|
||||
use JMS\DiExtraBundle\Annotation\Inject;
|
||||
use JMS\DiExtraBundle\Annotation\InjectParams;
|
||||
use JMS\DiExtraBundle\Annotation\Service;
|
||||
|
||||
/**
|
||||
* @Service
|
||||
*/
|
||||
class Listener
|
||||
{
|
||||
/**
|
||||
* @InjectParams({
|
||||
* "em" = @Inject("doctrine.entity_manager")
|
||||
* })
|
||||
*/
|
||||
public function __construct(EntityManager $em, Session $session)
|
||||
{
|
||||
// ...
|
||||
}
|
||||
}
|
||||
|
||||
If you don't define all parameters in the param map, we will try to guess which services
|
||||
should be injected into the remaining parameters based on their name.
|
||||
|
||||
@Service
|
||||
~~~~~~~~
|
||||
Marks a class as service::
|
||||
|
||||
use JMS\DiExtraBundle\Annotation\Service;
|
||||
|
||||
/**
|
||||
* @Service("some.service.id", parent="another.service.id", public=false)
|
||||
*/
|
||||
class Listener
|
||||
{
|
||||
}
|
||||
|
||||
If you do not explicitly define a service id, then we will generated a sensible default
|
||||
based on the fully qualified class name for you.
|
||||
|
||||
@Tag
|
||||
~~~~
|
||||
Adds a tag to the service::
|
||||
|
||||
use JMS\DiExtraBundle\Annotation\Service;
|
||||
use JMS\DiExtraBundle\Annotation\Tag;
|
||||
|
||||
/**
|
||||
* @Service
|
||||
* @Tag("doctrine.event_listener", attributes = {"event" = "postGenerateSchema", lazy=true})
|
||||
*/
|
||||
class Listener
|
||||
{
|
||||
// ...
|
||||
}
|
||||
|
||||
@Observe
|
||||
~~~~~~~~
|
||||
Automatically registers a method as listener to a certain event::
|
||||
|
||||
use JMS\DiExtraBundle\Annotation\Observe;
|
||||
use JMS\DiExtraBundle\Annotation\Service;
|
||||
|
||||
/**
|
||||
* @Service
|
||||
*/
|
||||
class RequestListener
|
||||
{
|
||||
/**
|
||||
* @Observe("kernel.request", priority = 255)
|
||||
*/
|
||||
public function onKernelRequest()
|
||||
{
|
||||
// ...
|
||||
}
|
||||
}
|
||||
|
||||
@Validator
|
||||
~~~~~~~~~~
|
||||
Automatically registers the given class as constraint validator for the Validator component::
|
||||
|
||||
use JMS\DiExtraBundle\Annotation\Validator;
|
||||
use Symfony\Component\Validator\Constraint;
|
||||
use Symfony\Component\Validator\ConstraintValidator;
|
||||
|
||||
/**
|
||||
* @Validator("my_alias")
|
||||
*/
|
||||
class MyValidator extends ConstraintValidator
|
||||
{
|
||||
// ...
|
||||
}
|
||||
|
||||
class MyConstraint extends Constraint
|
||||
{
|
||||
// ...
|
||||
public function validatedBy()
|
||||
{
|
||||
return 'my_alias';
|
||||
}
|
||||
}
|
||||
|
||||
The @Validator annotation also implies the @Service annotation if you do not specify it explicitly.
|
||||
The alias which is passed to the @Validator annotation must match the string that is returned from
|
||||
the ``validatedBy`` method of your constraint.
|
||||
|
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
Reference in New Issue
Block a user