ckeditor-integration

ckeditor-integration CKEditor Integration

Documentation
Change Log

This extension helps you to integrate CKEditor (next generation of FCKEditor) in your Yii application.

Screenshot

Note that CKEditor is not included in this extension, You can Download CKEditor form its official site and use it with this extension in your applications.

You should check CKEditor Licence before using this extension
This widget is based on fckeditor-integration Extension

Resources ¶

Documentation ¶

Requirements ¶

Yii 1.0 or above
CKEditor 3.4 or above

Installation ¶

Extract the release file under protected/extensions
Download and extract CKEditor in your application root folder

Usage ¶

See the following code example:

$this->widget('ext.ckeditor.CKEditorWidget',array(
  "model"=>$pages,                 # Data-Model
  "attribute"=>'content',          # Attribute in the Data-Model
  "defaultValue"=>"Test Text",     # Optional

  # Additional Parameter (Check http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html)
  "config" => array(
      "height"=>"400px",
      "width"=>"100%",
      "toolbar"=>"Basic",
      ),

  #Optional address settings if you did not copy ckeditor on application root
  "ckEditor"=>Yii::app()->basePath."/../ckeditor/ckeditor.php",
                                  # Path to ckeditor.php
  "ckBasePath"=>Yii::app()->baseUrl."/ckeditor/",
                                  # Realtive Path to the Editor (from Web-Root)
  ) );

if you need full details of configuration parameters, please visit CKEditor API.

Change Log ¶

October 8, 2010 ¶

Initial release.

11 0

6 855

Yii Version: 1.1

License: LGPL-3.0

Category: User Interface

Developed by:

Shahram

Created: Oct 8, 2010

Updated: 15 years ago

Downloads

ckeditor.zip

show all

#2241

0 0

Where to put ckeditor?

Hi,

Could you advise where the ckeditor should be deployed to? The only way I can get this to work is to put ckeditor in "www" AND "www/protected". If I put ckeditor in just www or www/protected various include directives fail.

Thanks,

Paul.

PaulDi at Nov 30, 2010, 11:21:29 PM

#2443

0 0

paulie:: Where to put ckeditor?

Hello Paulie,

I recommend to put the Ckeditor in your web-root (in your server it seems to be in www). If you put any code in your protected folder, it can be accessible only from Yii framework and you can not refer to it as an external code.

If you like to put your Ckeditor in any other folder (any where instead of protected folder) you can set the address using ckBasePath attribute.

Shahram at Jan 3, 2011, 6:37:48 AM

#2544

1 0

There is a bug in CKEditorView.php

Hello.
It's wrong to create attribute name as: get_class($model).'['.$attribute.']'
It works wrong for complex forms with arrays as attributes.
Yii way of doing that is: CHtml::resolveName($model, $attribute).

So the patch is:

--- CKEditorView.orig.php 2011-01-16 00:03:32.000000000 +0300
+++ CKEditorView.php 2011-01-16 00:05:02.000000000 +0300
@@ -33,7 +33,7 @@

require_once($ckEditor);

-$oCKeditor = new CKeditor(get_class($model).'['.$attribute.']');
+$oCKeditor = new CKeditor(CHtml::resolveName($model, $attribute));
$oCKeditor->basePath = $ckBasePath;

if(isset($config) && is_array($config)){
@@ -42,5 +42,5 @@ if(isset($config) && is_array($config)){
}
}

-$oCKeditor->editor(get_class($model).'['.$attribute.']',$defaultValue);
+$oCKeditor->editor(CHtml::resolveName($model, $attribute),$defaultValue);
?>
\ No newline at end of file

afunix at Jan 15, 2011, 9:02:39 PM

#2545

1 0

There is a bug in CKEditorView.php

Hmm. Patch is broken by parser.
URL of patch: http://dl.dropbox.com/u/6312269/CKEditorView.php.patch

afunix at Jan 15, 2011, 9:04:34 PM

#3366

0 0

issues with this extension

I have the CKEditor extracted to my servers web root, and this extension extracted in my protected/extensions folder. Now if I use the code above I get the following Yii error:

Undefined variable: pages

and it has a reference to the code:

