{"id":14175,"date":"2011-08-17T21:33:08","date_gmt":"2011-08-17T21:33:08","guid":{"rendered":"https:\/\/wordpress.org\/plugins-wp\/posttypebuilder\/"},"modified":"2012-01-23T02:14:00","modified_gmt":"2012-01-23T02:14:00","slug":"posttypebuilder","status":"closed","type":"plugin","link":"https:\/\/wordpress.org\/plugins\/posttypebuilder\/","author":253893,"comment_status":"closed","ping_status":"closed","template":"","meta":{"version":"0.5","stable_tag":"0.5","tested":"3.3.2","requires":"3.0","requires_php":"","requires_plugins":"","header_name":"PostTypeBuilder","header_author":"Bj\u00f6rn Ali G\u00f6ransson","header_description":"","assets_banners_color":"","last_updated":"2012-01-23 02:14:00","external_support_url":"","external_repository_url":"","donate_link":"","header_plugin_uri":"","header_author_uri":"http:\/\/www.bedr.se\/","rating":0,"author_block_rating":0,"active_installs":10,"downloads":1182,"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description"],"tags":[],"upgrade_notice":[],"ratings":{"1":0,"2":0,"3":0,"4":0,"5":0},"assets_icons":[],"assets_banners":[],"assets_blueprints":{},"all_blocks":[],"tagged_versions":["0.1","0.2","0.3","0.4","0.5"],"block_files":[],"assets_screenshots":{"screenshot-1.png":{"filename":"screenshot-1.png","revision":"1566888","resolution":"1","location":"plugin"}},"screenshots":{"1":"Automatic form field generation of first and second example (in the description tab)"}},"plugin_section":[],"plugin_tags":[50482,1241,153,24388,50481],"plugin_category":[59],"plugin_contributors":[97724],"plugin_business_model":[],"class_list":["post-14175","plugin","type-plugin","status-closed","hentry","plugin_tags-bornemix","plugin_tags-class","plugin_tags-database","plugin_tags-orm","plugin_tags-posttypebuilder","plugin_category-utilities-and-tools","plugin_contributors-bornemix","plugin_committers-bornemix"],"banners":[],"icons":{"svg":false,"icon":"https:\/\/s.w.org\/plugins\/geopattern-icon\/posttypebuilder.svg","icon_2x":false,"generated":true},"screenshots":[{"src":"https:\/\/ps.w.org\/posttypebuilder\/trunk\/screenshot-1.png?rev=1566888","caption":"Automatic form field generation of first and second example (in the description tab)"}],"raw_content":"\n

PostTypeBuilder is an Object Relational Mapper connecting directly into the Wordpress engine, and provides handy scaffolding through the Wordpress GUI, as well as data querying<\/em> similar to LINQ and ActiveRecord (Book::find()->where(...)).<\/p>\n\n

class Book extends Entity{\n    \/** @Property *\/\n    public $number_of_pages;\n}\n\n\n\nwhile(have_posts()){\n    the_post(); $book = new Book($post);\n\n    echo \"<dt>\" . $book->post_title . \"<\/dt>\";\n    echo \"<dd>\" . $book->number_of_pages . \"<\/dd>\";\n}\n<\/code><\/pre>\n\n
Included is the Addendum<\/a> library to support @annotations.<\/p>\n\n
This plugin saves no information on your system (no database tables, no temporary files). All information is supplied by you in your class files.<\/p>\n\n
See Other notes<\/a> for more info<\/em><\/p>\n\n
Register classes<\/h4>\n\n
Any classes in wp-content\/classes<\/code>, where the filename (like class_name.php<\/code>) corresponds to the classname (like ClassName<\/code>), will be registered as a Wordpress Custom Post Type.<\/p>\n\n
Following example needs to be defined in wp-content\/classes\/book.php<\/code>, and results in a registered post type being shown in the admin UI (but not publicly queryable):<\/p>\n\n
namespace MyEntities;\nuse \\PostTypeBuilder\\Entity;\n\nclass Book extends Entity{\n}\n<\/code><\/pre>\n\n
See Other notes<\/a> for more info<\/em><\/p>\n\n
Define properties<\/h4>\n\n
Any class properties prefixed by the annotational comment \/** @Property *\/<\/code> will be registered as Wordpress metadata, and form fields will appear in the edit\/create screen of the post type corresponding to the property type.<\/p>\n\n
Following example, building on the previous Book<\/code> example class, will display a text form field in the edit\/create post screen:<\/p>\n\n
namespace MyEntities;\nuse \\PostTypeBuilder\\Entity;\n\nclass Book extends Entity{\n    \/** @Property *\/\n    public $number_of_pages;\n}\n<\/code><\/pre>\n\n
To enable the property to carry multiple values, use the = array()<\/code> assignment:<\/p>\n\n
\/** @Property *\/\npublic $authors = array();\n<\/code><\/pre>\n\n
See Other notes<\/a> for more info<\/em><\/p>\n\n
Find entities<\/h4>\n\n
You can load entities in three ways.<\/p>\n\n
(1) By post ID:<\/p>\n\n
$book = new Book(21);\n<\/code><\/pre>\n\n
(2) By post object (useful in the loop):<\/p>\n\n
global $post;\n\n$book = new Book($post);\n<\/code><\/pre>\n\n
(3) By query:<\/p>\n\n
$books = Book::find()->where(\"pages > (NUMERIC)\", 10);\n\nforeach($books as $book){ ... }\n<\/code><\/pre>\n\n
(Note that the query is executed lazily - ie. at the foreach statement)<\/p>\n\n
Following code shows how to manipulate your entities:<\/p>\n\n
$book = new Book();\n$book->post_title = \"Foo\";\n$book->save();\n<\/code><\/pre>\n\n
(Both post_object members and class properties are accessed in a unified way, but class properties have precedence)<\/p>\n\n
See Other notes<\/a> for more info<\/em><\/p>\n\n
Extend the functionality<\/h4>\n\n
The plugin is designed to be extensible, so you can override form field generation for your classes, text representations (by overriding __toString), add your own property types, their form field generation, their text representation, you can hook into save events (and more...).<\/p>\n\n
Register classes<\/h3>\n\n
At Wordpress initialization stage, when an HTTP request is made, PostTypeBuilder searches wp-content\/classes<\/code> for PHP files.<\/p>\n\n
Each file is then included, and PostTypeBuilder determines if class \\MyEntities\\\u03b1<\/code> was defined as a result of that inclusion. MyEntities<\/code> is the required namespace where you need to define your entities, and \u03b1<\/code> is the filename converted to CamelCase.<\/p>\n\n
For example, if file wp-content\/classes\/newsletter_issue.php<\/code> exists, PostTypeBuilder will include that and then check if the class \\MyEntities\\NewsletterIssue<\/code> exists.<\/p>\n\n
To change the default namespace, define POSTTYPEBUILDER_ENTITIES_NAMESPACE before PostTypeBuilder gets ahold of it.<\/em><\/p>\n\n
Options<\/h4>\n\n
There are a number of options available (defined in annotations.php<\/code>):<\/p>\n\n