Sobrecarga de função PHP

195

Vindo do background C ++;)
Como sobrecarregar funções PHP?

Uma definição de função se houver algum argumento e outra se não houver argumentos? É possível em PHP? Ou devo usar if else para verificar se existem parâmetros passados ​​de $ _GET e POST? e relacioná-los?

Vamsi Krishna B
fonte
1
Você pode sobrecarregar apenas métodos de classe, mas não funções. Veja php.net/manual/en/language.oop5.overloading.php
Spechal
1
Você pode criar uma função que verifique explicitamente o número de argumentos e execute outra função, a partir de um conjunto predefinido deles. Não importa como é melhor redesenhar sua solução ou usar classes que implementam sua interface
kolypto
2
Como o php.net/manual/en/language.oop5.overloading.php diz, a definição de sobrecarga do PHP é diferente da linguagem OOP típica. Eles só se referem a métodos mágicos que permitem a dinâmica roteamento de propriedades e funções com base em X.
Edwin Daniels
Para futuros leitores: O que @Spechal está se referindo é um significado diferente para a palavra do overloadingque está sendo solicitado na pergunta. (Veja a resposta aceite para mais detalhes.)
ToolmakerSteve
2
Alguma coisa mudou desde o PHP 7? : o
nawfal 29/01

Respostas:

218

Você não pode sobrecarregar as funções PHP. As assinaturas de função são baseadas apenas em seus nomes e não incluem listas de argumentos; portanto, você não pode ter duas funções com o mesmo nome. A sobrecarga do método de classe é diferente no PHP e em muitas outras linguagens. O PHP usa a mesma palavra, mas descreve um padrão diferente.

Você pode, no entanto, declarar uma função variável que recebe um número variável de argumentos. Você usaria func_num_args()e func_get_arg()obteria a aprovação dos argumentos e os usaria normalmente.

Por exemplo:

function myFunc() {
    for ($i = 0; $i < func_num_args(); $i++) {
        printf("Argument %d: %s\n", $i, func_get_arg($i));
    }
}

/*
Argument 0: a
Argument 1: 2
Argument 2: 3.5
*/
myFunc('a', 2, 3.5);
BoltClock
fonte
8
Talvez eu esteja desenvolvendo muito o C ++, mas sugiro uma dica de que isso está sendo feito nos parâmetros de função como myFunc(/*...*/).
doug65536
4
@ doug65536, PHP 5.6+ suportará esse "..." como um token de sintaxe , para nosso grande alívio. ;)
Sz.
Ou veja a resposta de Adil , que está mais próxima da sobrecarga do C ++ - o mais próximo possível - em uma linguagem pouco tipada como php. É ainda mais apropriado no php 7, pois você pode fornecer dicas de tipo para parâmetros, se eles forem do mesmo tipo em todas as suas sobrecargas.
Página
78

O PHP não suporta a sobrecarga de métodos tradicionais; no entanto, uma maneira de conseguir o que deseja é fazer uso do __callmétodo mágico:

class MyClass {
    public function __call($name, $args) {

        switch ($name) {
            case 'funcOne':
                switch (count($args)) {
                    case 1:
                        return call_user_func_array(array($this, 'funcOneWithOneArg'), $args);
                    case 3:
                        return call_user_func_array(array($this, 'funcOneWithThreeArgs'), $args);
                 }
            case 'anotherFunc':
                switch (count($args)) {
                    case 0:
                        return $this->anotherFuncWithNoArgs();
                    case 5:
                        return call_user_func_array(array($this, 'anotherFuncWithMoreArgs'), $args);
                }
        }
    }

    protected function funcOneWithOneArg($a) {

    }

    protected function funcOneWithThreeArgs($a, $b, $c) {

    }

    protected function anotherFuncWithNoArgs() {

    }