$this->widget('ext.ckeditor.CKEditorWidget',array(
   "model"=>$pages,                 # Data-Model <------- THIS LINE HIGHLIGHTED
   "attribute"=>'content',          # Attribute in the Data-Model
   "defaultValue"=>"Test Text",     # Optional
  
   # Additional Parameter (Check http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html)
   "config" => array(
       "height"=>"400px",
       "width"=>"100%",
       "toolbar"=>"Basic",
       ),

My question is, where are you supposed to place your code example above. In my attempt I placed your exact code in my index view on a new test site. Is a view the wrong place?

If this is supposed to be in a view, then what went wrong here?

David Dreggors at Apr 6, 2011, 4:50:38 PM

#3672

0 0

@ddreggors

hi ddreggors,

the place is exactly in a view page. but before rendering the view, you should bind it with a model in your controller.

for example you some code like following in your controller:

**$model = Pages::model()->findByPk(1);
$this->render('index', array(

'pages' => $model,

));**

by this code, you will pass a model in the name of pages to your view/index file. I assumed that you have a field called content in your model which will be used in widget. If you want to use any other name, please edit your widget configuration.

Cheers

Shahram at Apr 27, 2011, 11:50:58 AM

#3751

0 0

Attribute data not showing up (I patched it in my project). Did I miss a step?

I'm using latest Yii 1.1.7 and [url="http://www.yiiframework.com/extension/ckeditor-integration"]ckeditor-integration[/url]. I setup ckeditor as per the directions on the extension page =>

[code]

	<?php 
	    $base = Yii::app()->request->baseUrl;
	    
	    $this->widget('ext.ckeditor.CKEditorWidget', array(
	        "model"=>$event,
	        "attribute"=>'description',
	        'config'=>array(
	            'width'=>'600px',
	            'filebrowserBrowseUrl' => $base.'/filemanager/index.html',
	            ),
	    ));
	 ?>

[/code]

But when the editor loads, the attribute doesn't come up.

I patched extensions/ckeditor/views/CKEditorView.php to make it work =>

keditor/views/CKEditorView.php
44a45,48
>
> // pull model data into area
> $defaultValue = $model->$attribute;
>

[b]Did I miss something?[/b]

I submit this as a patch on the ext, but I'm still too green around the ears.

Thanks in advance,
Daniel

Daniel Goldberg at May 5, 2011, 12:37:08 AM

#3752

0 0

Attribute data not showing up (I patched it in my project). Did I miss a step?

I'm using latest Yii 1.1.7 and [url="http://www.yiiframework.com/extension/ckeditor-integration"]ckeditor-integration[/url]. I setup ckeditor as per the directions on the extension page =>

[code]

	<?php 
	    $base = Yii::app()->request->baseUrl;
	    
	    $this->widget('ext.ckeditor.CKEditorWidget', array(
	        "model"=>$event,
	        "attribute"=>'description',
	        'config'=>array(
	            'width'=>'600px',
	            'filebrowserBrowseUrl' => $base.'/filemanager/index.html',
	            ),
	    ));
	 ?>

[/code]

But when the editor loads, the attribute doesn't come up.

I patched extensions/ckeditor/views/CKEditorView.php to make it work =>

keditor/views/CKEditorView.php
44a45,48
>
> // pull model data into area
> $defaultValue = $model->$attribute;
>

[b]Did I miss something?[/b]

I submit this as a patch on the ext, but I'm still too green around the ears.

Thanks in advance,
Daniel

Daniel Goldberg at May 5, 2011, 12:37:11 AM

#3754

0 0

Default value

@swiftgaruda:
check out this post
http://www.yiiframework.com/forum/index.php?/topic/9341-ckeditor-widget-in-a-cactiveform/

I had to set the value of the model attribute to the defaultvalue:

$defaultvalue = $model->content_field 
 
                $this->widget('ext.ckeditor.CKEditorWidget',array( 
                 
                "model"=>$model,                 # Data-Model 
                "attribute"=>"content_field",          # Attribute in the Data-Model 
                "defaultValue"=>$defaultvalue,     # Optional

banago at May 5, 2011, 11:00:43 AM

#3767

0 0

model should get attribute

indeed, the Widget should do (line 73):

if(!isset($this->defaultValue)){
			$attr = $this->attribute;
			$this->defaultValue = $this->model->$attr;
		}

warden at May 6, 2011, 10:42:27 AM

#4001

0 0

2 ckeditor windows, one loaded via AJAX

Hi, is there a way to add a second CKeditor window, loaded through ajax with its own save button (ajax save - different model) ?

i'm pulling my hair out and can't make it work. the ckeditor window loads just ok and loads the neccessary data (it's filled with content correctly) but when i hit SAVE, the new ckeditor window content is not saved. when iswitch back to a normal form, it's saved as it should.

anyone went through something like this?

vimanaboy at May 26, 2011, 1:21:37 AM

#4631

0 0

upload ext

Hi,

Nice wrap.
Is there a upload ext. which works with this?

izepstan at Jul 27, 2011, 2:54:12 PM

#6418

0 0

Flawless!

I've tried a bunch of extentsions on this site, many is awesome but this one
Is flawless. Simple and powerfull:) I've not had a single problem with this on the entire time. I just create new crud operations with gii and my textareas becomes powerfull ck editors instead:)

I've had it installed for a while but its not until now when I'm fixing the individuall text formatting / looks on 20+ pages with text that I realise how awesome it is to have it installed.

Sampa at Jan 9, 2012, 1:12:24 PM

#6626

0 0

modell array

I use a form with model array.

// ...
  "model"=>$pagesLang,
   "attribute"=>'[$key][pgtext]',
  // ...

The widget render:
~~~
[html]
PagesLang[[1][pgtext]]
~~~

But I need:
~~~
[html]
PagesLang[1][pgtext]
~~~

Because my controller works:

foreach ($this->_model->pagesLangs as $key=>$pagesLang) {
    $pagesLang->attributes = $_POST['PagesLang'][$key];
    $pagesLang->save(false);
  }

I can modify ext/view/CKEditorView.php to:

// $oCKeditor = new CKeditor(get_class($model).'['.$attribute.']');
  $oCKeditor = new CKeditor(get_class($model).$attribute);

  // ...

  // $oCKeditor->editor(get_class($model).'['.$attribute.']',$defaultValue);
  $oCKeditor->editor(get_class($model).$attribute,$defaultValue);

I don't know it is good or not, but works...

Rajcsányi Zoltán at Jan 23, 2012, 10:31:58 AM

#7447

0 0

It is a good extension. Thanks

ECNU长弓 at Mar 23, 2012, 7:14:42 AM

Please only use comments to help explain the above extension.
If you have any questions, please ask in the forum instead.

Join the conversation to share a note.