com.caucho.quercus.statement.ReturnStatement Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of quercus Show documentation

A PHP engine implemented in 100% Java

There is a newer version: 4.0.66

/*
 * Copyright (c) 1998-2012 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.quercus.statement;

import com.caucho.quercus.Location;
import com.caucho.quercus.env.Env;
import com.caucho.quercus.env.NullValue;
import com.caucho.quercus.env.Value;
import com.caucho.quercus.expr.Expr;

/**
 * Represents a return expression statement in a PHP program.
 */
public class ReturnStatement extends Statement {
  protected final Expr _expr;
  
  /**
   * Creates the echo statement.
   */
  public ReturnStatement(Expr expr)
  {
    _expr = expr;
  }
  
  /**
   * Creates the echo statement.
   */
  public ReturnStatement(Location location, Expr expr)
  {
    super(location);

    _expr = expr;
  }

  /**
   * Executes the statement, returning the expression value.
   */
  @Override
  public Value execute(Env env)
  {
    if (_expr != null)
      return _expr.evalValue(env);
    else
      return NullValue.NULL;
  }

  /**
   * Returns true if control can go past the statement.
   */
  @Override
  public int fallThrough()
  {
    return RETURN;
  }
}