GeeklogWiki - User contributions [en]

Soc geeklog2 media plugin

2009-03-31T12:12:20Z

Tony: /* Overview */

== Overview ==

Rich content must include video, photos as well as integration with existing services. The goal of this plugin is:

# Allow the upload and categorization of video and photos (really any files ala the Geeklog 1.x File Management Plugin)
# Encoding of video content to shrink size and save bandwidth
# Integrate the plugin with sites like [http://www.flickr.com Flickr], [http://www.youtube.com YouTube] and the like.
# The upload capabilities must allow the secure, arbitrary upload of any files
# Highly configurable. Having the ability to limit file size, mime types and specific plugin features will be paramount.

The goals is that the resulting plugin allows the embedding of this kind of content in articles seamlessly while providing a YouTube or Flickr like interface for browsing content.

== Resources ==

For ideas please refer to other OSS tools like WordPress that has similar modules.

== Level of Difficulty ==

Hard

Being able to handle file uploads securely, special processing of video (Transcoding, possibly on another server), and handling the merriad of file types in a UI that is intuitive will be a huge challenge.

== Level of Difficulty ==

Hard

Dealing securely with file uploads, handling video yet providing a UI that can handle any kind of file will be the challenge.

== Objective ==

Develop a core for the plugin that would contain all hooks needed for the iAPI.
Develop the iAPI and keep it as small as possible trying to keep it in line with the core GL2 APIs.

== Level of Difficulty ==

''Midrange to Hard''

The hard part will be figuring out how to implement the iAPI without making it huge. It needs to stay small and easy to use. But at the same time provide everything needed to implement the multiple types of media.

[[Category:Summer of Code]] [[Category:Development]]

Soc geeklog2 media plugin

2009-03-31T12:08:57Z

Tony: /* Incentive */

== Overview ==

Rich content must include video, photos as well as integration with existing services. The goal of this plugin is:

1) Allow the upload and categorization of video and photos (really any files ala the Geeklog 1.x File Management Plugin)
2) Encoding of video content to shrink size and save bandwidth
3) Integrate the plugin with sites like <a href="http://www.flickr.com">Flickr</a>, <a href="http://www.youtube.com">YouTube</a> and the like.
4) The upload capabilities must allow the secure, arbitrary upload of any files
5) Highly configurable. Having the ability to limit file size, mime types and specific plugin features will be paramount.

The goals is that the resulting plugin allows the embedding of this kind of content in articles seamlessly while providing a YouTube or Flickr like interface for browsing content.

== Level of Difficulty ==

Hard

Dealing securely with file uploads, handling video yet providing a UI that can handle any kind of file will be the challenge.

== Objective ==

Develop a core for the plugin that would contain all hooks needed for the iAPI.
Develop the iAPI and keep it as small as possible trying to keep it in line with the core GL2 APIs.

== Level of Difficulty ==

''Midrange to Hard''

The hard part will be figuring out how to implement the iAPI without making it huge. It needs to stay small and easy to use. But at the same time provide everything needed to implement the multiple types of media.

[[Category:Summer of Code]] [[Category:Development]]

SoC geeklog2 syndication api

2009-03-26T16:19:30Z

Tony:

<center>(Return to the main idea page for the [[Google Summer of Code]])</center>

== Incentive ==

It should be reasonably clear to any web savvy user or developer that Syndication is an essential aspect of any web software these days. The AptitudeCMS engine needs a powerful, flexible syndication engine that can be used by all other plugins to provide inbound and outbound syndication feeds.

== Objective ==

* Develop a fully object oriented PHP5 implementation of the Geeklog 1.x syndication classes for reading/writing arbitrary feeds. Use of Zend_Feed or similar library strongly encouraged.
* Develop a AptitudeCMS Plugin which provides a full API wrapper to the Syndication classes for creation and maintenance of outbound and inbound feeds

== Level of Difficulty ==

''Easy''

Geeklog 1.x's syndication framework is quite nice (even if I do say so myself!) and provides a good basic PHP4 OO implementation of the basic feed handling code. This needs turning into fully object oriented PHP5 (there are some refinements PHP5 allows that the current code misses. This is the easy part.

The harder part is defining what the interface from AptitudeCMS is and how it works, and working with the AptitudeCMS framework, which only a couple of engineers are really up to speed with. Figuring this out from scratch will be the challenge to get something "right first time" to avoid the need to radically over-haul and replace the syndication framework at a later stage.

[[Category:Summer of Code]] [[Category:Development]]

