trigger_condition_keyword.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/system/triggers/trigger_condition_types/trigger_condition_asset_type/trigger_condition_asset_type.inc';

class Trigger_Condition_Keyword extends Trigger_Condition_Asset_Type
{

    protected static function getMatchOptions()
    {
        return Array(
                'exact'     => translate('exact_match'),
                'partial'   => translate('partial_match'),
                'regex'     => translate('regex_match'),
               );

    }//end getMatchOptions()


    public static function evaluate($settings, &$state)
    {
        if (empty($settings['keyword'])) return FALSE;
        if (empty($settings['match_type'])) return FALSE;
        
        if (empty($state['asset'])) {
            if (empty($state['assetid'])) return FALSE;
            $state['asset'] = $GLOBALS['SQ_SYSTEM']->am->getAsset($state['assetid']);
        }

        // try replacing the asset keyword
        // if the keyword is a globals keyword, this function simply returns the globals keyword as it is
        // note: we are currently allowing only one keyword to be specified here, so, we strip '%' from the
        //       specified keyword, in case multiple keywords are set here 
        $keyword = str_replace('%', '', $settings['keyword']);
        $asset_keyword_replacement = $state['asset']->getKeywordReplacement($keyword);

        // now try replacing the globals keyword
        // we need to make sure that the triggering asset is used to repalce global keywords,
        // so, temporarily switch the 'current asset' to the triggering asset
        $original_current_asset = $GLOBALS['SQ_SYSTEM']->getGlobalDefine('CURRENT_ASSET', NULL);
        $GLOBALS['SQ_SYSTEM']->setGlobalDefine('CURRENT_ASSET', $state['asset']);
        replace_global_keywords($asset_keyword_replacement);

        // we are done with the temporary current asset, so, let's put it back to the original state
        if (is_null($original_current_asset)) {
            $GLOBALS['SQ_SYSTEM']->unsetGlobalDefine('CURRENT_ASSET');
        } else {
            $GLOBALS['SQ_SYSTEM']->setGlobalDefine('CURRENT_ASSET', $original_current_asset);
        }
        // now we have a replacement value - test the replacement value against the value specified to compare
        switch ($settings['match_type']) {
            case 'exact':
                return ($asset_keyword_replacement === $settings['comparison_value']);
            case 'partial':
                return (strpos($asset_keyword_replacement, $settings['comparison_value']) !== FALSE);
            case 'regex':
                return (preg_match('/'.str_replace('/', '\/', $settings['comparison_value']).'/', $asset_keyword_replacement) > 0);
        }

        // we shouldn't come this far but if we did, return FALSE so that the trigger action wouldn't run on this asset
        return FALSE;

    }//end evaluate()


    public static function getInterface($settings, $prefix, $write_access=FALSE)
    {
        // check if we already have values set so that we can pre-set the values where possible below
        $keyword = isset($settings['keyword']) ? $settings['keyword'] : '';
        $replacement_value = isset($settings['comparison_value']) ? $settings['comparison_value'] : '';
        $operator = array_get_index($settings, 'match_type', 'exact');

        $am = $GLOBALS['SQ_SYSTEM']->am;

        // keyword input box
        ob_start();
            if ($write_access) {
                text_box($prefix.'[keyword]', $keyword, '30px');
            } else {
                echo '<b>'.$keyword.'</b>';
            }
            $keyword_component = ob_get_contents();
        ob_end_clean();

        // value to compare
        ob_start();
            if ($write_access) {
                text_box($prefix.'[comparison_value]', $replacement_value , '50px');
            } else {
                echo '<b>'.$replacement_value.'</b>';
            }

            $replacement_value_component = ob_get_contents();
        ob_end_clean();

        // operator selector
        ob_start();
            $operator_options = Trigger_Condition_Keyword::getMatchOptions();
            
            if ($write_access) {
                combo_box($prefix.'[match_type]', $operator_options, FALSE, $operator);
            } else {
                echo '<b>'.$operator_options[$operator].'</b>';
            }
            $operator_component = ob_get_contents();
        ob_end_clean();


        return translate('trigger_condition_keyword', $keyword_component, $operator_component, $replacement_value_component);

    }//end getInterface()


    public static function processInterface(&$settings, $request_data)
    {
        if (empty($request_data)) {
            return translate('trigger_input_data_missing');
        }

        $settings['keyword'] = array_get_index($request_data, 'keyword', '');
        $settings['comparison_value'] = array_get_index($request_data, 'comparison_value', '');
        $settings['match_type'] = array_get_index($request_data, 'match_type', 'exact');

        return FALSE;

    }//end processInterface()


}//end class

?>