PHP: Aşırı Yükleme

Aşırı Yükleme ¶

PHP'deki aşırı yükleme, bir sınıfın özelliklerini ve yöntemlerini dinamik olarak oluşturmak anlamına gelmektedir. Bu dinamik öğeler, çeşitli eylem türleri için sınıf içinde oluşturulabilen sihirli yöntemler üzerinden işleme sokulurlar.

Aşırı yükleme yöntemleri, henüz bildirilmemiş veya geçerli etki alanında görünür olmayan özellik ve yöntemlerle etkileşilmek istendiğinde çağrılırlar. Bu bölümün kalanında bu bildirim ve görünürlükle ilgili durumdan bahsederken erişilemeyen özellikler ve erişilemeyen yöntemler terimlerini kullanacağız.

Tüm aşırı yükleme yöntemlerinin public olarak tanımlanması gerekir.

Bu sihirli yöntemlerin bağımsız değişkenlerinin hiçbiri gönderimli olarak aktarılamaz.

Bilginize:
PHP'nin aşırı yükleme konusundaki yorumu çoğu nesne yönelimli dilden farklıdır. Aşırı yükleme geleneksel olarak, dile, farklı miktar ve türde bağımsız değişkene sahip aynı isimde çok sayıda yönteme sahip olabilme yeteneği sağlar.

Özelliklerde aşırı yükleme ¶

public __set(string $isim, mixed $değer): void

public __get(string $isim): mixed

public __isset(string $isim): bool

public __unset(string $isim): void

__set() erişilemeyen (protected veya private) veya varolmayan özelliklere veri yazarken çalıştırılır.

__get() erişilemeyen (protected veya private) veya varolmayan özelliklerden veri okurken devreye sokulur.

__isset() erişilemeyen (protected veya private) veya varolmayan özellikler için isset() veya empty() çağrıldığında tetiklenir.

__unset() erişilemeyen (protected veya private) veya varolmayan özellikler için unset() kullanıldığında çağrılır.

$isim bağımsız değişkeni etkileşime girilecek özelliğin ismidir. __set() yönteminin $değer bağımsız değişkeni, $isim adlı özelliğe atanacak değeri belirler.

Özellikler üzerindeki aşırı yükleme sadece nesne bağlamında çalışır. Bu sihirli yöntemler statik bağlamda tetiklenmeyecektir. Bu bakımdan, bu yöntemler static bildirilmemelidir. Sihirli aşırı yükleme yöntemleri static bildirilirse bir uyarı çıktılar.

Bilginize:
PHP'nin atama işlecini ele alış yönteminden dolayı __set() yönteminin dönüş değeri yoksayılır. Benzer şekilde,
 $a = $obj->b = 8; 
örneğindeki gibi zincirleme atamalarda __get() asla çağrılmaz.

