phpautocompleteyiiyii-extensions

Yii CJuiAutoComplete for Multiple values


I am a Yii Beginner and I am currently working on a Tagging system where I have 3 tables:

In my /Views/Issue/_form I have added a MultiComplete Extension to retrieve multiple tag ids and labels,

I have used an afterSave function in order to directly store the Issue_id and the autocompleted Tag_ids in the Issue_tag_map table, where it is a HAS_MANY relation.

Unfortunately Nothing is being returned.

I wondered if there might be a way to store the autocompleted Tag_ids in a temporary attribute and then pass it to the model's afterSave() function.

I have been searching for a while, and this has been driving me crazy because I feel I have missed a very simple step!

Any Help or advices of any kind are deeply appreciated!

MultiComplete in Views/Issue/_form:

    <?php

     echo $form->labelEx($model, 'Tag');
     $this->widget('application.extension.MultiComplete', array(
    'model' => $model,
    'attribute' => '', //Was thinking of creating a temporary here
    'name' => 'tag_autocomplete',
    'splitter' => ',',
    'sourceUrl' => $this->createUrl('Issue/tagAutoComplete'),
    // Controller/Action path for action we created in step 4.
    // additional javascript options for the autocomplete plugin
    'options' => array(
        'minLength' => '2',
    ),
    'htmlOptions' => array(
        'style' => 'height:20px;',
    ),
));
echo $form->error($model, 'issue_comment_id_fk');
?>

AfterSave in /model/Issue:

    protected function afterSave() {
    parent::afterSave();

    $issue_id = Yii::app()->db->getLastInsertID();

    $tag; //here I would explode the attribute retrieved by the view form
    // an SQL with two placeholders ":issue_id" and ":tag_id"
    if (is_array($tag))
        foreach ($tag as $tag_id) {
            $sql = "INSERT INTO issue_tag_map (issue_id_fk, tag_id_fk)VALUES(:issue_id,:tag_id)";     

            $command = Yii::app()->db->createCommand($sql);
           // replace the placeholder ":issue_id" with the actual issue value

            $command->bindValue(":issue_id", $issue_id, PDO::PARAM_STR);
           // replace the placeholder ":tag_id" with the actual tag_id value

            $command->bindValue(":tag_id", $tag_id, PDO::PARAM_STR);
            $command->execute();
        }
}

And this is the Auto Complete sourceUrl in the Issue model for populating the tags:

    public static function tagAutoComplete($name = '') {

    $sql = 'SELECT id ,tag AS label FROM tag WHERE tag LIKE :tag';
    $name = $name . '%';
    return Yii::app()->db->createCommand($sql)->queryAll(true, array(':tag' => $name));

actionTagAutoComplete in /controllers/IssueController:

// This function will echo a JSON object 
// of this format:
// [{id:id, name: 'name'}]
function actionTagAutocomplete() {

    $term = trim($_GET['term']);
    if ($term != '') {
        $tags = issue::tagAutoComplete($term);
        echo CJSON::encode($tags);
        Yii::app()->end();
    }
}

EDIT

Widget in form:

   <div class="row" id="checks" >
    <?php
    echo $form->labelEx($model, 'company',array('title'=>'File Company Distrubution; Companies can be edited by Admins'));

    ?>
   <?php
    $this->widget('application.extension.MultiComplete', array(
        'model' => $model,
        'attribute' => 'company',
        'splitter' => ',',
        'name' => 'company_autocomplete',
        'sourceUrl' => $this->createUrl('becomEn/CompanyAutocomplete'),
        'options' => array(
            'minLength' => '1',
        ),
        'htmlOptions' => array(
            'style' => 'height:20px;',
            'size' => '45',
        ),
    ));
    echo $form->error($model, 'company');
    ?>
</div>

Update function:

    $model = $this->loadModel($id);
    .....
      if (isset($_POST['News'])) {
         $model->attributes = $_POST['News'];
        $model->companies = $this->getRecordsFromAutocompleteString($_POST['News']  
       ['company']);
    ......
     ......
      getRecordsFromAutocompleteString():
  public static cordsFromAutocompleteString($string) {
    $string = trim($string);
    $stringArray = explode(", ", $string);
    $stringArray[count($stringArray) - 1] = str_replace(",", "", $stringArray[count($stringArray) - 1]);
    $criteria = new CDbCriteria();
    $criteria->select = 'id';
    $criteria->condition = 'company =:company';
    $companies = array();
    foreach ($stringArray as $company) {
        $criteria->params = array(':company' => $company);
        $companies[] = Company::model()->find($criteria);
    }
    return $companies;
}

UPDATE since the "value" porperty is not implemented properly in this extension I referred to extending this function to the model:

    public function afterFind() {
       //tag is the attribute used in form
      $this->tag = $this->getAllTagNames();
      parent::afterFind();
   }

Solution

  • You should have a relation between Issue and Tags defined in both Issue and Tag models ( should be a many_many relation).

    So in IssueController when you send the data to create or update the model Issue, you'll get the related tags (in my case I get a string like 'bug, problem, ...'). Then you need to parse this string in your controller, get the corresponding models and assigned them to the related tags.

    Here's a generic example:

    //In the controller's method where you add/update the record
    $issue->tags = getRecordsFromAutocompleteString($_POST['autocompleteAttribute'], 'Tag', 'tag');
    

    Here the method I'm calling:

    //parse your string ang fetch the related models
    public static function getRecordsFromAutocompleteString($string, $model, $field)
            {
                $string = trim($string);
                $stringArray = explode(", ", $string);
                $stringArray[count($stringArray) - 1] = str_replace(",", "", $stringArray[count($stringArray) - 1]);
                return CActiveRecord::model($model)->findAllByAttributes(array($field => $stringArray));
            }
    

    So now your $issue->tags is an array containing all the related Tags object.

    In your afterSave method you'll be able to do:

    protected function afterSave() {
        parent::afterSave();
    
        //$issue_id = Yii::app()->db->getLastInsertID(); Don't need it, yii is already doing it
        foreach ($this->tags as $tag) {
            $sql = "INSERT INTO issue_tag_map (issue_id_fk, tag_id_fk)VALUES(:issue_id,:tag_id)";     
            $command = Yii::app()->db->createCommand($sql);
            $command->bindValue(":issue_id", $this->id, PDO::PARAM_INT);
            $command->bindValue(":tag_id", $tag->id, PDO::PARAM_INT);
            $command->execute();
            }
    }
    

    Now the above code is a basic solution. I encourage you to use activerecord-relation-behavior's extension to save the related model. Using this extension you won't have to define anything in the afterSave method, you'll simply have to do:

    $issue->tags = getRecordsFromAutocompleteString($_POST['autocompleteAttribute'], 'Tag', 'tag');
    $issue->save(); // all the related models are saved by the extension, no afterSave defined!
    

    Then you can optimize the script by fetching the id along with the tag in your autocomplete and store the selected id's in a Json array. This way you won't have to perform the sql query getRecordsFromAutocompleteString to obtain the ids. With the extension mentioned above you'll be able to do:

    $issue->tags = CJSON::Decode($_POST['idTags']);//will obtain array(1, 13, ...)
    $issue->save(); // all the related models are saved by the extension, the extension is handling both models and array for the relation!
    

    Edit:

    If you want to fill the autocomplete field you could define the following function:

    public static function appendModelstoString($models, $fieldName)
        {
            $list = array();
            foreach($models as $model)
            {
                $list[] = $model->$fieldName;
            }
            return implode(', ', $list);
        }
    

    You give the name of the field (in your case tag) and the list of related models and it will generate the appropriate string. Then you pass the string to the view and put it as the default value of your autocomplete field.

    Answer to your edit:

    In your controller you say that the companies of this model are the one that you added from the Autocomplete form:

    $model->companies = $this->getRecordsFromAutocompleteString($_POST['News']  
       ['company']);
    

    So if the related company is not in the form it won't be saved as a related model. You have 2 solutions:

    1. Each time you put the already existing related model in you autocomplete field in the form before displaying it so they will be saved again as a related model and it won't disapear from the related models

      $this->widget('application.extensions.multicomplete.MultiComplete', array(
                      'name' => 'people',
                      'value' => (isset($people))?$people:'',
                      'sourceUrl' => array('searchAutocompletePeople'),
      ));
      
    2. In your controller before calling the getRecordsFromAutocompleteString you add the already existing models of the model.

      $model->companies = array_merge(
          $model->companies, 
          $this->getRecordsFromAutocompleteString($_POST['News']['company'])
      );