Skip to content

Latest commit

 

History

History
125 lines (95 loc) · 5.11 KB

workflow.md

File metadata and controls

125 lines (95 loc) · 5.11 KB
Raw

Workflow

The Workflow extension is an example of a Horizontal Component. It adds states to entities:

  • Published
  • Unpublished
  • Archived
  • Trashed

This document demonstrates, how the Article Vertical Component gets the functionality automatically.

Preparation

Install the demo. Check out the master branch, and enter

$ composer install
$ docker-compose up -d
$ ./install.sh

on the console. This will install a couple of components, and register their entities.

Joomla! installation expected in your/path/to/joomla-pythagoras
 - installing extensions/Article
   - Article
 - installing libraries/incubator/Media
   - Image
 - installing libraries/incubator/PageBuilder
   - Content
   - Layout
   - Page
   - Template
 - finishing
Installed 3 extension(s)

Testing

Without Workflow

Console

Now, select the blog articles:

$ ./joomla show articles --dump-sql --filter="category=blog"

You'll see a list of articles, and also an SQL dump.

+----+----------------+----------+------------------+--------------------------------+----------------------------------+------------+---------+-----------+
| id | title          | category | alias            | teaser                         | body                             | author     | license | parent_id |
+----+----------------+----------+------------------+--------------------------------+----------------------------------+------------+---------+-----------+
| 1  | First Article  | blog     | first-article    | Look at the first example      | This first example is cool       | John Doe   | CC      | 0         |
| 2  | Second Article | blog     | second-article   | Look at another example        | This provides child elements     | Doctor     | CC      | 0         |
| 3  | Part One       | blog     | second-article-1 | No. 1 of 2. article's children | This is the first child element  | Rose Tyler | CC      | 2         |
| 4  | Part Two       | blog     | second-article-2 | No. 2 of 2. article's children | This is the second child element | Doctor     | CC      | 2         |
+----+----------------+----------+------------------+--------------------------------+----------------------------------+------------+---------+-----------+
+---+----------------------------+----------+
| # | SQL                        | Time     |
+---+----------------------------+----------+
| 1 | SELECT * FROM articles a   | 0.760 ms |
|   |   WHERE a.category = blog  |          |
|   |   LIMIT -1 OFFSET 0        |          |
|   |                            |          |
+---+----------------------------+----------+

Please notice, that the Article Vertical Component does not know anything about states.

Browser

Navigate your browser to http://localhost:8080. The demo start page will appear. In the menu, select 'Blog'. You'll see a blog view of the same articles, you selected on the console before. Also have a look on the 'About' page - that page will change, once the Workflow component is installed.

With Workflow

Next, install the Workflow Horizontal Component:

$ ./joomla install extensions/Workflow

The installer acknowledges

Installed 1 extension(s)

Console

When you repeat the joomla show command in the console, the result changes:

$ ./joomla show articles --dump-sql --filter="category=blog"
+----+----------------+----------+----------------+-------------------------+------------------------------+--------+---------+-----------+
| id | title          | category | alias          | teaser                  | body                         | author | license | parent_id |
+----+----------------+----------+----------------+-------------------------+------------------------------+--------+---------+-----------+
| 2  | Second Article | blog     | second-article | Look at another example | This provides child elements | Doctor | CC      | 0         |
+----+----------------+----------+----------------+-------------------------+------------------------------+--------+---------+-----------+
+---+-----------------------------------------------------+----------+
| # | SQL                                                 | Time     |
+---+-----------------------------------------------------+----------+
| 1 | SELECT * FROM articles a                            | 0.814 ms |
|   |   INNER JOIN states_entities b ON a.id=b.entity_id  |          |
|   |   WHERE (a.category = blog)                         |          |
|   |     AND (b.state_id=1)                              |          |
|   |   LIMIT -1 OFFSET 0                                 |          |
|   |                                                     |          |
+---+-----------------------------------------------------+----------+

Still, the Article component is not aware of the Workflow component, but the query has been modified to only return published articles (state_id=1).

Note: Currently, you can't filter by arbitrary state. We're working on it!

Browser

Navigate to the blog again as before. As you can see, only the published blog post is shown. On the 'About' page you will discover additional output above the article.