    protected function anotherFuncWithMoreArgs($a, $b, $c, $d, $e) {

    }

}
Stephen
fonte
20
Eu nunca vi esse uso __call()antes. Muito criativo (se um pouco detalhado)! +1
BoltClock
Uso realmente admirável de __call ()
Abhishek Gupta 17/03
2
Na verdade, não posso concordar com isso e deve exercer retraimento com essa sugestão. Por um lado, esse uso de __call () é um anti-padrão. Em segundo lugar, é possível sobrecarregar o PHP para métodos de classe que tenham a visibilidade correta. Você não pode, no entanto - sobrecarregar funções plain-jane.
Oddman 14/05
1
Você pode explicar por que você acha que usar __call () é um anti-padrão? Método PHP sobrecarga não é o que o OP está procurando - eles querem que a capacidade de ter múltiplas assinaturas de método com o mesmo nome mas diferentes de entrada / saída: en.wikipedia.org/wiki/Function_overloading
Stephen
20
Não há necessidade de usar __call (). Em vez disso, declare um método com o nome desejado, sem nenhum parâmetro listado, e use func_get_args () nesse método para enviar para a implementação privada apropriada.
FantasticJamieBurns
30

Para sobrecarregar uma função, basta passar o parâmetro como nulo por padrão,

class ParentClass
{
   function mymethod($arg1 = null, $arg2 = null, $arg3 = null)  
     {  
        if( $arg1 == null && $arg2 == null && $arg3 == null ){ 
           return 'function has got zero parameters <br />';
        }
        else
        {
           $str = '';
           if( $arg1 != null ) 
              $str .= "arg1 = ".$arg1." <br />";

           if( $arg2 != null ) 
              $str .= "arg2 = ".$arg2." <br />";

           if( $arg3 != null ) 
              $str .= "arg3 = ".$arg3." <br />";

           return $str;
         }
     }
}

// and call it in order given below ...

 $obj = new ParentClass;

 echo '<br />$obj->mymethod()<br />';
 echo $obj->mymethod();

 echo '<br />$obj->mymethod(null,"test") <br />';
 echo $obj->mymethod(null,'test');

 echo '<br /> $obj->mymethod("test","test","test")<br />';
 echo $obj->mymethod('test','test','test');
Adil Abbasi
fonte
4
Não considero parâmetro padrão como sobrecarga de função. a sobrecarga da função [ou método] tem mais a ver com a chamada de uma implementação diferente com base no tipo de argumento passado. O uso de parâmetros padrão apenas permite chamar a mesma implementação com a conveniência de menos parâmetros.
Escalável
1
Sim, você também pode manipulá-lo com base no tipo, mas como se você conhecesse uma linguagem de tipo vagamente digitada pelo php e lidar com ela, é necessário resolver isso.
Adil Abbasi
1
Prefiro essa resposta à aceita, pois torna explícito qual deve ser o número mínimo e máximo de parâmetros. (Não forneça um valor padrão para os parâmetros que são necessários.) @ Escalável - Concordo com Adil que, como o php é vagamente digitado, isso é efetivamente tudo o que pode significar no php para overloaduma função - no entanto, você faz uma observação útil que os leitores devem estar cientes.
Home
11

Pode ser um hack para alguns, mas aprendi dessa maneira como o Cakephp faz algumas funções e o adaptei porque gosto da flexibilidade que ele cria

A idéia é que você tenha diferentes tipos de argumentos, matrizes, objetos, etc., em seguida, detecte o que foi passado e vá a partir daí

function($arg1, $lastname) {
    if(is_array($arg1)){
        $lastname = $arg1['lastname'];
        $firstname = $arg1['firstname'];
    } else {
        $firstname = $arg1;
    }
    ...
}
SeanDowney
fonte
1
Nah, eu não vejo isso como hackish, o PHP faz isso para muitas de suas funções internas.
BoltClock
Como o php é vagamente digitado, é exatamente assim que se deve lidar com essa situação. Seu "hackishness necessário" em php.
Home
11
<?php   
/*******************************
 * author  : [email protected] 
 * version : 3.8
 * create on : 2017-09-17
 * updated on : 2020-01-12
 *****************************/

#> 1. Include Overloadable class

class Overloadable
{
    static function call($obj, $method, $params=null) {
        $class = get_class($obj);
        // Get real method name
        $suffix_method_name = $method.self::getMethodSuffix($method, $params);

        if (method_exists($obj, $suffix_method_name)) {
            // Call method
            return call_user_func_array(array($obj, $suffix_method_name), $params);
        }else{
            throw new Exception('Tried to call unknown method '.$class.'::'.$suffix_method_name);
        }
    }

