Implementing my own utility functions in Lithium?

Question

I am a newbie to Lithium PHP and know the basics of Lithium. I want to implement my own Utility functions. I have created the utilities folder parallel to app\controllers. This is how my class looks like:

<?php

namespace app\utilities;

class UtilityFunctions {
    protected $_items = array(
            'a' => 'Apple',
            'b' => 'Ball',
            'c' => 'Cat'
        );

    //I get _items as undefined here, blame my poor OOP skills.
    public function getItem(alphabet) {
        return $this->_items[alphabet];
    }
}

?>

I use it in my controller as:

<?php

namespace app\controllers;

use \app\utilities\UtilityFunctions;

class MyController extends \lithium\action\Controller {
    public function index() {
        $args = func_get_args();
        $item = UtilityFunctions::getItem($args[0]);

        return compact('item');
    }
}

?>

Is this the right way to do it? Does my utility class need to extend something? Or does Lithium provide some other way to achieve this?

Moreover, I am not able to access the protected variable $_items in my getItems method. I had the same thing implemented in my controller and it worked fine then.

score 4 · Accepted Answer · answered Jul 08 '15 at 21:46

This is a fine way to do it. There are two core Lithium classes that you could extend from: \lithium\core\Object and \lithium\core\StaticObject

I think that is not necessary for your use case.

The reason you cannot access the protected variable is because you are invoking the method statically. You should probably rewrite your class to use static variables and methods. Also, I assume it's just a typo creating an example for StackOverflow, but you forgot the $ for the alphabet var in the getItem method.

<?php

namespace app\utilities;

class UtilityFunctions {
    protected static $_items = array(
        'a' => 'Apple',
        'b' => 'Ball',
        'c' => 'Cat'
    );

    public static function getItem($alphabet) {
        return static::_items[$alphabet];
    }
}

?>

The other option is to not change the UtilityFunctions class, but instead instantiate the class in the controller:

<?php

namespace app\controllers;

use app\utilities\UtilityFunctions;

class MyController extends \lithium\action\Controller {
    public function index() {
        $args = func_get_args();
        $utilities = new UtilityFunctions();
        $item = $utilities->getItem($args[0]);

        return compact('item');
    }
}

?>

For a simple case like this where the class does not need to hold any state, I would recommend the static methods. Take a look at the php manual for a little more info on the static keyword.

Another minor note, you do not need the leading backslash in your use statement.

Just to add to what rmarscher said, @Rutwick Gangurde - you should consider extending from StaticObject and Object as rmarscher pointed out. You can do some pretty cool things with filters in li3 (Google that). Also, consider using PHP Traits for your use case. — Housni, Jul 09 '15 at 10:08
Thanks rmarscher and @housni. It was a typo, been doing a lot of JavaScript these days hence forgot the $ sign. I followed the second approach by instantiating the class. I will read more upon the static keyword. — Rutwick Gangurde, Jul 09 '15 at 11:47

Implementing my own utility functions in Lithium?

1 Answers1