Yii where to put a custom global function?

Question

I created a is_home_page() function to detect if a user is on the homepage or not, but i'm not sure where i should put it so i can be used on all views and themes?

function is_home_page() {
    $app = Yii::app();
    return $app->controller->route == $app->defaultController;
}

Answer 1

create a file a MyClass.php inside components

You can write the static functions inside like

public static function is_home_page() {
        $app = Yii::app();
         return $app->controller->route == $app->defaultController;
     }

which can be accessed from any where like controller, Model or View as below

MyClass::is_home_page();

hope this will help you to write any number of functions globally and access them from anywhere

Answer 2

make a file helpers.php and put it inside components folder

protected
     |-components
         |-helpers.php

And add this line in the top of your config main.php file

require_once( dirname(__FILE__) . '/../components/helpers.php');

and inside that helpers.php write your function

<?php
     function is_home_page() {
        $app = Yii::app();
         return $app->controller->route == $app->defaultController;
     }

?>

Now this function is accessible in whole application directly call is_home_page() any where and it will return your value.

Answer 3

You may create class Globals with all helpers method. For example:

   class Globals{
       public function is_home_page() {
           $app = Yii::app();
           return $app->controller->route == $app->defaultController;
       }
   }

than in main.php section components set:

  'globals' => array(
       'class' => 'alias.to.location.Globals'
  )

than in code you may use this Yii::app()->globals->is_home_page()