PHP Question: Print Object

28th April 2011 - 3 minutes read time

Note: This post is over a year old and so the information contained here might be out of date. If you do spot something please leave a comment and I will endeavour to correct.

Question

The following code was executed.

<?php
class MyClass {
  private $foo = "bar";
}
 
$myObject = new MyClass();
echo $myObject;

Which produced the following error.

Catchable fatal error: Object of class MyClass could not be converted to string in test.php on line 7
 
Call Stack:
    0.0011     323736   1. {main}() /test.php:0

How can the code be simply changed to prevent this error and produce some form of result?

Answer

The easiest way to rewrite this code and to actually print out the object properly is to use the __toString() magic method. This method must return a string and is automatically called an object is printed out. The example code can therefore be rewritten like this:

<?php
class MyClass {
  private $foo = "bar";
 
  public function __toString() {
    return $this->foo;
  }
}
 
$myObject = new MyClass();
echo $myObject;

This stops the error occurring and will produce the output below.

bar

The __toString() function is useful for both debug purposes but also for decorating output. For example, we could have a User class that would print out the user's information, and a HtmlUser decorator class that prints out the user's information with surrounding HTML tags. This would be written like this:

<?php
class User {
 
  public $_username;
  public $_forename;
  public $_surname;
  public $_created;
 
  public function __construct() {
    $this->_username = 'user1';
    $this->_forename = 'John';
    $this->_surname = 'Doe';
    $this->_created = time();
  }
 
  public function __toString() {
    $output = '';
 
    $output .= "Username = " . $this->_username . "\n";
    $output .= "Forename = " . $this->_forename . "\n";
    $output .= "Surname = " . $this->_surname . "\n";
    $output .= "Created = " . $this->_created . "\n";
 
    return $output;
  }
 
}
 
class HtmlUser {
 
  protected $user;
 
  public function __construct(User $user) {
    $this->user = $user;
  }
 
  public function __toString() {
    $output = "<ul>\n";
 
    $output .= "\t<li><strong>Username</strong> " . $this->user->_username . "</li>\n";
    $output .= "\t<li><strong>Forename</strong> " . $this->user->_forename . "</li>\n";
    $output .= "\t<li><strong>Surname</strong> " . $this->user->_surname . "</li>\n";
    $output .= "\t<li><strong>Created</strong> " . $this->user->_created . "</li>\n";
 
    $output .= "</ul>";
 
    return $output;
  }
 
}
 
$user = new User();
$htmlUser = new HtmlUser($user);
echo $htmlUser;

This produces the following output:

<ul>
	<li><strong>Username</strong> user1</li>
	<li><strong>Forename</strong> John</li>
	<li><strong>Surname</strong> Doe</li>
	<li><strong>Created</strong> 1304196043</li>
</ul>

PHP

Comments

Permalink

echo ( is_object( $myObject ) ) ? 'Sorry! We have an object here!' : $myObject ;

Add new comment

Steganography With Images In PHP

Steganography is the practice of placing a secret message inside another message and only by looking at the original message in a different way can the hidden message be seen. This might be as mundane as writing a page of text and hiding a message in the text using the first letter of every sentence. Only by collecting the first letter of each sentence together can the hidden message be seen and read.

Modern steganography is defined as hiding a message (or file) inside a file. For example, you might look at an image and see an image, but if a message has been hidden you would also be able to extract it if you know where to look.

Color Sorting In PHP: Part 6

I finished my last post on sorting colors using PHP looking at incorporating all three dimensions into the display of the colors. This lead to some interesting displays of colors in discs using different shapes or lengths as an indication of the color in question. It was still lacking actually rendering out the third dimension in any meaingful way though.

As I am essentially looking at three dimensional data I thought about displaying the data as a cube in a 3D engine. I could then map the three dimensions of colors (red, green, blue) into the three dimensions of the 3D engine (x, y, z). This means creating a 3D scene with random color data and rendering that scene out. Funnily enough, there aren't a lot of people writing 3D rendering engines in PHP so I looked into writing a very basic version that would just show point data.

Extracting Data From An MP3 With PHP

I was looking at a media player on my phone the other day and was watching the waveform of the music shown on screen. This was a simple indication of the progress through the track and appeared to show quiet and loud sections of the track I was listening to. This got me thinking about how to extract this information as the media player I was watching must do this in real time in order to actually play the data, not just render this representation of the music.

After a bit of research into the MP3 file format I found that the file format is complex, but straight forward enough to process, so I decided to try and extract the data using PHP. I have seen a few techniques to extract the data from MP3 using PHP, but these largely involve applications like ffmpeg to convert the audio format into something like a WAV file, which is then processed.

Adding Arguments And Options To Deployer Tasks

I have been adding to my custom Deployer scripts for a number of months and I have now been using it to do more than just deploy my sites. Since it acts as a connection to my website server I have been using Deployer to perform other tasks like creating backups and clearing Drupal caches without having to log into the server to do it. What has helped me here is that I have set out my deployment tasks in a very modular fashion, so although my deployment runs a database backup, I there is nothing to stop me running the database backup command on it's own without doing a full deployment.

Creating A Game With PHP Part 3: Snake

So far in this series of posts we have looked at detecting key presses from the user and creating a game of tic tac toe using PHP and the command line. The next step is to create a game that has graphics and real time user input. As we are using the command line we don't have much space to work with so the graphics we create aren't going to be very detailed. The simplest action game I could think of is snake. It has a few simple rules, can have very basic graphics and doesn't involve any physics or other mechanics that would effect the game as a whole. In fact the game snake dates back to the 1976 game Blockade, which was created using just text strings.