How to load models from another CakePHP application

CakePHP is great for administering database relations (tables), something like using PhpMyAdmin. But PhpMyAdmin lacks the ability to associate relations together. Admin interfaces to manage relations through associations are therefore better done using CakePHP 1.2.

However, to create an administrative application on top of your main CakePHP application is just messy and hard to maintain. One of CakePHP’s most powerful feature is scaffolding where you could declare:

[code lang=”php”][/code]

…and all controllers would have scaffolding. Unfortunately, we can’t do such magic on our deployed application. So that leaves us with only one way – make a CakePHP 1.2 Admin application that loads models from our Main application.

In summary, we did this:

  1. Create a new application called ‘admin’ to load the database and models from our existing application ‘main’.
  2. Load the models and do scaffolding.
  3. Create a simple page to link to all our scaffold views.

Ultimately, we want to maintain the admin interface as little as possible. The main application should not have changes in code.

0. Structure for this example

My models are Student, Classroom and Teacher since I like school. Here’s my rough folder structure:

/trunk/admin

  • /config
  • /controllers
  • /views
  • /webroot
  • app_controller.php
  • index.php

/trunk/main

  • /config
  • /controllers
  • /models
    – classroom.php
    – student.php
    – teacher.php
  • /views
  • /webroot
  • app_controller.php
  • index.php

1. Bootstrapping in Admin

Edit the Admin ‘bootstrap.php’ in /trunk/admin/config/ to load models from Main application. I’m using Windows Vista, that’s why the C drive.

[code lang=”php”]modelPaths = array($main_app, $main_app_models);

// Models to be loaded, we will use this again
Configure::write(“ModelsToLoad”, array(
“Classroom”,
“Student”,
“Teacher”,
));
// import the models
App::import(“Model”, Configure::read(“ModelsToLoad”));
?>[/code]

Previously in CakePHP 1.1, there is loadModel but that has been deprecated in favor of App::Import(‘Model’, $models);.

Also, make sure you have ‘app_model.php’ in your /trunk/main/, i.e. your Main application:

[code lang=”php”][/code]

2. Getting our database configuration

We wouldn’t want to maintain another database.php, so the Admin will use Main application’s database settings. Editing Admin’s database.php:

[code lang=”php”][/code]

Now we’ll have our models nicely loaded.

3. Setting up Admin’s controllers

We can create a file called ‘app_controller.php’ and place it on /trunk/admin/. We scaffold every controller:

[code lang=”php”][/code]

And we create our three controllers – classroom_controller.php, student_controller.php and teacher_controller.php. It looks like this inside classroom_controller.php:

[code lang=”php”][/code]

4. The Admin is done

Now, go to your Admin application to see your classrooms. Mine is at http://localhost:7171/classrooms/

If everything is done correctly, you should see your admin interface with the default CakePHP theme.

5. Setup the Admin homepage

There’s nothing at the homepage, let’s put links to our views. Remember that we write the configuration ‘ModelsToLoad’ earlier on? Now it’s time to use it.

Create a file called ‘home.ctp’ in /trunk/admin/views/pages/home.ctp. And throw in the following codes:

[code lang=”php”]

Listing all available models

  • link($model, “/”.low($model).”s”); ?>

[/code]

The above reads from the array of models and make links for easy access from the homepage.

[ad#highlight]

Conclusion

Although this looks complicated, but it’s quite easy to set up. When you have a new model, add it to ‘ModelsToLoad’ and create the corresponding controller for it. This post is originally titled “How to create a CakePHP admin inteface by loading models from an existing CakePHP application” but that is just too long. I couldn’t locate a guide on using App::import() and how models can be loaded from external applications so I had to look at Cake’s code. Due to limitations of my WordPress plugins, I had to use double quotes instead of single quotes in all my PHP codes.

Once again, CakePHP’s scaffolding is a wonderful feature. Take some time to play with it, the rewards are tremendous.

CakePHP’s built-in Pages Controller

CakePHP 1.2 comes with in built PagesController which helps you easily create static pages. It’s easy to set up, you just have to put your pages view in /views/pages/. All the codes are for routes.php.

[code lang=”php”] ‘pages’, ‘action’ => ‘display’, ‘home’));
?>[/code]

The page title ($pageTitle) would be ‘Home’ for the above.

If you want your URL to be /about/my-company, you can do the following:

[code lang=”php”] ‘pages’,
‘action’ => ‘display’,
‘about’,
‘my_company’,
)
);
?>[/code]

The page title would be ‘My Company’ this time since underscores are converted to spaces. Pretty useful.

How to get the controller’s action name from the view

You know sometimes, in CakePHP’s views, it is useful to check what is the controller’s action. It is quite useful when it comes to implementing selected tabs.

You can use the following expression to get the action name from your view:

[code lang=”php”]$this->controller->action[/code]

The following is a usage example:

[code lang=”php”]< ?php /* This is a view element file - nav_messages.thtml */ ?>
< ?php $s = $this->controller->action; ?>

  • Inbox
  • Sentbox

[/code]

[ad#highlight]

“messages_inbox” and “messages_sentbox” is the name of the action (function) in my controller. Continue reading “How to get the controller’s action name from the view”