• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
BAD Beans
 

BAD Beans

on

  • 1,546 views

Neil Hastings' presentation on the Bean Module. (As Treehouse Agency)

Neil Hastings' presentation on the Bean Module. (As Treehouse Agency)

Statistics

Views

Total Views
1,546
Views on SlideShare
1,546
Embed Views
0

Actions

Likes
0
Downloads
2
Comments
0

0 Embeds 0

No embeds

Accessibility

Upload Details

Uploaded via as Apple Keynote

Usage Rights

CC Attribution-NoDerivs LicenseCC Attribution-NoDerivs License

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment
  • \n
  • \n
  • Beans are Block Entities.\nWhat does BEAN stand for.\n
  • Beans are Block Entities.\nWhat does BEAN stand for.\n
  • Beans are Block Entities.\nWhat does BEAN stand for.\n
  • Before we talk about what beans really are, let’s talk about why we created beans.\n
  • This site was going to have hundreds of blocks, which needed to be created by normal CMS users. How do we allow users to create blocks without granting them administrative access?\n
  • After evaluating the designs, we came up with 2 main types of user generated blocks.\n
  • Here we see 2 “Graphic” blocks. If these were nodes, we would immediately know how to build these. A title, an image field with a link, some body text. Then we style the template, or perhaps if the template isn’t too complicated, we just select the appropriate field formatters for this view mode. But these aren’t nodes, they’re blocks.\n
  • Here is are the listing blocks.\nThat’s what let us to create Beans\nThe “BLOG” bean we will be creating later\n
  • That’s what led us to create Beans\n
  • Ctypes but with Blocks\nBlock types are ctools based plugins\nBlock types are entity bundles\nEntity API module adds views, actions and rules integration\n\n
  • Bean exposes blocks as a new type of fieldable entity.  Creating new block types and adding fields is as easy as creating new node types (screenshot of block type admin).  Use the display settings for the blocks to control the display output, just like with other fieldable entities (screenshot of “display fields” tab).\n\n
  • \n
  • API First\n- Early versions of BEAN had no way of creating block types in the UI\nEvery plugin is a type\nBlock Placement\n- Config if context/block admin\n- Content if block reference/panels\n
  • API First\n- Early versions of BEAN had no way of creating block types in the UI\nEvery plugin is a type\nBlock Placement\n- Config if context/block admin\n- Content if block reference/panels\n
  • API First\n- Early versions of BEAN had no way of creating block types in the UI\nEvery plugin is a type\nBlock Placement\n- Config if context/block admin\n- Content if block reference/panels\n
  • Let’s make a view Block for a listing of blog post. There are 3 different view modes for each node listing. The user needs to be able to select how many of each type of view mode will be used. The user will also select content filter settings.\n
  • All modules just implement hook_bean_types_api_info\nhook_ctools_plugin_direcory is optional but recommended.\n
  • Define a Ctools plugin\nIf you are doing a bean with only fields, you can use bean_default as the “class” with no need for “file” or “path”\n
  • \n
  • \n
  • Notice the groups of settings. These help make logical breaks.\nFilters for Content\nView settings per view mode\nMore link for entire block\n
  • Notice the groups of settings. These help make logical breaks.\nFilters for Content\nView settings per view mode\nMore link for entire block\n
  • Notice the groups of settings. These help make logical breaks.\nFilters for Content\nView settings per view mode\nMore link for entire block\n
  • This is just a sample. Just uses standard Form API\n$bean is fully loaded with defaults so no need to check for existence\nTalk about the $bean->more_link[‘text’].\n
  • Common to use Entity Field Query to create dataset.\n$bean is fully loaded\n$content is the rendered content array up to now. Includes fields\nView mode is not used yet - Oh wait, as of yesterday they are!!\n\n
  • EntityFieldQuery is awesome\nEnergyEntityFieldQuery\n- Defaults Group\n- Published\n- Easily handle topic vocab\n
  • Using the theme function “energy_blog_list”\nnodes\nmore_link\nitems_per_page passed\n
  • Using the theme function “energy_blog_list”\nnodes\nmore_link\nitems_per_page passed\n
  • Using the theme function “energy_blog_list”\nnodes\nmore_link\nitems_per_page passed\n
  • Uses view modes to render the article nodes per the 3 different settings groups\nTalk block placement\n\n
  • Here’s a quick recipe that we used a lot on the site. It is very easy to implement and your users will love it.\n
  • \n

