Working with Private Properties to Protect PHP 5 Class Data - Defining private class properties
(Page 4 of 4 )
If you found working with public and protected properties of a given PHP 5 class easy, then it’s quite probable that you'll feel the same way when it comes to using private data members. By definition, any class property declared private can only be accessed from inside the originating class. That’s all.
However, even though the above definition is very intuitive, it’s necessary to complement it adequately with a practical example. With that idea in mind, in the next few lines, I’m going to list the signature of the same “DataSaver” class that you saw earlier, but this time, its respective properties will be declared private.
The brand new definition of this sample class looks like this:
// define 'DataSaver' class (properties are defined private)
class DataSaver{
private $filePath;
private $data;
public function __construct($data,$filePath){
if(!$data||strlen($data)>1024){
throw new Exception('Invalid data for being saved to target file.');
}
if(!file_exists($filePath)){
throw new Exception('Invalid target file.');
}
$this->data=$data;
$this->filePath=$filePath;
}
// save data to target file
public function save(){
if(!$fp=fopen($this->filePath,'w')){
throw new Exception('Error opening target file.');
}
if(!fwrite($fp,$this->data)){
throw new Exception('Error writing data to target file.');
}
fclose($fp);
}
// get target file via an accessor
public function getFilePath(){
return $this->filePath;
}
// get data via an accessor
public function getData(){
return $this->data;
}
}
As you can see, the signature of the above “DataSaver” class remains practically the same, with the exception of the level of visibility assigned to its respective $data and $filePath properties, since they’ve been declared private.
Obviously, this implies that the properties in question can only be accessed from inside the originating class, and any attempt to retrieve them from a different scope will result in a fatal error being triggered by the PHP interpreter.
This condition is clearly reflected by the following hands-on example:
try{
// create new instance of 'DataSaver' class
$dataSaver=new DataSaver('This string of data will be saved to a target file!','datafile.txt');
// save data to target file
$dataSaver->save();
// try to print value of private properties
echo 'Target file is the following : '.$dataSaver->filePath.'<br />';
echo 'Data for being saved to target file is the following : '.$dataSaver->data;
/* displays the following
Cannot access private property DataSaver::$filePath in path/to/file/
*/
}
catch(Exception $e){
echo $e->getMessage();
exit();
}
In the previous example, the private $data and $filePath properties are erroneously accessed from the global scope, which naturally made the PHP engine fire up a fatal error, as indicated above.
With this final example, I'll assume that you’re already armed with the required background to understand how to declare the level of visibility for the properties defined by a specific PHP 5 class. However, you can use all of the code samples included here to improve your existing skills in this crucial topic.
Final thoughts
Throughout this second part of the series, I provided you with an introductory guide to using private class properties in PHP 5. Nonetheless, there are some additional aspects of this subject that need to be explored in more detail, such as accessing private data members by way of subclasses and accessors.
But all of these interesting topics will be covered in the next part, so you don’t have any excuse to miss it!
| DISCLAIMER: The content provided in this article is not warranted or guaranteed by Developer Shed, Inc. The content provided is intended for entertainment and/or educational purposes in order to introduce to the reader key ideas, concepts, and/or product reviews. As such it is incumbent upon the reader to employ real-world tactics for security and implementation of best practices. We are not liable for any negative consequences that may result from implementing any information covered in our articles or tutorials. If this is a hardware review, it is not recommended to open and/or modify your hardware. |
/ 5 
