danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  *
danielebarchiesi@0:  * Plugin to provide a string context
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Plugins are described by creating a $plugin array which will be used
danielebarchiesi@0:  * by the system that includes this file.
danielebarchiesi@0:  */
danielebarchiesi@0: $plugin = array(
danielebarchiesi@0:   'title' => t('String'),
danielebarchiesi@0:   'description' => t('A context that is just a string.'),
danielebarchiesi@0:   'context' => 'ctools_context_create_string',
danielebarchiesi@0:   'keyword' => 'string',
danielebarchiesi@0:   'no ui' => FALSE,
danielebarchiesi@0:   'context name' => 'string',
danielebarchiesi@0:   'convert list' => array(
danielebarchiesi@0:     'raw' => t('Raw string'),
danielebarchiesi@0:     'html_safe' => t('HTML-safe string'),
danielebarchiesi@0:   ),
danielebarchiesi@0:   'convert' => 'ctools_context_string_convert',
danielebarchiesi@0:   'placeholder form' => array(
danielebarchiesi@0:     '#type' => 'textfield',
danielebarchiesi@0:     '#description' => t('Enter the string for this context.'),
danielebarchiesi@0:   ),
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * It's important to remember that $conf is optional here, because contexts
danielebarchiesi@0:  * are not always created from the UI.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_create_string($empty, $data = NULL, $conf = FALSE) {
danielebarchiesi@0:   // The input is expected to be an object as created by ctools_break_phrase
danielebarchiesi@0:   // which contains a group of string.
danielebarchiesi@0: 
danielebarchiesi@0:   $context = new ctools_context('string');
danielebarchiesi@0:   $context->plugin = 'string';
danielebarchiesi@0: 
danielebarchiesi@0:   if ($empty) {
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($data !== FALSE ) {
danielebarchiesi@0:     $context->data = $data;
danielebarchiesi@0:     $context->title = ($conf) ? check_plain($data['identifier']) : check_plain($data);
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Convert a context into a string.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_string_convert($context, $type) {
danielebarchiesi@0:   switch ($type) {
danielebarchiesi@0:     case 'raw':
danielebarchiesi@0:       return $context->data;
danielebarchiesi@0:     case 'html_safe':
danielebarchiesi@0:       return check_plain($context->data);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: