|
From: <m_p...@us...> - 2014-09-26 16:10:05
|
Revision: 236
http://sourceforge.net/p/beeframework/code/236
Author: m_plomer
Date: 2014-09-26 16:10:02 +0000 (Fri, 26 Sep 2014)
Log Message:
-----------
Context/Xml: top level beans now have an ID autogenerated if none defined
Modified Paths:
--------------
trunk/framework/Bee/Context/Xml/XmlNamespace/AbstractBeanDefinitionParser.php
Modified: trunk/framework/Bee/Context/Xml/XmlNamespace/AbstractBeanDefinitionParser.php
===================================================================
--- trunk/framework/Bee/Context/Xml/XmlNamespace/AbstractBeanDefinitionParser.php 2014-09-26 14:56:42 UTC (rev 235)
+++ trunk/framework/Bee/Context/Xml/XmlNamespace/AbstractBeanDefinitionParser.php 2014-09-26 16:10:02 UTC (rev 236)
@@ -1,5 +1,6 @@
<?php
namespace Bee\Context\Xml\XmlNamespace;
+
/*
* Copyright 2008-2014 the original author or authors.
*
@@ -31,151 +32,152 @@
* Date: Feb 17, 2010
* Time: 11:36:56 PM
*/
-
abstract class AbstractBeanDefinitionParser implements IBeanDefinitionParser, IConstants {
- /** Constant for the id attribute */
- const ID_ATTRIBUTE = 'id';
+ /** Constant for the id attribute */
+ const ID_ATTRIBUTE = 'id';
- public final function parse(DOMElement $element, ParserContext $parserContext) {
- $definition = $this->parseInternal($element, $parserContext);
- if (!$parserContext->isNested()) {
- try {
- $aliases = $this->shouldParseNameAliases() ? Utils::parseNameAttribute($element) : null;
+ public final function parse(DOMElement $element, ParserContext $parserContext) {
+ $definition = $this->parseInternal($element, $parserContext);
+ if (!$parserContext->isNested()) {
+ try {
+ $aliases = $this->shouldParseNameAliases() ? Utils::parseNameAttribute($element) : null;
- $id = $this->resolveId($element, $definition, $parserContext);
- if (!Bee_Utils_Strings::hasText($id) && count($aliases) > 0) {
- $id = Utils::getIdFromAliases($aliases, $parserContext->getReaderContext(), $element);
- }
- if (!Bee_Utils_Strings::hasText($id)) {
- $parserContext->getReaderContext()->error(
- "Id is required for element '" . $element->localName . "' when used as a top-level tag", $element);
- }
- $holder = new BeanDefinitionHolder($definition, $id, $aliases);
- $this->registerBeanDefinition($holder, $parserContext->getRegistry());
+ $id = $this->resolveId($element, $definition, $parserContext);
+ if (!Bee_Utils_Strings::hasText($id) && count($aliases) > 0) {
+ $id = Utils::getIdFromAliases($aliases, $parserContext->getReaderContext(), $element);
+ }
+ if (!Bee_Utils_Strings::hasText($id)) {
+// $parserContext->getReaderContext()->error(
+// "Id is required for element '" . $element->localName . "' when used as a top-level tag", $element);
+ // force-generate an ID so top level elements that are referenced e.g. via decorators can still be
+ // defined at the top level and do not need to have an ID manually defined
+ $id = BeanDefinitionReaderUtils::generateBeanName($definition, $parserContext->getRegistry(), true);
+ }
+ $holder = new BeanDefinitionHolder($definition, $id, $aliases);
+ $this->registerBeanDefinition($holder, $parserContext->getRegistry());
// if ($this->shouldFireEvents()) {
// $componentDefinition = new BeanComponentDefinition(holder);
// postProcessComponentDefinition(componentDefinition);
// parserContext.registerComponent(componentDefinition);
// }
- } catch (Bee_Context_BeanDefinitionStoreException $ex) {
- $parserContext->getReaderContext()->error($ex->getMessage(), $element);
- return null;
- }
- }
- return $definition;
- }
+ } catch (Bee_Context_BeanDefinitionStoreException $ex) {
+ $parserContext->getReaderContext()->error($ex->getMessage(), $element);
+ return null;
+ }
+ }
+ return $definition;
+ }
- /**
- * Resolve the ID for the supplied {@link BeanDefinition}.
- * <p>When using {@link #shouldGenerateId generation}, a name is generated automatically.
- * Otherwise, the ID is extracted from the "id" attribute, potentially with a
- * {@link #shouldGenerateIdAsFallback() fallback} to a generated id.
- * @param DOMElement $element the element that the bean definition has been built from
- * @param Bee_Context_Config_BeanDefinition_Abstract $definition the bean definition to be registered
- * @param ParserContext $parserContext the object encapsulating the current state of the parsing process;
- * provides access to a {@link org.springframework.beans.factory.support.BeanDefinitionRegistry}
- * @return string the resolved id
- * @throws Bee_Context_BeanDefinitionStoreException if no unique name could be generated
- * for the given bean definition
- */
- protected function resolveId(DOMElement $element, Bee_Context_Config_BeanDefinition_Abstract $definition, ParserContext $parserContext) {
+ /**
+ * Resolve the ID for the supplied {@link BeanDefinition}.
+ * <p>When using {@link #shouldGenerateId generation}, a name is generated automatically.
+ * Otherwise, the ID is extracted from the "id" attribute, potentially with a
+ * {@link #shouldGenerateIdAsFallback() fallback} to a generated id.
+ * @param DOMElement $element the element that the bean definition has been built from
+ * @param Bee_Context_Config_BeanDefinition_Abstract $definition the bean definition to be registered
+ * @param ParserContext $parserContext the object encapsulating the current state of the parsing process;
+ * provides access to a {@link org.springframework.beans.factory.support.BeanDefinitionRegistry}
+ * @return string the resolved id
+ * @throws Bee_Context_BeanDefinitionStoreException if no unique name could be generated
+ * for the given bean definition
+ */
+ protected function resolveId(DOMElement $element, Bee_Context_Config_BeanDefinition_Abstract $definition, ParserContext $parserContext) {
- if ($this->shouldGenerateId()) {
- return BeanDefinitionReaderUtils::generateBeanName($definition, $parserContext->getRegistry(), false);
- }
- else {
- $id = $element->getAttribute(self::ID_ATTRIBUTE);
- if (!Bee_Utils_Strings::hasText($id) && $this->shouldGenerateIdAsFallback()) {
- $id = BeanDefinitionReaderUtils::generateBeanName($definition, $parserContext->getRegistry(), false);
- }
- return $id;
- }
- }
+ if ($this->shouldGenerateId()) {
+ return BeanDefinitionReaderUtils::generateBeanName($definition, $parserContext->getRegistry(), false);
+ } else {
+ $id = $element->getAttribute(self::ID_ATTRIBUTE);
+ if (!Bee_Utils_Strings::hasText($id) && $this->shouldGenerateIdAsFallback()) {
+ $id = BeanDefinitionReaderUtils::generateBeanName($definition, $parserContext->getRegistry(), false);
+ }
+ return $id;
+ }
+ }
- /**
- * Register the supplied {@link BeanDefinitionHolder bean} with the supplied
- * {@link BeanDefinitionRegistry registry}.
- * <p>Subclasses can override this method to control whether or not the supplied
- * {@link BeanDefinitionHolder bean} is actually even registered, or to
- * register even more beans.
- * <p>The default implementation registers the supplied {@link BeanDefinitionHolder bean}
- * with the supplied {@link BeanDefinitionRegistry registry} only if the <code>isNested</code>
- * parameter is <code>false</code>, because one typically does not want inner beans
- * to be registered as top level beans.
- * @param BeanDefinitionHolder $definition the bean definition to be registered
- * @param IBeanDefinitionRegistry $registry the registry that the bean is to be registered with
- * @see BeanDefinitionReaderUtils#registerBeanDefinition(BeanDefinitionHolder, BeanDefinitionRegistry)
- */
- protected function registerBeanDefinition(BeanDefinitionHolder $definition, IBeanDefinitionRegistry $registry) {
+ /**
+ * Register the supplied {@link BeanDefinitionHolder bean} with the supplied
+ * {@link BeanDefinitionRegistry registry}.
+ * <p>Subclasses can override this method to control whether or not the supplied
+ * {@link BeanDefinitionHolder bean} is actually even registered, or to
+ * register even more beans.
+ * <p>The default implementation registers the supplied {@link BeanDefinitionHolder bean}
+ * with the supplied {@link BeanDefinitionRegistry registry} only if the <code>isNested</code>
+ * parameter is <code>false</code>, because one typically does not want inner beans
+ * to be registered as top level beans.
+ * @param BeanDefinitionHolder $definition the bean definition to be registered
+ * @param IBeanDefinitionRegistry $registry the registry that the bean is to be registered with
+ * @see BeanDefinitionReaderUtils#registerBeanDefinition(BeanDefinitionHolder, BeanDefinitionRegistry)
+ */
+ protected function registerBeanDefinition(BeanDefinitionHolder $definition, IBeanDefinitionRegistry $registry) {
BeanDefinitionReaderUtils::registerBeanDefinition($definition, $registry);
- }
+ }
- /**
- * Central template method to actually parse the supplied {@link Element}
- * into one or more {@link BeanDefinition BeanDefinitions}.
- * @param DOMElement $element the element that is to be parsed into one or more {@link BeanDefinition BeanDefinitions}
- * @param ParserContext $parserContext the object encapsulating the current state of the parsing process;
- * provides access to a {@link org.springframework.beans.factory.support.BeanDefinitionRegistry}
- * @return Bee_Context_Config_BeanDefinition_Abstract the primary {@link BeanDefinition} resulting from the parsing of the supplied {@link Element}
- * @see #parse(org.w3c.dom.Element, ParserContext)
- * @see #postProcessComponentDefinition(org.springframework.beans.factory.parsing.BeanComponentDefinition)
- */
- protected abstract function parseInternal(DOMElement $element, ParserContext $parserContext);
+ /**
+ * Central template method to actually parse the supplied {@link Element}
+ * into one or more {@link BeanDefinition BeanDefinitions}.
+ * @param DOMElement $element the element that is to be parsed into one or more {@link BeanDefinition BeanDefinitions}
+ * @param ParserContext $parserContext the object encapsulating the current state of the parsing process;
+ * provides access to a {@link org.springframework.beans.factory.support.BeanDefinitionRegistry}
+ * @return Bee_Context_Config_BeanDefinition_Abstract the primary {@link BeanDefinition} resulting from the parsing of the supplied {@link Element}
+ * @see #parse(org.w3c.dom.Element, ParserContext)
+ * @see #postProcessComponentDefinition(org.springframework.beans.factory.parsing.BeanComponentDefinition)
+ */
+ protected abstract function parseInternal(DOMElement $element, ParserContext $parserContext);
- /**
- * Should an ID be generated instead of read from the passed in {@link Element}?
- * <p>Disabled by default; subclasses can override this to enable ID generation.
- * Note that this flag is about <i>always</i> generating an ID; the parser
- * won't even check for an "id" attribute in this case.
- * @return boolean whether the parser should always generate an id
- */
- protected function shouldGenerateId() {
- return false;
- }
+ /**
+ * Should an ID be generated instead of read from the passed in {@link Element}?
+ * <p>Disabled by default; subclasses can override this to enable ID generation.
+ * Note that this flag is about <i>always</i> generating an ID; the parser
+ * won't even check for an "id" attribute in this case.
+ * @return boolean whether the parser should always generate an id
+ */
+ protected function shouldGenerateId() {
+ return false;
+ }
- /**
- * Should an ID be generated instead if the passed in {@link Element} does not
- * specify an "id" attribute explicitly?
- * <p>Disabled by default; subclasses can override this to enable ID generation
- * as fallback: The parser will first check for an "id" attribute in this case,
- * only falling back to a generated ID if no value was specified.
- * @return boolean whether the parser should generate an id if no id was specified
- */
- protected function shouldGenerateIdAsFallback() {
- return false;
- }
+ /**
+ * Should an ID be generated instead if the passed in {@link Element} does not
+ * specify an "id" attribute explicitly?
+ * <p>Disabled by default; subclasses can override this to enable ID generation
+ * as fallback: The parser will first check for an "id" attribute in this case,
+ * only falling back to a generated ID if no value was specified.
+ * @return boolean whether the parser should generate an id if no id was specified
+ */
+ protected function shouldGenerateIdAsFallback() {
+ return false;
+ }
- protected function shouldParseNameAliases() {
- return true;
- }
+ protected function shouldParseNameAliases() {
+ return true;
+ }
- /**
- * Controls whether this parser is supposed to fire a
- * {@link org.springframework.beans.factory.parsing.BeanComponentDefinition}
- * event after parsing the bean definition.
- * <p>This implementation returns <code>true</code> by default; that is,
- * an event will be fired when a bean definition has been completely parsed.
- * Override this to return <code>false</code> in order to suppress the event.
- * @return boolean <code>true</code> in order to fire a component registration event
- * after parsing the bean definition; <code>false</code> to suppress the event
- * @see #postProcessComponentDefinition
- * @see org.springframework.beans.factory.parsing.ReaderContext#fireComponentRegistered
- */
+ /**
+ * Controls whether this parser is supposed to fire a
+ * {@link org.springframework.beans.factory.parsing.BeanComponentDefinition}
+ * event after parsing the bean definition.
+ * <p>This implementation returns <code>true</code> by default; that is,
+ * an event will be fired when a bean definition has been completely parsed.
+ * Override this to return <code>false</code> in order to suppress the event.
+ * @return boolean <code>true</code> in order to fire a component registration event
+ * after parsing the bean definition; <code>false</code> to suppress the event
+ * @see #postProcessComponentDefinition
+ * @see org.springframework.beans.factory.parsing.ReaderContext#fireComponentRegistered
+ */
// protected function shouldFireEvents() {
// return true;
// }
- /**
- * Hook method called after the primary parsing of a
- * {@link BeanComponentDefinition} but before the
- * {@link BeanComponentDefinition} has been registered with a
- * {@link org.springframework.beans.factory.support.BeanDefinitionRegistry}.
- * <p>Derived classes can override this method to supply any custom logic that
- * is to be executed after all the parsing is finished.
- * <p>The default implementation is a no-op.
- * @param mixed $componentDefinition the {@link BeanComponentDefinition} that is to be processed
- */
+ /**
+ * Hook method called after the primary parsing of a
+ * {@link BeanComponentDefinition} but before the
+ * {@link BeanComponentDefinition} has been registered with a
+ * {@link org.springframework.beans.factory.support.BeanDefinitionRegistry}.
+ * <p>Derived classes can override this method to supply any custom logic that
+ * is to be executed after all the parsing is finished.
+ * <p>The default implementation is a no-op.
+ * @param mixed $componentDefinition the {@link BeanComponentDefinition} that is to be processed
+ */
// protected function postProcessComponentDefinition(BeanComponentDefinition componentDefinition) {
// }
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
