Keywords

Keywords are the same as what other systems would call Tags. We have Tags already, so we call them Keywords. They are used in the core to add META Keywords to your pages and to add Keywords to blog articles.

Using Keywords in your modules

Simply add a char(32) field to your database. This stored the MD5 string that represents the combination of keywords that were used.

In the above example, Keywords::process('foo, bar, baz') takes a comma separated string of keywords and converts them into a MD5 string, which is a unique hash for the combination of keywords being used.

Schema

Each keyword will be taken and stored in a table called "default_keywords", which makes the table smaller and makes counting popular words easier.

+-------+------------------+------+-----+---------+----------------+
| Field | Type             | Null | Key | Default | Extra          |
+-------+------------------+------+-----+---------+----------------+
| id    | int(10) unsigned | NO   | PRI | NULL    | auto_increment |
| name  | varchar(50)      | NO   |     | NULL    |                |
+-------+------------------+------+-----+---------+----------------+

They will then be linked in "default_keywords_applied" with the keyword hash as a unique identifier against each keyword_id.

+------------+------------------+------+-----+---------+----------------+
| Field      | Type             | Null | Key | Default | Extra          |
+------------+------------------+------+-----+---------+----------------+
| id         | int(10) unsigned | NO   | PRI | NULL    | auto_increment |
| hash       | char(32)         | NO   |     | NULL    |                |
| keyword_id | int(10) unsigned | NO   |     | NULL    |                |
+------------+------------------+------+-----+---------+----------------+

Displaying Keywords

You can return an array or a string of the keywords with the following methods:

Keywords::get_array($hash); // returns in format:

Array (
  [0] => keyword_1,
  [1] => keyword_2,
  [2] => keyword_3
)


Keywords::get_string($hash); // returns as concatinated string

"keyword_1, keyword_2, keyword_3"

For more on usage see the API Documentation: Keywords.