SocialEngine Blog

SocialEngine is the best way to create a unique community website. Let your friends, fans or customers geek out about anything you want.

Ask John – Part 1

We got a lot of great questions from all of you for our ASK JOHN feature. It was hard to narrow it down to just a few questions for the inaugural article, but without further ado, here are your answers straight from the source!

Storage System

Steve R. asks, “What is possible with upcoming SE releases and what are best practices when delivering files via CDNs?”

The SocialEngine storage system is an abstract system designed to simply store and retrieve files and map a URL to their location. By implementing this system in your plugins, you will be able to use the CDN support that will be integrated into SocialEngine. It is also possible write your own storage adapters.

The storage system exists within the storage module (application/modules/Storage). There are several very basic methods to access the files stored within. A database row is created for each file containing the file path, which storage service the file is stored in, and other metadata.

Basic Usage

Starting in 4.1.0, all of the basic methods to access the storage system are in the class Storage_Model_DbTable_Files. You can get this class using:

Engine_Api::_()->getDbtable('files', 'storage');

Getting a file object is simple, you can use either of the following methods:

$file = Engine_Api::_()->getItem('storage_file', 1);
$file = Engine_Api::_()->getDbtable('files', 'storage')->find(1)->current();

To get the URL of the file, simply call the map method. This method may return a relative URL for local storage.

$url = $file->map();

You can read the contents of the file into a string or have the service transfer it to a temporary file using the read() and temporary() methods:

$contents = $file->read();
$tmpFile = $file->temporary();

Note that because the file is not guaranteed to be local, a file system path cannot be retrieved from the storage system. You will need to use one of the above methods to access the file.

You can delete a file using the remove method:

$file->remove();

In order to create a file, you must have certain information about the file:
1) The file is owned by a user, so you need the ID of the user that it belongs to.
2) The file is associated with an item, which can also be the user. This tells what specific item the file is associated with. The parent type must be part of the item system. For example, a group photo is owned by the user that uploads it, but it is associated with the group.
3) The file path, or $_FILES array. If you use the $_FILES array, the name and other metadata will be pulled from it instead of automatically generated.

The storage service will throw an exception if the user’s quota is reached or it could not store the file. It it your responsibility to remove the original copy of the file after it’s been imported into the storage system.

Here is an example of how to store a file:

$storage = Engine_Api::_()->getDbtable('files', 'storage');
$file = $storage->createFile($_FILES['Filedata'], array(
	'user_id' => $user_id,
	'parent_type' => 'group',
	'parent_id' => $group_id,
));
$file_id = $file->getIdentity();

Using Thumbnails

The files table also can keep track of different versions of files. This is mainly used for thumbnails. You can access a thumbnail using the ID of the original image using the getFile() method in Storage_Model_DbTable_Files. Note that if there is no alternate file of the specified type, it will return the original file instead. Example usage:

$file = Engine_Api::_()->getDbtable('files', 'storage')->getFile(100, 'thumb.icon');
echo $file->getIdentity(); // 103

In order to associate two files, you call the bridge() method on the original file and pass it the second file, and give it a string type that is used to access it:

$file->bridge($otherFile, 'thumb.icon');

Search System

Steve R. also asks, “How does Search code work and how can devs plug into the code to extend to 3rd party plugins and/or custom mods?”

The search system is used to build a search index of text associated with various content. A dedicated table, engine4_core_search, contains this information and is stored using MyISAM in order to utilize it’s fulltext search capabilities. Using a single table allows all content to be searched through at once, and using a table separate from the original allows the original tables to be stored using InnoDB.

In order to use the search indexer, your content must be loadable using the item system. If your item class extends Core_Model_Item_Abstract, the insert and update hooks will be used to index the item’s content.

There are a couple things that need to be configured in order to correctly use the search indexer:
1) There is a property Core_Model_Item_Abstract::$_searchTriggers that defines which columns will trigger an index update when changed. You may need to override this value if you use different column names.
2) You may want to define a search column in the table row or override the isSearchable() method to determine if the item should be indexed.
3) The search indexer requires the getTitle() and getDescription() methods to return data.
4) There is also a getKeywords() and getHiddenSearchData() method that is supported. The latter will not be displayed to a user.

For rendering purposes, you should implement the getTitle(), getDescription() and getPhotoUrl() methods such that the proper information is rendered in the search results.

IDE

Rich asks, “What IDE do you recommend for SE development and how do you recommend setting it up?”

We recommend Netbeans as an IDE. One of the primary reasons for this choice (at the time) was the lack of a decent FTP plugin for Eclipse. We also prefer the simplicity of Netbeans’ UI over Eclipse.

If you’re looking for a slightly better text editor rather than a full IDE, we recommend Geany, Programmer’s Notepad, or TextMate.

We use two spaces as indentation within SocialEngine.

If you plan to use Subversion with Netbeans on Windows, we recommend the SlikSVN client. For Linux or OSX, you can use the Subversion CLI binaries.

Netbeans supports uploading files over FTP/SSH as they are saved and has options to preserve existing file permissions.

That’s all for now! As mentioned before, we will run this feature every few weeks, so post any questions you have below. Don’t be shy about letting us know if this is too technical, not technical enough, or exactly what you’d hoped for!