    static function getMethodSuffix($method, $params_ary=array()) {
        $c = '__';
        if(is_array($params_ary)){
            foreach($params_ary as $i=>$param){
                // Adding special characters to the end of method name 
                switch(gettype($param)){
                    case 'array':       $c .= 'a'; break;
                    case 'boolean':     $c .= 'b'; break;
                    case 'double':      $c .= 'd'; break;
                    case 'integer':     $c .= 'i'; break;
                    case 'NULL':        $c .= 'n'; break;
                    case 'object':
                        // Support closure parameter
                        if($param instanceof Closure ){
                            $c .= 'c';
                        }else{
                            $c .= 'o'; 
                        }
                    break;
                    case 'resource':    $c .= 'r'; break;
                    case 'string':      $c .= 's'; break;
                    case 'unknown type':$c .= 'u'; break;
                }
            }
        }
        return $c;
    }
    // Get a reference variable by name
    static function &refAccess($var_name) {
        $r =& $GLOBALS["$var_name"]; 
        return $r;
    }
}
//----------------------------------------------------------
#> 2. create new class
//----------------------------------------------------------

class test 
{
    private $name = 'test-1';

    #> 3. Add __call 'magic method' to your class

    // Call Overloadable class 
    // you must copy this method in your class to activate overloading
    function __call($method, $args) {
        return Overloadable::call($this, $method, $args);
    }

    #> 4. Add your methods with __ and arg type as one letter ie:(__i, __s, __is) and so on.
    #> methodname__i = methodname($integer)
    #> methodname__s = methodname($string)
    #> methodname__is = methodname($integer, $string)

    // func(void)
    function func__() {
        pre('func(void)', __function__);
    }
    // func(integer)
    function func__i($int) {
        pre('func(integer '.$int.')', __function__);
    }
    // func(string)
    function func__s($string) {
        pre('func(string '.$string.')', __function__);
    }    
    // func(string, object)
    function func__so($string, $object) {
        pre('func(string '.$string.', '.print_r($object, 1).')', __function__);
        //pre($object, 'Object: ');
    }
    // func(closure)
    function func__c(Closure $callback) {

        pre("func(".
            print_r(
                array( $callback, $callback($this->name) ), 
                1
            ).");", __function__.'(Closure)'
        );

    }   
    // anotherFunction(array)
    function anotherFunction__a($array) {
        pre('anotherFunction('.print_r($array, 1).')', __function__);
        $array[0]++;        // change the reference value
        $array['val']++;    // change the reference value
    }
    // anotherFunction(string)
    function anotherFunction__s($key) {
        pre('anotherFunction(string '.$key.')', __function__);
        // Get a reference
        $a2 =& Overloadable::refAccess($key); // $a2 =& $GLOBALS['val'];
        $a2 *= 3;   // change the reference value
    }

}

//----------------------------------------------------------
// Some data to work with:
$val  = 10;
class obj {
    private $x=10;
}

//----------------------------------------------------------
#> 5. create your object

// Start
$t = new test;

#> 6. Call your method

// Call first method with no args:
$t->func(); 
// Output: func(void)

$t->func($val);
// Output: func(integer 10)

$t->func("hello");
// Output: func(string hello)

$t->func("str", new obj());
/* Output: 
func(string str, obj Object
(
    [x:obj:private] => 10
)
)
*/

// call method with closure function
$t->func(function($n){
    return strtoupper($n);
});

/* Output:
func(Array
(
    [0] => Closure Object
        (
            [parameter] => Array
                (
                    [$n] => 
                )

        )

    [1] => TEST-1
)
);
*/

## Passing by Reference:

echo '<br><br>$val='.$val;
// Output: $val=10

$t->anotherFunction(array(&$val, 'val'=>&$val));
/* Output:
anotherFunction(Array
(
    [0] => 10
    [val] => 10
)
)
*/

echo 'Result: $val='.$val;
// Output: $val=12

$t->anotherFunction('val');
// Output: anotherFunction(string val)

echo 'Result: $val='.$val;
// Output: $val=36







