Helper Class in PHP

Question

I want create a helper class that containing method like cleanArray, split_char, split_word, etc.

The helper class it self will be used with many class. example :

Class A will user Helper, Class B, Class C, D, E also user Helper Class

what the best way to write and use helper class in PHP ?

what i know is basic knowledge of OOP that in every Class that use Helper class must create a helper object.

$helper = new Helper();

It that right or may be some one can give me best way to do that.

I also will create XXX Class that may use Class A, B, C, etc.

UPDATE : ->FIXED my fault in split_word method :D

Based on Saul, Aram Kocharyan and alex answer, i modified my code, but its dont work, i dont know why.

<?php
class Helper {
    static function split_word($text) {
        $array =  mb_split("\s", preg_replace( "/[^\p{L}|\p{Zs}]/u", " ", $text ));
        return $this->clean_array($array);
    }
    static function split_char($text) {
        return preg_split('/(?<!^)(?!$)/u', mb_strtolower(preg_replace( "/[^\p{L}]/u", "", $text )));
    }
}
?>

and i use in other Class

<?php
include "Helper.php";
class LanguageDetection {
    public function detectLanguage($text) {
        $arrayOfChar = Helper::split_char($text);
        $words = Helper::split_word($text);
        return $arrayOfChar;
    }
}
$i = new Detection();
print_r($i->detectLanguage("ab  cd    UEEef   する ح      خهعغ فق  12  34   ٢ ٣  .,}{ + _"));
?>

Answer 1

Helper classes are usually a sign of lack of knowledge about the Model's problem domain and considered an AntiPattern (or at least a Code Smell) by many. Move methods where they belong, e.g. on the objects on which properties they operate on, instead of collecting remotely related functions in static classes. Use Inheritance for classes that share the same behavior. Use Composition when objects are behaviorally different but need to share some functionality. Or use Traits.

The static Utils class you will often find in PHP is a code smell. People will throw more or less random functions into a class for organizing them. This is fine when you want to do procedural coding with PHP<5.2. As of 5.3 you would group those into a namespace instead. When you want to do OOP, you want to avoid static methods. You want your objects to have High Cohesion and Low Coupling. Static methods achieve the exact opposite. This will also make your code less testable.

• Are Helper Classes Evil?
• Killing the Helper class, part two
• Functional Decomposition AntiPattern
• Is the word "Helper" in a class name a code smell?

Moreover, every Class that use Helper class must create a helper object is a code smell. Your collaborators should not create other collaborators. Move creation of complex object graphs into Factories or Builders instead.

Answer 2

As a rule of thumb, helpers should contain functionality that is common but has no special designation under the overall architecture of the application.

• Suffix the classname with Helper
• Use static methods whenever possible

In short:

// Helper sample
//
class ConversionHelper {

   static function helpThis() {
      // code
   }

   static function helpThat() {
      // code
   }
}

// Usage sample
//
class User {

   function createThings() {
      $received = ConversionHelper::helpThis();
   }
}

Answer 3

Instead of creating static class , you should just write simple functions , and include that file at the index/bootstrap file (you can even use namespaces with it).

Instead of:

class Helper {
    static function split_word($text) { ...
    static function split_char($text) { ...
}

It should be:

namespace Helper;

function split_word($text) { ...
function split_char($text) { ...

There is no point wrapping it all up in a class. Just because you put it in a class doesn't make it object oriented .. actually it does the exact oposite.

Answer 4

You could create a class with static methods...

class Str {
   public static function split_char($str, $chr) {
      ...
   }
}

You could also namespace a bunch of functions with a namespace, but I think the former is preferred.

Answer 5

Use public static methods in the class as such:

/* Common utility functions mainly for formatting, parsing etc. */
class CrayonUtil {
    /*  Creates an array of integers based on a given range string of format "int - int"
     Eg. range_str('2 - 5'); */
    public static function range_str($str) {
        preg_match('#(\d+)\s*-\s*(\d+)#', $str, $matches);
        if (count($matches) == 3) {
            return range($matches[1], $matches[2]);
        }
        return FALSE;
    }
    // More here ...
}

Then invoke them like this:

CrayonUtil::range_str('5-6');

If in another file, use the following at the top:

require_once 'the_util_file.php';