SoC geeklog2 syndication api

2009-03-26T16:18:45Z

Tony: /* Objective */

<center>(Return to the main idea page for the [[Google Summer of Code]])</center>

== Incentive ==

It should be reasonably clear to any web savvy user or developer that Syndication is an essential aspect of any web software these days. The Geeklog2 engine needs a powerful, flexible syndication engine that can be used by all other plugins to provide inbound and outbound syndication feeds.

== Objective ==

* Develop a fully object oriented PHP5 implementation of the Geeklog 1.x syndication classes for reading/writing arbitrary feeds. Use of Zend_Feed or similar library strongly encouraged.
* Develop a AptitudeCMS Plugin which provides a full API wrapper to the Syndication classes for creation and maintenance of outbound and inbound feeds

== Level of Difficulty ==

''Easy''

Geeklog 1.x's syndication framework is quite nice (even if I do say so myself!) and provides a good basic PHP4 OO implementation of the basic feed handling code. This needs turning into fully object oriented PHP5 (there are some refinements PHP5 allows that the current code misses. This is the easy part.

The harder part is defining what the interface from Geeklog 2 is and how it works, and working with the Geeklog2 framework, which only a couple of engineers are really up to speed with. Figuring this out from scratch will be the challenge to get something "right first time" to avoid the need to radically over-haul and replace the syndication framework at a later stage.

[[Category:Summer of Code]] [[Category:Development]]

Google Summer of Code

2009-03-26T16:16:44Z

Tony: /* For AptitudeCMS (formerly Geeklog 2) */

Soc geeklog2 FBConnect

2009-03-26T16:16:12Z