17 Comments

  1. Ed
    Posted February 8, 2011 at 12:42 pm | Permalink

    Just to reconfirm question would like to see answered or at least some hints towards,

    "What is the best method for extending core features of SE without losing upgrade-ability.?" Jeremy M

    Cheers,

    Ed

  2. Amir
    Posted February 9, 2011 at 5:19 am | Permalink

    This CDN feature is great along with CDN feature, when we delete a photo from Social Engine 4, Only Query From Database is removed, Files remains inside the server which is waste of storage from server. File and its thumbs should also be deleted.

  3. Steve
    Posted February 9, 2011 at 5:48 pm | Permalink

    Great start! Very informative. I really appreciate the sharing and insight. This series goes a long way towards improved relationships with 3rd party devs and clients. And I think John's posts will become must reads for understanding and improving SE websites.

  4. George
    Posted February 9, 2011 at 6:24 pm | Permalink

    I agree with Amir

  5. Posted February 10, 2011 at 3:36 pm | Permalink

    Thanks for the info.

    I'm hoping we can get an answer for Jeremy M question that has re-submited by Ed F.

  6. Enrico
    Posted February 10, 2011 at 5:06 pm | Permalink

    Hi,
    I have some questions to ask on widgets in Layout Editor managed pages and custom pages.
    1. The first one is: how can I use a widget in my custom pages?
    I don't want to use the widget in a page created with Layout Manager, but in a page i developed (controller and view)..
    is there a programming interface to do it?

    2. it is possible to put a widget on the right of another widget and not under another one… in the same column? This using Layout editor or not.
    thank you

  7. Posted February 16, 2011 at 10:08 am | Permalink

    Hi, I was wondering if anyone could tell me how I can find out what version of social engine I am using. The domain is http://www.naturistcommunity.com also does anyone know of any video tutorials that can help me upgrade? thanks in advance – my email is: ed@naturistcommunity.com

  8. Tom
    Posted February 17, 2011 at 7:23 pm | Permalink

    +1 for the question on what's the best way to extend SE

  9. Nima
    Posted March 8, 2011 at 10:28 am | Permalink

    Hi, and thanks for sharing

    1- on poll plugin, how is it possible that we give code, that member could add created poll in his own blog/site but the result must be shown on our socialengine?

    2- I am looking for a way to have share button that people could add into their blog/site, for their users to be able to share their content on my socialengine?

    3- how could we fasten up our socialengine? using all recommendations for programs, host but still noting that satisfy my visitors! i think all agree socialengine 4 is too slow! and how we could find out before purchasing any pluging, dose that plugin affect on the speed of our website! the rating system do not help much! it would be much better if you could review plugins and rate not just by stars!

  10. Ward
    Posted June 26, 2011 at 3:38 am | Permalink

    Speed has been an issue for many and being unfamiliar with servers, caching, etc could you guys give us step by step approach to hosting company's … Example: 5,000 users online = VPS, 20,000 users = Dedicated, 100,000 users = Cloud Hosting.

    1) Could you please give us a *Servers for Dummies* version of how we should upgrade as our communities increase in size? And …

    2) Please explain the pro's and con's of this service. It looks like it's easy and free!! https://www.cloudflare.com/plans.html

    Thanks, Ward

  11. Inti
    Posted August 15, 2011 at 1:50 pm | Permalink

    Where is John?

  12. Akis
    Posted August 31, 2011 at 4:50 am | Permalink

    Can I use search like I use search in yellowpages? Can I also use search to monitor user profiles (ex job, city, etc)?

  13. William
    Posted August 31, 2011 at 7:55 am | Permalink

    @Ward:
    1,000 users access your site at a time if you're using VPS will lead to "server down". It required to reboot the VPS, which normally take 15mins
    around.
    We cannot refer users to go to our sites just because of this main reason.

  14. Darshakkumar Shah
    Posted October 13, 2011 at 1:10 pm | Permalink

    Hello

    I m darshakkumar shah. i am in big problem . How to fire delete query for delete some records …Please reply me my email id is darshak.shah@technotechindia.com

  15. Matt
    Posted October 15, 2011 at 12:58 am | Permalink

    @Darshakkumar Please submit a support ticket or contact us for assistance (http://www.socialengine.net/contact).

  16. Purna Rao
    Posted September 17, 2012 at 5:41 am | Permalink

    Hi John, I am in deep trouble. I had searched for cybersource payment gateway plugin to get install with my Social Engine 3.2.0 application. But, no where I found it. Then, I started writing the code for cybersource payment gateway to integrate with my application. I had two more payment gateways(Paypal & GoogleCheckOut), which I already installed those plugins. Now the response of these three payment gateways, after got successful payment gives different responses. Paypal and GoogleCheckOut are some how similar, but it is completely different with CyberSource payment gateways responses. So, could you please help, what to do after when I got successful payment with CyberSource. My email Id is purnarao@faststream-tech.com

  17. Nithinkumar
    Posted September 18, 2014 at 11:51 pm | Permalink

    Hi John.Your blog is very helpful.I was in deep trouble.Your information helped me to solve the issue..Thank you..

Post a Comment

Your email is kept private. Required fields are marked *

*
*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>