blob: 9aaf400f7b045bd92c059c4534cf079f6c49f8b8 [file] [log] [blame]
<?php
/**
* File containing the ezcPhpGeneratorParameter class
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*
* @package PhpGenerator
* @version //autogen//
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
*/
/**
* ezcPhpGeneratorParameter holds information about a function or method parameter.
*
* @see ezcPhpGenerator::appendMethodCal()
* @see ezcPhpGenerator::appendFunctionCall()
*
* @package PhpGenerator
* @version //autogentag//
*/
class ezcPhpGeneratorParameter extends ezcBaseStruct
{
/**
* Specifies that $variable contains the name of a variable which exists in
* the generated code.
*/
const VARIABLE = 1;
/**
* Specifies that $variable contains data that should be inserted directly
* into the generated code using var_export.
*/
const VALUE = 2;
/**
* The type of the parameter. Use either VARIABLE or VALUE.
* @var int
*/
public $type;
/**
* The actual data of the variable if it is a VALUE type or the name of the variable if it is a VARIABLE type.
* @var mixed
*/
public $variable = '';
/**
* Constructs a new ezcPhpGeneratorParameter.
*
* @param string $variable Either the name of a variable or variable data.
* @param int $type Controls if $variable contains the name of a variable or actual data.
*/
public function __construct( $variable = '', $type = ezcPhpGeneratorParameter::VARIABLE )
{
$this->type = $type;
$this->variable = $variable;
}
/**
* Returns a new instance of this class with the data specified by $array.
*
* $array contains all the data members of this class in the form:
* array('member_name'=>value).
*
* __set_state makes this class exportable with var_export.
* var_export() generates code, that calls this method when it
* is parsed with PHP.
*
* @param array(string=>mixed) $array
* @return ezcPhpGeneratorParameter
*/
public static function __set_state( array $array )
{
return new ezcPhpGeneratorParameter( $array['variable'], $array['type'] );
}
}
?>