. */ /** * IndexBy ::= "INDEX" "BY" SimpleStateFieldPathExpression * * @author Guilherme Blanco * @author Janne Vanhala * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @link http://www.phpdoctrine.org * @since 2.0 * @version $Revision$ */ class Doctrine_ORM_Query_Parser_IndexBy extends Doctrine_ORM_Query_ParserRule { protected $_AST = null; public function syntax() { // IndexBy ::= "INDEX" "BY" SimpleStateFieldPathExpression $this->_AST = $this->AST('IndexBy'); $this->_parser->match(Doctrine_ORM_Query_Token::T_INDEX); $this->_parser->match(Doctrine_ORM_Query_Token::T_BY); $this->_AST->setSimpleStateFieldPathExpression($this->parse('SimpleStateFieldPathExpression')); } public function semantical() { // Retrieving required information $parserResult = $this->_parser->getParserResult(); // Grab INDEX BY information $componentAlias = $this->_AST->getSimpleStateFieldPathExpression() ->getIdentificationVariable()->getComponentAlias(); $componentFieldName = $this->_AST->getSimpleStateFieldPathExpression() ->getSimpleStateField()->getFieldName(); // Trying to retrieve related query component try { $queryComponent = $parserResult->getQueryComponent($componentAlias); $classMetadata = $queryComponent['metadata']; } catch (Doctrine_Exception $e) { $this->_parser->semanticalError($e->getMessage()); return; } // The INDEX BY field must be either the (primary && not part of composite pk) || (unique && notnull) $columnMapping = $classMetadata->getFieldMapping($componentFieldName); if ( ! $classMetadata->isIdentifier($componentFieldName) && ! $classMetadata->isUniqueField($componentFieldName) && ! $classMetadata->isNotNull($componentFieldName) ) { $this->_parser->semanticalError( "Field '" . $componentFieldName . "' of component '" . $classMetadata->getClassName() . "' must be unique and notnull to be used as index.", $this->_parser->token ); } if ($classMetadata->isIdentifier($componentFieldName) && $classMetadata->isIdentifierComposite()) { $this->_parser->semanticalError( "Field '" . $componentFieldName . "' of component '" . $classMetadata->getClassName() . "' must be primary and not part of a composite primary key to be used as index.", $this->_parser->token ); } $queryComponent['map'] = $componentFieldName; $parserResult->setQueryComponent($componentAlias, $queryComponent); // Return AST node return $this->_AST; } }