page-carbajal / wpexpress

A WordPress Framework for Developers

WPExpress - A WordPress Framework for Software Developers

For all of you my fellow developers who are not familiar with WordPress.

Instead of trying to sell you into WordPress I'll ask you to do a google search for why wordpress.

Then do the same for other Content Management Systems, read a little, then decide what's better for you.

I will however tell you why I use WordPress to run my Websites.

WordPress powers +25% of the websites on the Internet. This means that 1 of every 4 websites are using it.

Some of the bennefits it gives me:

• Improved time to market
• Easily create Content Networks
• Thousands of themes free and premium
• Thousands of plugins free and premium
• It is already a great blogging platform
• Great UX
• BuiltIn API
• Runs on apache or nginx
• It runs 1/4 of the Internet's websites
• And it is Open Source

What is WPExpress

I like using frameworks like Rails, Laravel and Symfony.

They make me love writing code.

Very smart people wrote hundreds of thousands of lines of code to implement concepts such as Separation of Concern, Convention over Configuration and so on.

I love rake, and artisan. I am infatuated with how Symfony is structured as a set of components rather than a full fledged Framework.

And I also have a thing for composer, autoloading and depedency management.

Last but not least. I worship Mustache and Twig

When you get to know and work in environments as cool as those I have talked about, going back to monolite-style code writing is, HARD.

I found myself having to write similar code across different projects and I decided I wanted to focus on writing meaningful code and abstract the repetitive stuff as much as possible.

I wanted to go from this

$args = array();

$query = new WP_Query( $args );

wp_reset_post_data();

To this

$posts = Query::Posts->limit(10)->meta('field', 'value')->get();

I wanted to use composer, abstraction and chainable methods, and every other thing I love in modern PHP within WordPress. But here's the compromise. I do not want to change WordPress.

I do not want to write my own queries, I do not want to alter the core. I want WordPress to be kept intact. I just want a Framework which will allow me to do more with less.

Less configuration, less plugins, less time to market.

Finally I am writing this framework to allo my self to focus on writing meaningful code.

Quick Start

This small WordPress Frmework is designed to be easy to use.

Start by reading our documentation.

Framework Structure

• Database WPExpress\Query
  • Query
  • Post
  • Taxonomy
  • User
  • UserRole
• Model
  • BaseModel
  • BaseTaxonomy
  • BaseUser
  • BaseUserRole
  • BaseRelation May Be
• Contracts
  • BaseWordPressFilters (Maybe TBD)
• Admin
  • BaseSettingsPage
  • BaseWidget
  • BaseAPI
• UI WPExpress\UI
  • BaseResources
  • FieldCollection
  • MetaBoxCollection
  • HTMLFieldParser
  • RenderEngine
  • ReactJS (TBD)

wpexpress's Issues

SettingsPage feature is broken

When trying to create a new settings page the feature should not require the user to create a template. It should use the default included with the project.

add_rewrite_tag() on a non-object

This issue presents itself with this code

namespace MyNamespace\Model;


use WPExpress\Model\BaseModel;


class MyType extends BaseModel
{
    public function __construct( $bean = null )
    {
        $this->setPostTypeLabels(array(
            'name'          => __('My Types', 'tn_affillate_links'),
            'singular_name' => __('My Type', 'tn_affillate_links'),
        ));

        $this->setSupportedFeatures(true, true, true);

        $this->setPublic(false);

        parent::__construct($bean);

        $this->add_custom_fields();
    }

    private function add_custom_fields()
    {
        $this->fields->addTextInput('shortcode')->addLabel(__('Short Code', 'tn_affillate_links'));
        return $this;
    }

}

Post and Page classes are outdated

This classes included with the repo are outdated.

<?php


namespace WPExpress;


use WPExpress\Model\BaseModel;
use WPExpress\Model\BaseModelInterface;


final class Page extends BaseModel implements BaseModelInterface
{

    public function __construct( $bean )
    {

        $this->nameLabel           = 'Pages';
        $this->singularNameLabel   = 'Page';
        $this->postTypeDescription = 'Write your description here';
        $this->postTypeSlug        = 'page';

        $this->setSupportedFeatures(true, true, true);

        parent::__construct($bean);
    }

    /**
     * Override this function on your theme to set your Custom Post Type
     *
     * @return string. The custom post type.
     */
    public static function getPostType()
    {
        if( !isset( self::$postType ) ) {
            static::$postType = 'page';
        }
        return static::$postType;
    }

}

Add support for array in getByID();

getByID should be able to manage single value or array;

Empty postTypeSlug error

When the postType Label are set on the child class the postType label is empty.

BaseModel renderFields outdated

The renderFields Functionality is outdated. It implies The use of mustache. Refactor to use PHP

    public function renderFields( $post, $params )
    {
        $me = new static($post);

        // Auto Load Field Values
        $me->loadFieldValues();

        $templatePath = empty( $me->templatePath ) ? untrailingslashit(dirname(__FILE__)) . "/../../resources/templates" : $me->templatePath;
        $engine       = new RenderEngine($templatePath);
        $boxID        = $params['args']['currentMetaBox'];
        $fields       = $me->fields->parseFields($me->metaBoxes->box($boxID)->getFields());

        echo $engine->renderTemplate('metabox-content', $this->getMetaBoxContext($me, $fields));
    }

Add BaseModel setCapabilityType method

Property 'capability_type' is hard-coded to 'post'.

Add the method to enable changing it to page as well.

On settingsPage.class.php a line is missing.

addMyFields() ->setPageDescription($description) ->setPageTitle(__('Email Tool', 'mytextdomain')) ->registerPage('options'); } public function addMyFields() { $atts = array( 'style' => 'min-width: 400px;', 'readonly' => false ); $this->registerMetaField( 'idNumber', __( 'ID Number', 'mytextdomain' ), 'text', '', $atts ); $this->registerMetaField( 'title', __( 'Title', 'mytextdomain' ), 'text', '', $atts ); } ``` ###### # return $this; } // On your Setup File //// Register the Page $options = new MyOptions(); //// Retrieve option values $options->getValue('title');