BAD Beans BAD Beans Presentation Transcript

  • Beans, Beans - They’reGood For Your... EditorsBADcamp 2011October 22nd, 2011Neil Hastings
  • BEANSNeil Hastings‣ Senior Engineering‣ Treehouse Agency‣ Drupal.org member for 3 years and 34 weeks‣ @indytechcook BADcamp 2011, Neil Hastings
  • BEANSWhat is a BEAN? BADcamp 2011, Neil Hastings
  • BEANSWhat is a BEAN?‣ Block Entity BADcamp 2011, Neil Hastings
  • BEANSWhat is a BEAN?‣ Block Entity‣ BEAN Entities Aren’t Nodes ‣ BEAN Entities Aren’t Nodes ‣ BEAN Entities Aren’t Nodes ‣ BEAN Entities Aren’t Nodes ‣ BEAN Entities Aren’t Nodes BADcamp 2011, Neil Hastings
  • BEANSWhat is a BEAN?‣ Block Entity‣ BEAN Entities Aren’t Nodes ‣ BEAN Entities Aren’t Nodes ‣ BEAN Entities Aren’t Nodes ‣ BEAN Entities Aren’t Nodes ‣ BEAN Entities Aren’t Nodes‣ A Healthy Way for users to Create Blocks BADcamp 2011, Neil Hastings
  • Blocks on Energy.gov
  • BEANSBlock Creator !=Administrator BADcamp 2011, Neil Hastings
  • BEANSUser generated Blocks‣ Node-like blocks ‣ Fields ‣ Templates‣ Listing blocks ‣ User-defined filters ‣ Pre-defined styles BADcamp 2011, Neil Hastings
  • screenshot of listingblock example, withhighlights like previousslide
  • screenshot of listingblock example, withhighlights like previousslide
  • BEANSBlock Entities‣ Block types‣ Fieldable‣ Entity API‣ Non-admin permissions‣ Data entry is familiar to users‣ Build is familiar to Site Builders BADcamp 2011, Neil Hastings
  • BEANSCoding Concepts BADcamp 2011, Neil Hastings
  • BEANSCoding Concepts‣ API First BADcamp 2011, Neil Hastings
  • BEANSCoding Concepts‣ API First‣ Every Type is a Plugin ‣ Even the UI types BADcamp 2011, Neil Hastings
  • BEANSCoding Concepts‣ API First‣ Every Type is a Plugin ‣ Even the UI types‣ Two levels of configuration storage ‣ “Config” - BEAN Type/Bundle ‣ “Content” - BEAN/Entity ‣ Block Placement - BOTH! BADcamp 2011, Neil Hastings
  • BEANSBADcamp 2011, Neil Hastings
  • BEANSSHOW ME SOME CODE ALREADY BADcamp 2011, Neil Hastings
  • BEANSCode For All‣ META BADcamp 2011, Neil Hastings
  • BEANSShow me the Plugin BADcamp 2011, Neil Hastings
  • BEANSWe all love Classes‣ Extend the base class. ‣ bean_plugin ‣ bean_custom - If bean type will be editable in the UI‣ Implement Methods ‣ Values - Define settings to be saved against the Bean. ‣ Form - Define Form for bean add/edit ‣ View - Render the bean. BADcamp 2011, Neil Hastings
  • BEANSDefine Classclass blog_listing_bean extends bean_plugin {..} BADcamp 2011, Neil Hastings
  • BEANSDefine Valuespublic function values() { return array( filters => array( term => FALSE, topic => FALSE, audience => FALSE, ), items_per_page => array( large_image => 0, small_image => 0, listing => 0, ), more_link => array( text => , path => , ), );} BADcamp 2011, Neil Hastings
  • BEANSDefine Valuespublic function values() { return array( filters => array( term => FALSE, topic => FALSE, audience => FALSE, ), items_per_page => array( large_image => 0, small_image => 0, listing => 0, ), more_link => array( text => , path => , ), );} BADcamp 2011, Neil Hastings
  • BEANSDefine Valuespublic function values() { return array( filters => array( term => FALSE, topic => FALSE, audience => FALSE, ), items_per_page => array( large_image => 0, small_image => 0, listing => 0, ), more_link => array( text => , path => , ), );} BADcamp 2011, Neil Hastings
  • BEANSDefine Valuespublic function values() { return array( filters => array( term => FALSE, topic => FALSE, audience => FALSE, ), items_per_page => array( large_image => 0, small_image => 0, listing => 0, ), more_link => array( text => , path => , ), );} BADcamp 2011, Neil Hastings
  • BEANSForm for Allpublic function form($bean) { $form[more_link][text] = array( #type => textfield, #title => t(Link text), #default_value => $bean->more_link[text], ); $form[more_link][path] = array( #type => textfield, #title => t(Link path), #default_value => $bean->more_link[path], );} BADcamp 2011, Neil Hastings
  • BEANSForm for Allpublic function form($bean) { $form[more_link][text] = array( #type => textfield, #title => t(Link text), #default_value => $bean->more_link[text], ); $form[more_link][path] = array( #type => textfield, #title => t(Link path), #default_value => $bean->more_link[path], );} BADcamp 2011, Neil Hastings
  • BEANSA Bean with a Viewpublic function view($bean, $content, $view_mode =full, $langcode = NULL) {} ‣ Return a Render Array ‣ Currently $view_mode is ignored in the block rendering BADcamp 2011, Neil Hastings
  • BEANSA Bean with a Viewpublic function view($bean, $content, $view_mode =full, $langcode = NULL) {} ‣ Return a Render Array BADcamp 2011, Neil Hastings
  • BEANS $count = $bean->items_per_page[large_image] + $bean->items_per_page[small_image] + $bean->items_per_page[listing]; $query = new EnergyEntityFieldQuery(); $query ->entityCondition(bundle, article) ->clearAudienceConditions() ->setOtherAudienceCondition() ->range(0, $count); if (!empty($bean->filters[term])) { $query->setTermCondition(field_article_type, $bean->filters[term]); } if (!empty($bean->filters[topic])) { $query->setTopicCondition($bean->filters[topic]); } if (!empty($bean->filters[audience])) { $query->setTermCondition(field_audience_term, $bean->filters[audience]); } $result = $query->execute(); BADcamp 2011, Neil Hastings
  • BEANSif (empty($result)) { $content[nodes] = array();}else { $content[nodes] = node_load_multiple(array_keys($result[node]));}$content[#theme] = energy_blog_list;$content[more_link] = array( text => $bean->more_link[text], path => $bean->more_link[path],);$content[items_per_page] = array( large_image => $bean->items_per_page[large_image], small_image => $bean->items_per_page[small_image], listing => $bean->items_per_page[listing],); BADcamp 2011, Neil Hastings
  • BEANSif (empty($result)) { $content[nodes] = array();}else { $content[nodes] = node_load_multiple(array_keys($result[node]));}$content[#theme] = energy_blog_list;$content[more_link] = array( text => $bean->more_link[text], path => $bean->more_link[path],);$content[items_per_page] = array( large_image => $bean->items_per_page[large_image], small_image => $bean->items_per_page[small_image], listing => $bean->items_per_page[listing],); BADcamp 2011, Neil Hastings
  • BEANSif (empty($result)) { $content[nodes] = array();}else { $content[nodes] = node_load_multiple(array_keys($result[node]));}$content[#theme] = energy_blog_list;$content[more_link] = array( text => $bean->more_link[text], path => $bean->more_link[path],);$content[items_per_page] = array( large_image => $bean->items_per_page[large_image], small_image => $bean->items_per_page[small_image], listing => $bean->items_per_page[listing],); BADcamp 2011, Neil Hastings
  • BEANSif (empty($result)) { $content[nodes] = array();}else { $content[nodes] = node_load_multiple(array_keys($result[node]));}$content[#theme] = energy_blog_list;$content[more_link] = array( text => $bean->more_link[text], path => $bean->more_link[path],);$content[items_per_page] = array( large_image => $bean->items_per_page[large_image], small_image => $bean->items_per_page[small_image], listing => $bean->items_per_page[listing],); BADcamp 2011, Neil Hastings
  • screenshot of listingblock example, withhighlights like previousslide
  • screenshot of listingblock example, withhighlights like previousslide
  • BEANSEditorial listings‣ Hand-selected listings of nodes‣ Multiple Node Reference field‣ View mode set in the Node Reference field settings‣ Additional fields ‣ More link, Header text, etc. BADcamp 2011, Neil Hastings
  • BEANSMore Fun!‣ BOF in Dwinelle 183 - now‣ http://treehouseagency.com/blog/ neil-hastings/2011/09/21/building- custom-block-entities-beans‣ http://treehouseagency.com/blog/ neil-hastings/2011/09/06/building- energygov-without-views‣ http://drupal.org/project/bean BADcamp 2011, Neil Hastings