CakePHPCodeUtils.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2015 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2015 Sun Microsystems, Inc.
 */
package org.netbeans.modules.php.cake3.utils;

import java.util.List;
import org.netbeans.modules.php.editor.parser.astnodes.ArrayCreation;
import org.netbeans.modules.php.editor.parser.astnodes.ArrayElement;
import org.netbeans.modules.php.editor.parser.astnodes.Expression;
import org.netbeans.modules.php.editor.parser.astnodes.FunctionInvocation;
import org.netbeans.modules.php.editor.parser.astnodes.Scalar;
import org.netbeans.modules.php.editor.parser.astnodes.SingleFieldDeclaration;
import org.openide.util.Pair;

/**
 *
 * @author junichi11
 */
public final class CakePHPCodeUtils {

    private CakePHPCodeUtils() {
    }

    /**
     * Get string name from Expression
     *
     * @param e Expression
     * @return string name | empty string
     */
    public static String getStringValue(Expression e) {
        String name = ""; // NOI18N
        if (e instanceof Scalar) {
            Scalar s = (Scalar) e;
            if (s.getScalarType() == Scalar.Type.STRING) {
                name = s.getStringValue();
            }
            if (name.length() > 2) {
                name = name.substring(1, name.length() - 1);
            } else {
                name = ""; // NOI18N
            }
        }
        return name;
    }

    /**
     * Get entity. Return a class Expression if "className" exists in the array.
     *
     * @param ac ArrayCreation
     * @return entity | null
     */
    public static Expression getEntity(ArrayCreation ac) {
        if (ac == null) {
            return null;
        }
        for (ArrayElement element : ac.getElements()) {
            Expression key = element.getKey();
            String keyName = getStringValue(key);
            if (keyName.equals("className")) { // NOI18N
                return element.getValue();
            }
        }
        return null;
    }

    /**
     * Get ArrayCreation
     *
     * @param field
     * @return
     */
    public static ArrayCreation getArrayCreation(SingleFieldDeclaration field) {
        ArrayCreation arrayCreation = null;
        Expression value = field.getValue();
        if (value instanceof ArrayCreation) {
            arrayCreation = (ArrayCreation) value;
        }
        return arrayCreation;
    }

    /**
     * Get pair of alias and entity name from method parameters. If "className"
     * element doesn't exist in the parameter's array, entity name will be empty
     * string.
     *
     * @param parameters method parameters
     * @return Pair of alias and entity name
     */
    public static Pair<String, String> getAliasAndEntityName(List<Expression> parameters) {
        String aliasName = ""; // NOI18N
        String entityName = ""; // NOI18N
        for (Expression parameter : parameters) {
            if (parameter instanceof Scalar) {
                aliasName = getStringValue(parameter);
            }
            if (parameter instanceof ArrayCreation) {
                Expression entity = getEntity((ArrayCreation) parameter);
                entityName = getStringValue(entity);
            }
        }
        return Pair.of(aliasName, entityName);
    }

    /**
     * Get the first parameter string.
     *
     * @param method
     * @return the first parameter if it is string, otherwise empty string
     */
    public static String getFirstParameter(FunctionInvocation method) {
        List<Expression> parameters = method.getParameters();
        String firstParameter = ""; // NOI18N
        for (Expression parameter : parameters) {
            if (parameter instanceof Scalar) {
                firstParameter = CakePHPCodeUtils.getStringValue(parameter);
            }
            // only the first parameter
            break;
        }
        return firstParameter;
    }

}