// Helper function
//----------------------------------------------------------
function pre($mixed, $title=null){
    $output = "<fieldset>";
    $output .= $title ? "<legend><h2>$title</h2></legend>" : "";
    $output .= '<pre>'. print_r($mixed, 1). '</pre>';
    $output .= "</fieldset>";
    echo $output;
}
//----------------------------------------------------------
Hisham Dalal
fonte
4
Você poderia adicionar uma explicação sobre como usar essa classe?
11113 Justus Romijn
1- criar nova classe 2- estende-se sobrecarregável. 3 criar funções como funcname_ () => há argumentos ou como funcname_s ($ s) => string arg </ li>
Hisham Dalal
1
Esta é uma solução muito legal. Por que você faz $ o = new $ obj ()? Ainda não testei, apesar de achar que deve ser \ $ o = \ $ isso?
Over_optimistic
Obrigado por este aviso importante, e usarei barra invertida, mas é um trabalho com barra invertida e sem! - Eu uso o phpEazy como um servidor local.
Hisham Dalal 8/13
4

Que tal isso:

function($arg = NULL) {

    if ($arg != NULL) {
        etc.
        etc.
    }
}
Marlin Ouverson
fonte
Poderia funcionar, mas é menos legível se a sobrecarga tiver parâmetros diferentes com nomes e significados diferentes.
Mathias Lykkegaard Lorenzen
3

No PHP 5.6, você pode usar o operador splat ... como o último parâmetro e eliminar func_get_args()e func_num_args():

function example(...$args)
{
   count($args); // Equivalent to func_num_args()
}

example(1, 2);
example(1, 2, 3, 4, 5, 6, 7);

Você pode usá-lo para descompactar argumentos também:

$args[] = 1;
$args[] = 2;
$args[] = 3;
example(...$args);

É equivalente a:

example(1, 2, 3);
mtpultz
fonte
1
<?php

    class abs
    {
        public function volume($arg1=null, $arg2=null, $arg3=null)
        {   
            if($arg1 == null && $arg2 == null && $arg3 == null)
        {
            echo "function has no arguments. <br>";
        }

        else if($arg1 != null && $arg2 != null && $arg3 != null)
            {
            $volume=$arg1*$arg2*$arg3;
            echo "volume of a cuboid ".$volume ."<br>";
            }
            else if($arg1 != null && $arg2 != null)
            {
            $area=$arg1*$arg2;
            echo "area of square  = " .$area ."<br>";
            }
            else if($arg1 != null)
            {
            $volume=$arg1*$arg1*$arg1; 
            echo "volume of a cube = ".$volume ."<br>";
            }


        }


    }

    $obj=new abs();
    echo "For no arguments. <br>";
    $obj->volume();
    echo "For one arguments. <br>";
    $obj->volume(3);
    echo "For two arguments. <br>";
    $obj->volume(3,4);
    echo "For three arguments. <br>";
    $obj->volume(3,4,5);
    ?>
Raman Deep Bajwa
fonte
Tente editar a pergunta e use a formatação. Isso tornará sua resposta mais legível e atrairá mais usuários.
Kashish Arora
Essa técnica é mostrada em uma resposta anterior .
Home
0

O PHP não suporta sobrecarga por enquanto. Espero que isso seja implementado em outras versões, como outras linguagens de programação.

Confira esta biblioteca. Isso permitirá que você use a Sobrecarga do PHP em termos de fechamento. https://github.com/Sahil-Gulati/Overloading

Sahil Gulati
fonte
1
se você estiver indo para fazer uma declaração como esta realmente deve incluir as versões que você está se referindo, de que maneira as pessoas sabem como desatualizado seu comentário é quando vê-lo em uma data futura
miket
0

Infelizmente, não há sobrecarga no PHP, como é feito em C #. Mas eu tenho um pequeno truque. Declaro argumentos com valores nulos padrão e os verifico em uma função. Dessa forma, minha função pode fazer coisas diferentes, dependendo dos argumentos. Abaixo está um exemplo simples:

public function query($queryString, $class = null) //second arg. is optional
{
    $query = $this->dbLink->prepare($queryString);
    $query->execute();

    //if there is second argument method does different thing
    if (!is_null($class)) { 
        $query->setFetchMode(PDO::FETCH_CLASS, $class);
    }

    return $query->fetchAll();
}

//This loads rows in to array of class
$Result = $this->query($queryString, "SomeClass");
//This loads rows as standard arrays
$Result = $this->query($queryString);
Rovshan Mamedov
fonte
1
Leia todas as respostas existentes antes de escrever uma nova, anos depois. Essa técnica já foi mostrada duas vezes nas respostas acima. Uma vez em 2013, e novamente em 2014.
ToolmakerSteve