Bilginize:
PHP aşırı yüklü bir yöntemi aynı aşırı yüklü yöntemin içinden çağırmaz. Yani, __get() içinde return $this->foo yazılırsa null dönecek ve __get() işlevini ikinci kez çağırmak yerine foo diye bir özellik tanımlı olmadığından bir E_WARNING tetiklenecektir. Ancak, aşırı yüklü yöntemler örtük olarak başka aşırı yüklü yöntemleri çağırabilir (__set()'i tetikleyen __get() gibi).

Örnek 1 - __get(), __set(), __isset() ve __unset() ile aşırı yükleme örneği

<?php
class ÖzellikSınama
{
    /*  Aşırı yüklemeye konu veriler burada.  */
    private $veri = array();

    /*  Bildirilmiş özellikler için aşırı yükleme kullanılmaz.  */
    public $bildirilmiş = 1;

    /*  Aşırı yükleme sadece sınıf dışından erişilemeyen özellikler içindir.
     */
    private $gizli = 2;

    public function __set($isim, $değer)
    {
        echo "'$isim' adlı özelliğe '$değer' atanıyor.\n";
        $this->veri[$isim] = $değer;
    }

    public function __get($isim)
    {
        echo "'$isim' adlı özelliğin değeri isteniyor\n";
        if (array_key_exists($isim, $this->veri)) {
            return $this->veri[$isim];
        }

        $trace = debug_backtrace();
        trigger_error(
            $trace[0]['file'] . ' dosyasının ' .
            $trace[0]['line'] . '. satırında ' .
            '__get() ile tanımsız özellik istendi: ' . $isim,
            E_USER_NOTICE);
        return null;
    }

    /**  PHP 5.1.0'dan itibaren  */
    public function __isset($isim)
    {
        echo "'$isim' atanmış mı?\n";
        return isset($this->veri[$isim]);
    }

    /**  PHP 5.1.0'dan itibaren  */
    public function __unset($isim)
    {
        echo "'$name' siliniyor\n";
        unset($this->veri[$isim]);
    }

    /**  Sihirli bir yöntem değil; sadece örnek olsun diye.  */
    public function gizliyiOku()
    {
        return $this->gizli;
    }
}


echo "<pre>\n";

$obj = new ÖzellikSınama;

$obj->a = 1;
echo $obj->a . "\n\n";

var_dump(isset($obj->a));
unset($obj->a);
var_dump(isset($obj->a));
echo "\n";

echo $obj->bildirilmiş . "\n\n";

echo "'gizli' isimli 'private' özellik ile bir deneme yapalım:\n";
echo "'private' özellikler sadece sınıf içinde görünürdürler,\n";
echo "bu yüzden __get() kullanılmaz...\n";
echo $obj->gizliyiOku() . "\n";
echo "'private' özellikler sınıf dışında görünür değildirler,\n";
echo "dolayısıyla __get() kullanılır...\n";
echo $obj->gizli . "\n";
?>

Yukarıdaki örneğin çıktısı:

'a' adlı özelliğe '1' atanıyor.
'a' adlı özelliğin değeri isteniyor
1

'a' atanmış mı?
bool(true)
'' siliniyor
'a' atanmış mı?
bool(false)

1

'gizli' isimli 'private' özellik ile bir deneme yapalım:
'private' özellikler sadece sınıf içinde görünürdürler,
bu yüzden __get() kullanılmaz...
2
'private' özellikler sınıf dışında görünür değildirler,
dolayısıyla __get() kullanılır...
'gizli' adlı özelliğin değeri isteniyor

Notice: <dosya> dosyasının 71. satırında __get() ile tanımsız özellik istendi: gizli

Yöntemlerde aşırı yükleme ¶

public __call(string $isim, array $bağımsız_değişkenler): mixed

public static __callStatic(string $isim, array $bağımsız_değişkenler): mixed

__call(), erişilemeyen yöntemler bir nesne bağlamından çağrıldığında tetiklenir.

__callStatic(), erişilemeyen yöntemler statik bir bağlamdan çağrıldığında tetiklenir.

$isim bağımsız değişkeni çağrılan yöntemin ismidir. $bağımsız_değişkenler bağımsız değişkeni ise $isim adlı yönteme aktarılan bağımsız değişkenleri içeren numararalı bir dizidir.

Örnek 2 - __call() ve __callStatic() ile aşırı yüklü örneklenmiş yöntemler

<?php
class YöntemSınama
{
    public function __call($isim, $bağımsız_değişkenler)
    {
        // Bilgi: $isim değeri büyük-küçük harfe duyarlıdır.
        echo "Nesnenin '$isim' yöntemi çağrılıyor: "
             . implode(', ', $bağımsız_değişkenler). "\n";
    }

    public static function __callStatic($isim, $bağımsız_değişkenler)
    {
        // Bilgi: $isim değeri büyük-küçük harfe duyarlıdır.
        echo "Statik yöntem '$isim' çağrılıyor: "
             . implode(', ', $bağımsız_değişkenler). "\n";
    }
}

$obj = new YöntemSınama;
$obj->deneBakalım('nesne bağlamında');

YöntemSınama::deneBakalım('statik bağlamda');
?>

Yukarıdaki örneğin çıktısı:

Nesnenin 'deneBakalım' yöntemi çağrılıyor: nesne bağlamında
Statik yöntem 'deneBakalım' çağrılıyor: statik bağlamda

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 27 notes

down

385

theaceofthespade at gmail dot com ¶

13 years ago

A word of warning!  It may seem obvious, but remember, when deciding whether to use __get, __set, and __call as a way to access the data in your class (as opposed to hard-coding getters and setters), keep in mind that this will prevent any sort of autocomplete, highlighting, or documentation that your ide mite do.

Furthermore, it beyond personal preference when working with other people.  Even without an ide, it can be much easier to go through and look at hardcoded member and method definitions in code, than having to sift through code and piece together the method/member names that are assembled in __get and __set.

If you still decide to use __get and __set for everything in your class, be sure to include detailed comments and documenting, so that the people you are working with (or the people who inherit the code from you at a later date) don't have to waste time interpreting your code just to be able to use it.

down

280

Anonymous ¶

8 years ago

First off all, if you read this, please upvote the first comment on this list that states that “overloading” is a bad term for this behaviour. Because it REALLY is a bad name. You’re giving new definition to an already accepted IT-branch terminology.

Second, I concur with all criticism you will read about this functionality. Just as naming it “overloading”, the functionality is also very bad practice. Please don’t use this in a production environment. To be honest, avoid to use it at all. Especially if you are a beginner at PHP. It can make your code react very unexpectedly. In which case you MIGHT be learning invalid coding!

And last, because of __get, __set and __call the following code executes. Which is abnormal behaviour. And can cause a lot of problems/bugs.

<?php

class BadPractice {
  // Two real properties
  public $DontAllowVariableNameWithTypos = true;
  protected $Number = 0;
  // One private method
  private function veryPrivateMethod() { }
  // And three very magic methods that will make everything look inconsistent
  // with all you have ever learned about PHP.
  public function __get($n) {}
  public function __set($n, $v) {}
  public function __call($n, $v) {}
}

// Let's see our BadPractice in a production environment!
$UnexpectedBehaviour = new BadPractice;

// No syntax highlighting on most IDE's
$UnexpectedBehaviour->SynTaxHighlighting = false;

// No autocompletion on most IDE's
$UnexpectedBehaviour->AutoCompletion = false;

// Which will lead to problems waiting to happen
$UnexpectedBehaviour->DontAllowVariableNameWithTyphos = false; // see if below

// Get, Set and Call anything you want!
$UnexpectedBehaviour->EveryPosibleMethodCallAllowed(true, 'Why Not?');

// And sure, why not use the most illegal property names you can think off
$UnexpectedBehaviour->{'100%Illegal+Names'} = 'allowed';

// This Very confusing syntax seems to allow access to $Number but because of
// the lowered visibility it goes to __set()
$UnexpectedBehaviour->Number = 10;

// We can SEEM to increment it too! (that's really dynamic! :-) NULL++ LMAO
$UnexpectedBehaviour->Number++;

// this ofcourse outputs NULL (through __get) and not the PERHAPS expected 11
var_dump($UnexpectedBehaviour->Number);

// and sure, private method calls LOOK valid now!
// (this goes to __call, so no fatal error)
$UnexpectedBehaviour->veryPrivateMethod();

// Because the previous was __set to false, next expression is true
// if we didn't had __set, the previous assignment would have failed
// then you would have corrected the typho and this code will not have
// been executed. (This can really be a BIG PAIN)
if ($UnexpectedBehaviour->DontAllowVariableNameWithTypos) {
  // if this code block would have deleted a file, or do a deletion on
  // a database, you could really be VERY SAD for a long time!
  $UnexpectedBehaviour->executeStuffYouDontWantHere(true);
}
?>

down

198

egingell at sisna dot com ¶

17 years ago

Small vocabulary note: This is *not* "overloading", this is "overriding".

Overloading: Declaring a function multiple times with a different set of parameters like this:
<?php

function foo($a) {
    return $a;
}

function foo($a, $b) {
    return $a + $b;
}

echo foo(5); // Prints "5"
echo foo(5, 2); // Prints "7"

?>

Overriding: Replacing the parent class's method(s) with a new method by redeclaring it like this:
<?php

class foo {
    function new($args) {
        // Do something.
    }
}

class bar extends foo {
    function new($args) {
        // Do something different.
    }
}

?>

down

Anonymous ¶

9 years ago

Using magic methods, especially __get(), __set(), and __call() will effectively disable autocomplete in most IDEs (eg.: IntelliSense) for the affected classes.

To overcome this inconvenience, use phpDoc to let the IDE know about these magic methods and properties: @method, @property, @property-read, @property-write.

/**
 * @property-read name
 * @property-read price
 */
class MyClass
{
    private $properties = array('name' => 'IceFruit', 'price' => 2.49)
    
    public function __get($name)
    {
        return $this->properties($name);
    }
}

down

pogregoire##live.fr ¶

8 years ago

It is important to understand that encapsulation can be very easily violated in PHP. for example :
class Object{

}

$Object = new Object();
$Objet->barbarianProperties  = 'boom';

var_dump($Objet);// object(Objet)#1 (1) { ["barbarianProperties"]=> string(7) "boom" }

Hence it is possible to add a propertie out form the class definition.
It is then a necessity in order to protect encapsulation to introduce __set() in the class :

class Objet{
    public function __set($name,$value){
        throw new Exception ('no');
    }
}

down

Ant P. ¶

16 years ago

Be extra careful when using __call():  if you typo a function call somewhere it won't trigger an undefined function error, but get passed to __call() instead, possibly causing all sorts of bizarre side effects.
In versions before 5.3 without __callStatic, static calls to nonexistent functions also fall through to __call!
This caused me hours of confusion, hopefully this comment will save someone else from the same.

down

turabgarip at gmail dot com ¶

4 years ago

I concur that "overloading" is a wrong term for this functionality. But I disagree that this functionality is completely wrong. You can do "bad practice" with right code too.

For example __call() is very well applicable to external integration implementations which I am using to relay calls to SOAP methods which doesn't need local implementation. So you don't have to write "empty body" functions. Consider the SOAP service you connect has a "stock update" method. All you have to do is passing product code and stock count to SOAP.

<?php

class Inventory {

  public __construct() {
    // configure and connect to SOAP service
    $this->soap = new SoapClient();
  }

  public __call($soapMethod, $params) {
    $this->soap->{$soapMethod}(params);
  }
}

 // Now you can use any SOAP method without needing a wrapper
 $stock = new Inventory();
 $stock->updatePrice($product_id, 20);
 $stock->saveProduct($product_info);
 
?>

Of course you'd need a parameter mapping but it's in my honest opinion a lot better then having a plenty of mirror methods like:

<?php

class Inventory {

  public function updateStock($product_id, $stock) {
    $soapClient->updateStock($product_id, $stock;
  }
  public function updatePrice($product_id, $price) {
    $soapClient->updateStock($product_id, $price;
  }
  // ...
}

?>

down

johannes dot kingma at gmail dot com ¶

3 years ago

One interesting use of the __get function is property / function colaescence, using the same name for a property and a function. 

Example:
<?php
class prop_fun {
    private $prop = 123;

    public function __get( $property ) {
        if( property_exists( $this, $property ) ){
            return $this-> $property;
        }
        throw new Exception( "no such property $property." );
    }
    public function prop() {
        return 456;
    }
}

$o = new prop_fun();

echo $o-> prop . '<br>' . PHP_EOL;
echo $o-> prop() . '<br>' . PHP_EOL;
?>

This will output 123 and 456. This does look like a funy cludge but I used it of a class containing a date type property and function allowing me to write

<?php
class date_class {
    /** @property int $date */
    private $the_date;

    public function __get( $property ) {
        if( property_exists( $this, $property ) ){
            return $this-> $property;
        }
        throw new Exception( "no such property $property." );
    }
    public function the_date( $datetime ) {
        return strtotime( $datetime, $this-> the_date );
    }

    public function __construct()    {
        $this-> the_date = time();
    }
}

$date_object = new date_class();

$today = $date_object-> the_date;
$nextyear = $date_object-> the_date("+1 year");

echo date( "d/m/Y", $today) . '<br>';
echo date( "d/m/Y", $nextyear );
?>

Which I like because its self documenting properties. I used this in a utility class for user input.

down

gabe at fijiwebdesign dot com ¶

10 years ago

Note that you can enable "overloading" on a class instance at runtime for an existing property by unset()ing that property. 

eg: 

<?php
class Test { 

    public $property1;

    public function __get($name) 
    {
        return "Get called for " . get_class($this) . "->\$$name \n";
    }

}
?>

The public property $property1 can be unset() so that it can be dynamically handled via __get(). 

<?php 
$Test = new Test();
unset($Test->property1); // enable overloading
echo $Test->property1; // Get called for Test->$property1
?>

Useful if you want to proxy or lazy load properties yet want to have documentation and visibility in the code and debugging compared to __get(), __isset(), __set() on non-existent inaccessible properties.

down

navarr at gtaero dot net ¶

14 years ago

If you want to make it work more naturally for arrays $obj->variable[] etc you'll need to return __get by reference.



<?php

class Variables

{

        public function __construct()

        {

                if(session_id() === "")

                {

                        session_start();

                }

        }

        public function __set($name,$value)

        {

                $_SESSION["Variables"][$name] = $value;

        }

        public function &__get($name)

        {

                return $_SESSION["Variables"][$name];

        }

        public function __isset($name)

        {

                return isset($_SESSION["Variables"][$name]);

        }

}

?>

down

php at lanar dot com dot au ¶

14 years ago

Note that __isset is not called on chained checks. 
If isset( $x->a->b ) is executed where $x is a class with __isset() declared, __isset() is not called.

<?php

class demo
{
    var $id ;
    function __construct( $id = 'who knows' )
    {
        $this->id = $id ;
    }
    function __get( $prop )
    {
        echo "\n", __FILE__, ':', __LINE__, ' ', __METHOD__, '(', $prop, ') instance ', $this->id ;
        return new demo( 'autocreated' ) ; // return a class anyway for the demo
    }
    function __isset( $prop )
    {
        echo "\n", __FILE__, ':', __LINE__, ' ', __METHOD__, '(', $prop, ') instance ', $this->id ;
        return FALSE ;
    }
}
$x = new demo( 'demo' ) ;
echo "\n", 'Calls __isset() on demo as expected when executing isset( $x->a )' ;
$ret = isset( $x->a ) ;
echo "\n", 'Calls __get() on demo without call to __isset()  when executing isset( $x->a->b )' ;
$ret = isset( $x->a->b ) ;
?>

Outputs

Calls __isset() on demo as expected when executing isset( $x->a )
C:\htdocs\test.php:31 demo::__isset(a) instance demo
Calls __get() on demo without call to __isset()  when executing isset( $x->a->b )
C:\htdocs\test.php:26 demo::__get(a) instance demo
C:\htdocs\test.php:31 demo::__isset(b) instance autocreated

down

PHP at jyopp dotKomm ¶

19 years ago

Here's a useful class for logging function calls.  It stores a sequence of calls and arguments which can then be applied to objects later.  This can be used to script common sequences of operations, or to make "pluggable" operation sequences in header files that can be replayed on objects later.

If it is instantiated with an object to shadow, it behaves as a mediator and executes the calls on this object as they come in, passing back the values from the execution.

This is a very general implementation; it should be changed if error codes or exceptions need to be handled during the Replay process.
<?php
class MethodCallLog {
    private $callLog = array();
    private $object;
    
    public function __construct($object = null) {
        $this->object = $object;
    }
    public function __call($m, $a) {
        $this->callLog[] = array($m, $a);
        if ($this->object) return call_user_func_array(array(&$this->object,$m),$a);
        return true;
    }
    public function Replay(&$object) {
        foreach ($this->callLog as $c) {
            call_user_func_array(array(&$object,$c[0]), $c[1]);
        }
    }
    public function GetEntries() {
        $rVal = array();
        foreach ($this->callLog as $c) {
            $rVal[] = "$c[0](".implode(', ', $c[1]).");";
        }
        return $rVal;
    }
    public function Clear() {
        $this->callLog = array();
    }
}

$log = new MethodCallLog();
$log->Method1();
$log->Method2("Value");
$log->Method1($a, $b, $c);
// Execute these method calls on a set of objects...
foreach ($array as $o) $log->Replay($o);
?>

down

justmyoponion at gmail dot com ¶

5 years ago

If you are not focused enough, then don't use it. 
Otherwise it is very powerful and you can build very complex code that handle a lot of things like zend framework did.

down

cottton at i-stats dot net ¶

10 years ago

Actually you dont need __set ect imo.  
You could use it to set (pre-defined) protected (and in "some" cases private) properties . But who wants that? 
(test it by uncommenting private or protected)
(pastebin because long ...) => http://pastebin.com/By4gHrt5

down

matthijs at yourmediafactory dot com ¶

17 years ago

While PHP does not support true overloading natively, I have to disagree with those that state this can't be achieved trough __call. 

Yes, it's not pretty but it is definately possible to overload a member based on the type of its argument. An example:
<?php 
class A { 
   
  public function __call ($member, $arguments) { 
    if(is_object($arguments[0])) 
      $member = $member . 'Object'; 
    if(is_array($arguments[0])) 
      $member = $member . 'Array'; 
    $this -> $member($arguments); 
  } 
   
  private function testArray () { 
    echo "Array."; 
  } 
   
  private function testObject () { 
    echo "Object."; 
  } 
} 

class B { 
} 

$class = new A; 
$class -> test(array()); // echo's 'Array.' 
$class -> test(new B); // echo's 'Object.' 
?>

Of course, the use of this is questionable (I have never needed it myself, but then again, I only have a very minimalistic C++ & JAVA background). However, using this general principle and optionally building forth on other suggestions a 'form' of overloading is definately possible, provided you have some strict naming conventions in your functions. 

It would of course become a LOT easier once PHP'd let you declare the same member several times but with different arguments, since if you combine that with the reflection class 'real' overloading comes into the grasp of a good OO programmer. Lets keep our fingers crossed!

down

timshaw at mail dot NOSPAMusa dot com ¶

17 years ago

The __get overload method will be called on a declared public member of an object if that member has been unset.

<?php
class c {
  public $p ;
  public function __get($name) { return "__get of $name" ; }
}

$c = new c ;
echo $c->p, "\n" ;    // declared public member value is empty
$c->p = 5 ;
echo $c->p, "\n" ;    // declared public member value is 5
unset($c->p) ;
echo $c->p, "\n" ;    // after unset, value is "__get of p"
?>

down

jstubbs at work-at dot co dot jp ¶

18 years ago

<?php $myclass->foo['bar'] = 'baz'; ?>

 

When overriding __get and __set, the above code can work (as expected) but it depends on your __get implementation rather than your __set. In fact, __set is never called with the above code. It appears that PHP (at least as of 5.1) uses a reference to whatever was returned by __get. To be more verbose, the above code is essentially identical to:

 

<?php

$tmp_array = &$myclass->foo;

$tmp_array['bar'] = 'baz';

unset($tmp_array);

?>



Therefore, the above won't do anything if your __get implementation resembles this:



<?php 

function __get($name) {

    return array_key_exists($name, $this->values)

        ? $this->values[$name] : null;

}

?>



You will actually need to set the value in __get and return that, as in the following code:



<?php

function __get($name) {

    if (!array_key_exists($name, $this->values))

        $this->values[$name] = null;

    return $this->values[$name];

}

?>

down

alexandre at nospam dot gaigalas dot net ¶

17 years ago

PHP 5.2.1

Its possible to call magic methods with invalid names using variable method/property names:

<?php

class foo
{
    function __get($n)
    {
        print_r($n);
    }
    function __call($m, $a)
    {
        print_r($m);
    }
}

$test = new foo;
$varname = 'invalid,variable+name';
$test->$varname;
$test->$varname();

?>

I just don't know if it is a bug or a feature :)

down

Marius ¶

19 years ago

for anyone who's thinking about traversing some variable tree
by using __get() and __set(). i tried to do this and found one
problem: you can handle couple of __get() in a row by returning
an object which can handle consequential __get(), but you can't
handle __get() and __set() that way.
i.e. if you want to:
<?php
    print($obj->val1->val2->val3); // three __get() calls
?> - this will work,
but if you want to:
<?php
    $obj->val1->val2 = $val; // one __get() and one __set() call
?> - this will fail with message:
"Fatal error: Cannot access undefined property for object with
 overloaded property access"
however if you don't mix __get() and __set() in one expression,
it will work:
<?php
    $obj->val1 = $val; // only one __set() call
    $val2 = $obj->val1->val2; // two __get() calls
    $val2->val3 = $val; // one __set() call
?>

as you can see you can split __get() and __set() parts of
expression into two expressions to make it work.

by the way, this seems like a bug to me, will have to report it.

down

daevid at daevid dot com ¶

15 years ago

Here's a handy little routine to suggest properties you're trying to set that don't exist. For example:



Attempted to __get() non-existant property/variable 'operator_id' in class 'User'.



checking for operator and suggesting the following:



    * id_operator

    * operator_name

    * operator_code



enjoy.



<?php

    /**

     * Suggests alternative properties should a __get() or __set() fail

     *

     * @param     string $property

     * @return string

     * @author Daevid Vincent [daevid@daevid.com]

     * @date    05/12/09

     * @see        __get(), __set(), __call()

     */

    public function suggest_alternative($property)

    {

        $parts = explode('_',$property);

        foreach($parts as $i => $p) if ($p == '_' || $p == 'id') unset($parts[$i]);



        echo 'checking for <b>'.implode(', ',$parts)."</b> and suggesting the following:<br/>\n";



        echo "<ul>";

        foreach($this as $key => $value)

            foreach($parts as $p)

                if (stripos($key, $p) !== false) print '<li>'.$key."</li>\n";

        echo "</ul>";

    }



just put it in your __get() or __set() like so:



    public function __get($property)

    {

            echo "<p><font color='#ff0000'>Attempted to __get() non-existant property/variable '".$property."' in class '".$this->get_class_name()."'.</font><p>\n";

            $this->suggest_alternative($property);

            exit;

    }

?>

down

dans at dansheps dot com ¶

13 years ago

Since this was getting me for a little bit, I figure I better pipe in here...



For nested calls to private/protected variables(probably functions too) what it does is call a __get()  on the first object, and if you return the nested object, it then calls a __get() on the nested object because, well it is protected as well.



EG:

<?php

class A

{

protected $B



public function __construct()

{

$this->B = new B();

}



public function __get($variable)

{

echo "Class A::Variable " . $variable . "\n\r";

$retval = $this->{$variable};

return $retval;

}

}



class B

{

protected $val



public function __construct()

{

$this->val = 1;

}



public function __get($variable)

{

echo "Class B::Variable " . $variable . "\n\r";

$retval = $this->{$variable};

return $retval;

}

}



$A = new A();



echo "Final Value: " . $A->B->val;

?>



That will return something like...



Class A::Variable B

Class B::Variable val

Final Value: 1



It seperates the calls into $A->B and $B->val



Hope this helps someone

down

Daniel Smith ¶

13 years ago

Be careful of __call in case you have a protected/private method. Doing this:

<?php
class TestMagicCallMethod {
    public function foo()
    {
        echo __METHOD__.PHP_EOL;
    }

    public function __call($method, $args)
    {
        echo __METHOD__.PHP_EOL;
        if(method_exists($this, $method))
        {
            $this->$method();
        }
    }
    
    protected function bar()
    {
        echo __METHOD__.PHP_EOL;
    }

    private function baz()
    {
        echo __METHOD__.PHP_EOL;
    }
}

$test    =    new TestMagicCallMethod();
$test->foo();
/**
 * Outputs: 
 * TestMagicCallMethod::foo
 */

$test->bar();
/**
 * Outputs: 
 * TestMagicCallMethod::__call
 * TestMagicCallMethod::bar
 */

$test->baz();
/**
 * Outputs:
 * TestMagicCallMethod::__call
 * TestMagicCallMethod::baz
 */
?>

..is probably not what you should be doing. Always make sure that the methods you call in __call are allowed as you probably dont want all the private/protected methods to be accessed by a typo or something.

down

DevilDude at darkmaker dot com ¶

20 years ago

Php 5 has a simple recursion system that stops you from using overloading within an overloading function, this means you cannot get an overloaded variable within the __get method, or within any functions/methods called by the _get method, you can however call __get manualy within itself to do the same thing.

down

Nanhe Kumar ¶

11 years ago

<?php
//How can implement __call function you understand better
class Employee {

    protected $_name;
    protected $_email;
    protected $_compony;

    public function __call($name, $arguments) {
        $action = substr($name, 0, 3);
        switch ($action) {
            case 'get':
                $property = '_' . strtolower(substr($name, 3));
                if(property_exists($this,$property)){
                    return $this->{$property};
                }else{
                    $trace = debug_backtrace();
                    trigger_error('Undefined property  ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_NOTICE);
                    return null;
                }
                break;
            case 'set':
                $property = '_' . strtolower(substr($name, 3));
                if(property_exists($this,$property)){
                    $this->{$property} = $arguments[0];
                }else{
                    $trace = debug_backtrace();
                    trigger_error('Undefined property  ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_NOTICE);
                    return null;
                }
                
                break;
            default :
                return FALSE;
        }
    }

}

$s = new Employee();
$s->setName('Nanhe Kumar');
$s->setEmail('nanhe.kumar@gmail.com');
echo $s->getName(); //Nanhe Kumar
echo $s->getEmail(); // nanhe.kumar@gmail.com
$s->setAge(10); //Notice: Undefined property setAge in
?>

down

Adeel Khan ¶

17 years ago

Observe:

<?php
class Foo {
    function __call($m, $a) {
        die($m);
    }
}

$foo = new Foo;
print $foo->{'wow!'}();

// outputs 'wow!'
?>

This method allows you to call functions with invalid characters.

down

php at sleep is the enemy dot co dot uk ¶

17 years ago

Just to reinforce and elaborate on what DevilDude at darkmaker dot com said way down there on 22-Sep-2004 07:57.

The recursion detection feature can prove especially perilous when using __set. When PHP comes across a statement that would usually call __set but would lead to recursion, rather than firing off a warning or simply not executing the statement it will act as though there is no __set method defined at all. The default behaviour in this instance is to dynamically add the specified property to the object thus breaking the desired functionality of all further calls to __set or __get for that property.

Example:

<?php

class TestClass{

    public $values = array();
    
    public function __get($name){
        return $this->values[$name];
    }
    
    public function __set($name, $value){
        $this->values[$name] = $value;
        $this->validate($name);
    }

    public function validate($name){
        /*
        __get will be called on the following line
        but as soon as we attempt to call __set 
        again PHP will refuse and simply add a 
        property called $name to $this 
        */
        $this->$name = trim($this->$name);
    }
}

$tc = new TestClass();

$tc->foo = 'bar';
$tc->values['foo'] = 'boing';

echo '$tc->foo == ' . $tc->foo . '<br>';
echo '$tc ' . (property_exists($tc, 'foo') ? 'now has' : 'still does not have') . ' a property called "foo"<br>';

/*
OUPUTS:
$tc->foo == bar
$tc now has a property called "foo"
*/

?>

down

strata_ranger at hotmail dot com ¶

15 years ago

Combining two things noted previously:

1 - Unsetting an object member removes it from the object completely, subsequent uses of that member will be handled by magic methods.
2 - PHP will not recursively call one magic method from within itself (at least for the same $name).

This means that if an object member has been unset(), it IS possible to re-declare that object member (as public) by creating it within your object's __set() method, like this:

<?php
class Foo
{
  function __set($name, $value)
  {
    // Add a new (public) member to this object.
    // This works because __set() will not recursively call itself.
    $this->$name= $value;
  }
}

$foo = new Foo();

// $foo has zero members at this point
var_dump($foo);

// __set() will be called here
$foo->bar = 'something'; // Calls __set()

// $foo now contains one member
var_dump($foo);

// Won't call __set() because 'bar' is now declared
$foo->bar = 'other thing';

?>

Also be mindful that if you want to break a reference involving an object member without triggering magic functionality, DO NOT unset() the object member directly.  Instead use =& to bind the object member to any convenient null variable.

＋add a note