Tony: New page: Start here [http://developers.facebook.com/connect.php Facebook Connect]. Idea would be to integrate Facebook connect into Geeklog *and* adhere to the terms of service. I'm not convinced...

Start here [http://developers.facebook.com/connect.php Facebook Connect].

Idea would be to integrate Facebook connect into Geeklog *and* adhere to the terms of service. I'm not convinced this would require an entire summer so additional things to toss in would be:

# Twitter integration
# Article syndication using things like digg, Facebook, delicous, etc.

Google Summer of Code

2009-03-26T16:12:01Z

Tony: /* For AptitudeCMS (formerly Geeklog 2) */

2006-09-21T15:58:49Z

Tony: /* Models, Views, Controllers Defined */

== Model-View-Controller ==

If you don't know what it is, you better ask somebody. Separating the user interface from business logic from data access is a framework essential and is key to making your application easier to maintain. Most MVC implementations break code into atomic units of work that encourage reuse and maintainability. Geeklog 2 uses MVCnPHP to accomplish this.

== MVCnPHP ==

MVCnPHP, Model-View-Controller iN PHP, is a simplified MVC implementation based very loosely off of Phrame and Struts with all the garbage taken out. If you are Java programmer and a Struts fan, don't take too much offense as I believe it is a good tool but it aims at doing more than a simple MVC implementation. Phrame similarly is a Struts-like MVC implementation that share many of the same problems in Struts. I wrote MVCnPHP back in 2003 because, in my opinion, there wasn't a bare bones, intuitive MVC implementation in PHP. Since it's release back in 2003 it has kept it's simplicity and has significantly improved performance. From this point on I'm going to assume you know what MVC and are eager to learn how to implement MVCnPHP in your application.

== Models, Views, Controllers Defined ==

Models are the data structures your PHP application will use and they represent the core business components of your business. So, for example, you may very well have models that represent users, accounts and transactions. Models are ideally simple PHP classes that are made up of members and their accessors (i.e. getters/setters). Views are mechanisms used to render one or more models to a users. Views are the visual component and in most basic web development terms are represented by a single screen. A controller manages program execution between models and views and commands. What's this command thing? Commands are implementation of the command design pattern. Commands are simply used to represent actions. Thus it is quite typical in MVC implementations to have a view submit data to a command which in turn requests another view to be show all being dispatched by the controller. Is all this fuzzy? No worry, let's look at each piece of MVCnPHP in more detail.

#[[MVCnPHP Installation]]
#[[MVCnPHPController|Using the Controller]]
#[[Building a View]]
#[[MVCnPHPConfig|Understanding the MVCnPHP Configuration File]]
#[[MVCnPHPCommand|Building a Command]]
#[[Using Forwards]]

MVCnPHPConfig

2006-09-21T15:57:19Z

Tony: /* MVCnPHP Configuration File */

MVCnPHPConfig

2006-09-21T15:37:59Z

Tony:

== MVCnPHP Configuration File ==

Ok, so you've built your first view using MVCnPHP but now you need to configure the controller to call your view when requested. This is done by managing a very simple XML file. Back when we created our index.php page that instantiated the controller we gave it a file called mvcconfig.xml as the configuration it should use. You should now create that XML file and add the following:

<code><pre>
<?xml version="1.0" encoding="UTF-8"?>
<mvc_configuration compile="true">
<view id="home" name="SAMPLE_HomeView" default="true" />
</mvc_configuration>
</pre></code>

The above configuration file is about as bare bones as it gets. The first tag, MVC_CONFIGURATION, has a compile attribute that will tell MVCnPHP it should compile the XML to a PHP array for faster processing. It's generally a good idea to do this. The VIEW tag defines a view for the controller with a logical ID of home and a class name of SAMPLE_HomeView. The default attribute tells the controller that if it isn't given the ID of a view that it should use that view as the default. So how do you tell the controller what view to use?

<code><pre>http://www.example.com/index.php?cmd=home</pre></code>

The above shows you that you can call a specific view by giving it a cmd GET string variable. Note that because our configuration file has the home view as the default view the above URL is the same as:

<code><pre>http://www.example.com/index.php</pre></code>

Some of you are probably grumbling about the use of the ugly GET string and noting how URL rewriting would be better. You are in luck as MVCnPHP will treat the following URL the same as the above:

<code><pre>http://www.example.com/index.php/home/</pre></code>

No, MVCnPHP doesn't use Apache's URL rewriting...instead it chooses to use a hosting provider friendly implementation that parses the GET string and it assumes the first argument is the cmd value.

For reference, this what the compiled configuration file would look like:

<code><pre>
<?php $this->arrayData = array (
'views' =>
array (
'home' =>
array (
'name' => 'SAMPLE_HomeView',
'default' => 1,
)
)
);
?>
</pre></code>

Building a View

2006-09-21T15:08:59Z

Tony: /* Your First View */

Building a View

2006-09-21T15:08:45Z

Tony: /* Your First View */

Model-View-Controller

2006-09-21T15:08:00Z

Tony: /* Models, Views, Controllers Defined */

Model-View-Controller

2006-09-19T20:43:42Z

Tony: Sample Controller

MVCnPHP Installation

2006-09-19T20:28:04Z

Tony: /* Installing MVCnPHP */

== Installing MVCnPHP ==

Installation of MVCnPHP is quite easy. First you need to [http://project.geeklog.net/frs/?group_id=7 get the tarball]. It was built as a [http://pear.php.net PEAR] package so assuming you have [http://www.php.net PHP5] installed you can install MVCnPHP using the PEAR command line:

#>pear install /path/to/mvcnphp_pear_package.tgz

That's it! Now see how to [[MVCnPHPController|build your first controller]]

Model-View-Controller

2006-09-19T20:27:22Z

Tony: /* Models, Views, Controllers Defined */

== Model-View-Controller ==

If you don't know what it is, you better ask somebody. Separating the user interface from business logic from data access is a framework essential and is key to making your application easier to maintain. Most MVC implementations break code into atomic units of work that encourage reuse and maintainability. Geeklog 2 uses MVCnPHP to accomplish this.

== MVCnPHP ==

MVCnPHP, Model-View-Controller iN PHP, is a simplified MVC implementation based very loosely off of Phrame and Struts with all the garbage taken out. If you are Struts fan, don't take too much offense as I believe it is a good tool but it aims at doing more than a simple MVC implementation. Phrame similarly is a Struts-like MVC implementation that share many of the same problems in Struts. Since it's release back in 2003 it has kept it's simplicity and has significantly improved performance. From this point on I'm going to assume you know what MVC and are eager to learn how to implement MVCnPHP in your application.

== Models, Views, Controllers Defined ==

Models are the data structures your PHP application will use and they represent the core business components of your business. So, for example, you may very well have models that represent users, accounts and transactions. Models are ideally simple PHP classes that are made up of members and their accessors (i.e. getters/setters). Views are mechanisms used to render one or more models to a users. Views are the visual component and in most basic web development terms are represented by a single screen. A controller manages program execution between models and views and commands. What's this command thing? Commands are implementation of the command design pattern. Commands are simply used to represent actions. Thus it is quite typical in MVC implementations to have a view submit data to a command which in turn requests another view to be show all being dispatched by the controller. Is all this fuzzy? No worry, let's look at each piece of MVCnPHP in more detail.

#[[MVCnPHP Installation]]
#[[MVCnPHPController|Using the Controller]]
#[[Building a View]]
#[[Understanding the MVCnPHP Configuration File]]
#[[Building a Command]]
#[[Using Forwards]]

Model-View-Controller

2006-09-19T20:26:41Z

Tony: /* Models, Views, Controllers Defined */

== Model-View-Controller ==

If you don't know what it is, you better ask somebody. Separating the user interface from business logic from data access is a framework essential and is key to making your application easier to maintain. Most MVC implementations break code into atomic units of work that encourage reuse and maintainability. Geeklog 2 uses MVCnPHP to accomplish this.

== MVCnPHP ==

MVCnPHP, Model-View-Controller iN PHP, is a simplified MVC implementation based very loosely off of Phrame and Struts with all the garbage taken out. If you are Struts fan, don't take too much offense as I believe it is a good tool but it aims at doing more than a simple MVC implementation. Phrame similarly is a Struts-like MVC implementation that share many of the same problems in Struts. Since it's release back in 2003 it has kept it's simplicity and has significantly improved performance. From this point on I'm going to assume you know what MVC and are eager to learn how to implement MVCnPHP in your application.

== Models, Views, Controllers Defined ==

Models are the data structures your PHP application will use and they represent the core business components of your business. So, for example, you may very well have models that represent users, accounts and transactions. Models are ideally simple PHP classes that are made up of members and their accessors (i.e. getters/setters). Views are mechanisms used to render one or more models to a users. Views are the visual component and in most basic web development terms are represented by a single screen. A controller manages program execution between models and views and commands. What's this command thing? Commands are implementation of the command design pattern. Commands are simply used to represent actions. Thus it is quite typical in MVC implementations to have a view submit data to a command which in turn requests another view to be show all being dispatched by the controller. Is all this fuzzy? No worry, let's look at each piece of MVCnPHP in more detail.

#[[MVCnPHP Installation]]
#[[X Using the Controller]]
#[[Building a View]]
#[[Understanding the MVCnPHP Configuration File]]
#[[Building a Command]]
#[[Using Forwards]]

Model-View-Controller

2006-09-19T20:26:25Z

Tony: /* Models, Views, Controllers Defined */

== Model-View-Controller ==

If you don't know what it is, you better ask somebody. Separating the user interface from business logic from data access is a framework essential and is key to making your application easier to maintain. Most MVC implementations break code into atomic units of work that encourage reuse and maintainability. Geeklog 2 uses MVCnPHP to accomplish this.

== MVCnPHP ==

MVCnPHP, Model-View-Controller iN PHP, is a simplified MVC implementation based very loosely off of Phrame and Struts with all the garbage taken out. If you are Struts fan, don't take too much offense as I believe it is a good tool but it aims at doing more than a simple MVC implementation. Phrame similarly is a Struts-like MVC implementation that share many of the same problems in Struts. Since it's release back in 2003 it has kept it's simplicity and has significantly improved performance. From this point on I'm going to assume you know what MVC and are eager to learn how to implement MVCnPHP in your application.

== Models, Views, Controllers Defined ==

Models are the data structures your PHP application will use and they represent the core business components of your business. So, for example, you may very well have models that represent users, accounts and transactions. Models are ideally simple PHP classes that are made up of members and their accessors (i.e. getters/setters). Views are mechanisms used to render one or more models to a users. Views are the visual component and in most basic web development terms are represented by a single screen. A controller manages program execution between models and views and commands. What's this command thing? Commands are implementation of the command design pattern. Commands are simply used to represent actions. Thus it is quite typical in MVC implementations to have a view submit data to a command which in turn requests another view to be show all being dispatched by the controller. Is all this fuzzy? No worry, let's look at each piece of MVCnPHP in more detail.

#[[MVCnPHP Installation]]
#[x[Using the Controller]]
#[[Building a View]]
#[[Understanding the MVCnPHP Configuration File]]
#[[Building a Command]]
#[[Using Forwards]]

MVCnPHP Installation

2006-09-19T20:25:16Z

Tony:

== Installing MVCnPHP ==

Installation of MVCnPHP is quite easy. First you need to [http://project.geeklog.net/frs/?group_id=7 get the tarball]. It was built as a [http://pear.php.net PEAR] package so assuming you have [http://www.php.net PHP5] installed you can install MVCnPHP using the PEAR command line:

#>pear install /path/to/mvcnphp_pear_package.tgz

That's it!