zeeshanu/yell

A php package that yells when you try to access a property that doesn't exist in a class!

:loudspeaker: Yell

, _(*1)

PHP package to make your objects strict and throw exception when you try to access or set some undefined property in your objects., _(*2)

Requirement

PHP >= 5.4.0., _(*3)

Installation

You can install the library using the following ways:, _(*4)

Using Composer

You can install this through Composer, a dependency manager for PHP. Just run the below command:, _(*5)

composer require zeeshanu/yell

For further details you can find the package at Packagist., _(*6)

Manual way

• Copy src to your codebase, perhaps to the vendor directory.
• Add the Zeeshanu\Yell\Scream class to your autoloader or require the file directly.

Getting Started

I'm going to create take an example to demonstrate the usage., _(*7)

For example, you have a Person class like below:, _(*8)

class Person
{
    public $name;
    public $age;
}

$person = new Person();

$person->name = 'John Doe';
$person->age = 23;

// Will silently set the property `profession` on `Person` without any issue 
$person->profession = 'Teacher';

Here is how you can make your object strict i.e. not allow any other properties except $name and $age and throw exceptions for any other properties. Just use Zeeshanu\Yell\Scream trait in your class as follows, _(*9)

use Zeeshanu\Yell\Scream;

class Person
{
    use Scream;

    public $name;
    public $age;
}

$person = new Person();

$person->name = 'John Doe';
$person->age = 23;

// An exception will be thrown when showing message "Trying to set undefined property $profession in class Person"  
$person->profession = 'Teacher';

Feedback

If you notice that there might be some improvements in code you can create a pull request or report an issue. You can also contact me at ziishaned@gmail.com., _(*10)

License

The MIT License (MIT). Please see License File for more information., _(*11)