The Known framework has the ability to execute commands from the console, which is kind of cool and enables, among other things, stuff like these console development tools.

You can see what commands are currently available by going to the console, navigate to your Known directory, and execute ./known.php.

The commands available can be added to in two ways…

Create a pure console plugin

If you look in ConsolePlugins you’ll see a plugin called Example, which probably tells you all you need to know.. but in summary:

  • Create a subdirectory for your plugin in ConsolePlugins (or at least copy/symlink it there later)
  • Create a Main.php file, containing a class called Main which extends the class \Idno\Common\ConsolePlugin
  • Implement the abstract methods:
    • getCommand() the command name you are providing
    • getDescription() the description of the command
    • getParameters() a method returning an array of the command’s parameters
    • execute() your actual code

And you’re done!

Add a console plugin to a regular Known plugin

If you’re using the most recent build of Known from github, you can also add a console command to an existing traditional Known plugin (i.e. those sitting in IdnoPlugins/*). To do this, create a class called ConsoleMain that extends \Idno\Common\ConsolePlugin and save it in a file called ConsoleMain.php sitting along side your regular Main.php.

I’ve been doing a lot of development work recently for clients based on Known which involve, among other things, needing to do fairly involved things with data and ACLs.

Because of this, I was finding myself spending a lot of time trying to see what was actually written to entities by looking at the raw database. This was rather time consuming, and because of Known’s (very flexible but abstract) data model, was rather tricky.

So, I took advantage of Known’s console interface (which I fixed and extended in a recent pull request), to start putting together a collection of useful tools. To use, simply symlink to the appropriate directory from within you ConsolePlugins directory.

Be aware that you will need the current latest version of Known core from Github.

» Visit the project on Github...

A big piece of functionality that people have been asking for in Known (and that I actually needed to start building out for some client work), was the ability to add a “draft” published status on a post, which was separate from “PRIVATE” in an ACL context.

To start building this out I introduced the concept of publish_status (defaulting to “published”) on an Entity. Originally I implemented this as a piece of metadata, however since this had issues with filtering queries by “NOT ‘draft'” owing to this bug, I’m proposing a new pull request which implements the same functionality as a collection level schema change.

This obviously requires some DB patches to be applied, but it is both more efficient and more flexible.