Add prefix to (classes) table/entity names by blieb · Pull Request #276 · cakephp/bake

blieb · 2016-09-19T13:49:12Z

We are working with multiple databases, to prevent name conflicts we have to prefix the names of the table/Entity classes.

I've added --model-prefix to add a prefix to the name of de classes.

example:
bin/cake bake model AccessTokens -c db_oauth --model-prefix oauth

stickler-ci · 2016-09-19T13:49:31Z

src/Shell/Task/ModelTask.php

        }
+
+        if (!empty($this->params['model-prefix'])) {
+	        $className = $this->_camelize($this->params['model-prefix']) . $className;


Spaces must be used to indent lines; tabs are not allowed

stickler-ci · 2016-09-19T13:49:34Z

src/Shell/Task/ModelTask.php

        }
+
+        if (!empty($this->params['model-prefix'])) {
+	        $className = $this->_camelize($this->params['model-prefix']) . $className;


Spaces must be used to indent lines; tabs are not allowed

dereuromark · 2016-09-19T13:54:04Z

Wouldn't --table-prefix be the more appropriate them here? After all this should only be relevant for finding the prefixed table in the DB schema.

blieb · 2016-09-19T14:02:33Z

@dereuromark This only adds a prefix to the files/classes not the database table itself.

it adds the prefix to both of the model parts. Table and Entity.

example: Table in database is 'accessTokens'

Model/Table/OauthAccessTokensTableTest.php
Model/Entity/OauthAccessToken.php

Not sure if --table-prefix is a correct name. Sounds more like a prefix to the table in the mysql database.

dereuromark · 2016-09-19T14:06:44Z

IMO it should be the other way around.
If a DB (for whatever legacy reason) has prefixed tables like foo_users, bake would not find it properly.
A --table-prefix foo_ would then find it and bake it as Users table and User entity and just set the manual $this->table('foo_users').

Why would you want it the other way around? That is where plugins and namespaces come into play.

blieb · 2016-09-19T14:17:48Z

I see there is an other pull request open for other way around.

I think making plugins for every database will be a little overkill and models are in a lot of different folders.

We have 2 databases with table 'products' in it. Thats why we have to prefix the class names.

thinkingmedia · 2016-09-19T16:17:41Z

Just to clarify. You have two databases with tables of the same name. So you want to differentiate between them?

I think using two plugins would be a better approach. A plugin for each database.

thinkingmedia · 2016-09-19T16:19:07Z

@blieb sorry, just read your last comment.

I think prefixing table classes conflicts with cakephp's naming conventions.

dereuromark · 2016-09-19T16:19:36Z

Most importantly you will need to different DB connections here.

blieb · 2016-09-19T16:39:19Z

We have a big project. Putting everything in a single database will be a mess.

We sell (our) products to our customers. Most of them are stores. One of the products is a webshop.
So the second database will have products of the stores.

(Today I shocked a little, we have 20+ databases that have to work with this project)

I believe cakephp does not have a good solution with working with multiple databases. It is possible. But I have to prefix the classes to prevent name conflicts.

inoas · 2016-09-19T16:55:35Z

you can set the prefix through $this->table('') within table classes I think.

dereuromark · 2016-09-19T16:56:49Z

I already told him that solution above.

blieb · 2016-09-19T17:10:19Z

@inoas i Dont have to prefix the tables in mysql but in cakephp to prevent classname conflicts.

inoas · 2016-09-19T19:48:07Z

You want to use Namespaces for that. But honestly. Plugins will give you namespaces and are exactly what you are looking for IMHO.

inoas · 2016-09-19T19:49:20Z

I am not saying this PR feature is bad btw...!

markstory

This new feature will need some tests before it can be merged. If you need help with the tests let me know.

markstory · 2016-09-19T19:49:40Z

src/Shell/Task/ModelTask.php

            return null;
        }
-        $name = $this->_entityName($model->alias());
+        $name = $this->_entityName((!empty($this->params['model-prefix'])?$this->_camelize($this->params['model-prefix']):'') . $model->alias());


You'll need to add spaces around the operators here.

markstory · 2016-09-19T19:50:19Z

src/Shell/Task/ModelTask.php

-        $name = $model->alias();
-        $entity = $this->_entityName($model->alias());
+        $name = (!empty($this->params['model-prefix'])?$this->_camelize($this->params['model-prefix']):'') . $model->alias();
+        $entity = $this->_entityName((!empty($this->params['model-prefix'])?$this->_camelize($this->params['model-prefix']):'') . $model->alias());


Can this repeated logic be extracted into a method?

Spaces also around operators, also.

blieb · 2016-09-21T08:46:59Z

the logic is now in apart function, and also added the spaces around operators.

Also fixed the relationships.
I have to jump in to the tests because I never created one yet :)

dereuromark · 2016-09-21T08:59:23Z

src/Shell/Task/ModelTask.php

+     * Get the prefix for model if exist.
+     *
+     * @return string
+     */


But does it need to be part of the public API here i wonder? It is only used internally here, right?

Oops need to be private? That's true, only used internally

protected, and no need to add it to the task list below.

blieb · 2016-10-03T12:43:41Z

@markstory tried to create a test. But for some reason it lost my params during 'bakeTable'. Do I miss something?

` /**
* test bake() with a -model-prefix param
*
* @return void
*/
public function testBakeTableWithModelPrefix()
{

    $this->Task->params['model-prefix'] = 'test';

    $filename = $this->_normalizePath(APP . 'Model/Table/TestBakeArticlesTable.php');
    $this->Task->expects($this->once())->method('createFile')
        ->with($filename, $this->stringContains('class TestBakeArticlesTable extends'));


    $model = TableRegistry::get('BakeArticles');
    $result = $this->Task->bakeTable($model);
    $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
}

`

markstory · 2016-10-04T20:08:53Z

@blieb Odd that is how the other tests work too.

stickler-ci · 2016-10-25T09:07:05Z