{"id":107,"date":"2021-03-08T00:20:52","date_gmt":"2021-03-08T00:20:52","guid":{"rendered":"https:\/\/phptutorial.net\/?page_id=107"},"modified":"2025-04-07T11:30:07","modified_gmt":"2025-04-07T11:30:07","slug":"php-traits","status":"publish","type":"page","link":"https:\/\/www.phptutorial.net\/php-oop\/php-traits\/","title":{"rendered":"PHP Traits"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you will learn how to use PHP traits<\/strong> to share functionality across independent classes, which are not in the same inheritance hierarchy.<\/p>\n\n\n\n

Introduction to PHP traits #<\/a><\/h2>\n\n\n\n

Code reuse is one of the most important aspects of object-oriented programming. In PHP, you use inheritance <\/a>to enable code reuse in different classes with the same inheritance hierarchy. <\/p>\n\n\n\n

To achieve code reuse, you move the common functionality of classes to methods of the parent class. However, inheritance makes the code very tightly coupled. Therefore, overuse of inheritance may cause the code very hard to maintain.<\/p>\n\n\n\n

To overcome this problem, PHP 5.4 introduced a new reusable unit of code called trait<\/code>.<\/em> Traits allow you to reuse various methods freely in many different classes that do not need to be in the same class hierarchy.<\/p>\n\n\n\n

Inheritance allows classes to reuse the code vertically while the traits allow classes reuse the code horizontally.<\/p>\n\n\n\n

A trait is similar to a class, <\/a>but it is only for grouping methods in a fine-grained and consistent way. PHP does not allow you to create an instance of a Trait like an instance of a class. And there is no such concept of an instance of a trait.<\/p>\n\n\n\n

PHP Trait example #<\/a><\/h2>\n\n\n\n

To define a trait, you use the trait keyword followed by a name as follows:<\/p>\n\n\n

<?php<\/span>\n\ntrait<\/span> Logger\n{\n\tpublic<\/span> function<\/span> log<\/span>($msg)<\/span>\n\t<\/span>{\n\t\techo<\/span> '<pre>'<\/span>;\n\t\techo<\/span> date('Y-m-d h:i:s'<\/span>) . ':'<\/span> . '('<\/span> . __CLASS__<\/span> . ') '<\/span> . $msg . '<br\/>'<\/span>;\n\t\techo<\/span> '<\/pre>'<\/span>;\n\t}\n}\n<\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
To use a trait in a class, you use the use<\/code> keyword. All the trait’s methods are available in the class where it is used. Calling a method of a trait is similar to calling an instance method.<\/p>\n\n\n\n
The following example demonstrates how to use the Logger<\/code> trait in the BankAccount<\/code> class:<\/p>\n\n\n
class<\/span> BankAccount<\/span>\n<\/span>{\n\tuse<\/span> Logger<\/span>;\n\n\tprivate<\/span> $accountNumber;\n\n\tpublic<\/span> function<\/span> __construct<\/span>($accountNumber)<\/span>\n\t<\/span>{\n\t\t$this<\/span>->accountNumber = $accountNumber;\n\t\t$this<\/span>->log(\"A new $accountNumber bank account created\"<\/span>);\n\t}\n}\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
And you can reuse the Logger<\/code> trait in the User<\/code> class as follows:<\/p>\n\n\n
class<\/span> User<\/span>\n<\/span>{\n\tuse<\/span> Logger<\/span>;\n\n\tpublic<\/span> function<\/span> __construct<\/span>()<\/span>\n\t<\/span>{\n\t\t$this<\/span>->log('A new user created'<\/span>);\n\t}\n}\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Both BankAccount<\/code> and User<\/code> classes reuse methods of the Logger<\/code> trait, which is very flexible.<\/p>\n\n\n\n
Using multiple traits #<\/a><\/h2>\n\n\n\n
A class can use multiple traits. The following example demonstrates how to use multiple traits in the IDE class. It simulates the C compilation model in PHP for the sake of demonstration.<\/p>\n\n\n
<?php<\/span>\n\ntrait<\/span> Preprocessor\n{\n\tpublic<\/span> function<\/span> preprocess<\/span>()<\/span>\n\t<\/span>{\n\t\techo<\/span> 'Preprocess...done'<\/span> . '<br\/>'<\/span>;\n\t}\n}\ntrait<\/span> Compiler\n{\n\tpublic<\/span> function<\/span> compile<\/span>()<\/span>\n\t<\/span>{\n\t\techo<\/span> 'Compile code... done'<\/span> . '<br\/>'<\/span>;\n\t}\n}\n\ntrait<\/span> Assembler\n{\n\tpublic<\/span> function<\/span> createObjCode<\/span>()<\/span>\n\t<\/span>{\n\t\techo<\/span> 'Create the object code files... done.'<\/span> . '<br\/>'<\/span>;\n\t}\n}\n\ntrait<\/span> Linker\n{\n\tpublic<\/span> function<\/span> createExec<\/span>()<\/span>\n\t<\/span>{\n\t\techo<\/span> 'Create the executable file...done'<\/span> . '<br\/>'<\/span>;\n\t}\n}\n\nclass<\/span> IDE<\/span>\n<\/span>{\n\tuse<\/span> Preprocessor<\/span>, Compiler<\/span>, Assembler<\/span>, Linker<\/span>;\n\n\tpublic<\/span> function<\/span> run<\/span>()<\/span>\n\t<\/span>{\n\t\t$this<\/span>->preprocess();\n\t\t$this<\/span>->compile();\n\t\t$this<\/span>->createObjCode();\n\t\t$this<\/span>->createExec();\n\n\t\techo<\/span> 'Execute the file...done'<\/span> . '<br\/>'<\/span>;\n\t}\n}\n\n$ide = new<\/span> IDE();\n$ide->run();\n<\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Composing multiple traits #<\/a><\/h2>\n\n\n\n
PHP allows you to compose multiple traits into a trait by using the use<\/code> statement in the trait’s declaration. For example:<\/p>\n\n\n
<?php<\/span>\n\ntrait<\/span> Reader\n{\n\tpublic<\/span> function<\/span> read<\/span>($source)<\/span>\n\t<\/span>{\n\t\techo<\/span> sprintf('Read from %s <br>'<\/span>, $source);\n\t}\n}\n\ntrait<\/span> Writer\n{\n\tpublic<\/span> function<\/span> write<\/span>($destination)<\/span>\n\t<\/span>{\n\t\techo<\/span> sprintf('Write to %s <br>'<\/span>, $destination);\n\t}\n}\n\ntrait<\/span> Copier\n{\n\tuse<\/span> Reader<\/span>, Writer<\/span>;\n\n\tpublic<\/span> function<\/span> copy<\/span>($source, $destination)<\/span>\n\t<\/span>{\n\t\t$this<\/span>->read($source);\n\t\t$this<\/span>->write($destination);\n\t}\n}\n\nclass<\/span> FileUtil<\/span>\n<\/span>{\n\tuse<\/span> Copier<\/span>;\n\n\tpublic<\/span> function<\/span> copyFile<\/span>($source, $destination)<\/span>\n\t<\/span>{\n\t\t$this<\/span>->copy($source, $destination);\n\t}\n}\n<\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
How it works.<\/p>\n\n\n\n
Try it<\/a><\/p>\n\n\n\n