Evan Winslow ewinslow

Great documentation makes great projects, so of course we want Elgg to have high quality, up-to-date documentation. We'd love your help making that a reality.

Our vision

Documentation should help you get stuff done, so we're embarking on a full rewrite of our docs to optimize for that goal. When writing the new docs, we'll:

Focus on common tasks
Eliminate the blah-blah
Write thorough, task-oriented articles
Include plenty of copy-pasteable code samples

Actions

Actions define the behavior of forms.

Defining an action

Map the action name to the action controller in your plugin's actions.php:

Introduction

ES6 classes are happening, and there's no way the syntax is going to change radically just for me this late in the game, but I still figure what the heck. Maybe I can write a language someday that has this feature. Or maybe I'm wrong and the feature can change with enough motivation...

Background

The main premise of the currently accepted syntax is to be simple sugar over the prototype style of class definitions:

function Foo() {

	inherit = function(Child, Parent) {
	Child.prototype = new Parent();
	Child.prototype.constructor = Child;
	Child.prototype.super_ = function(methodName) {
	// Special case: calling from constructor
	if (arguments.caller.callee.prototype.super_) {
	return Parent.apply(this, arguments);
	}

	var varArgs = Array.prototype.slice.call(arguments, 1);

	{
	"// New idea for routing": "",
	"routes": {
	"site/activity": {
	"// The url (or array of urls) that trigger this route": "",
	"paths": "/activity",

	"// Calls `get()` on an instance of this class and passes to page shell and body as `$vars`": "",
	"controller": "Elgg_Site_ActivityController",

	<?php

	/**
	* An ordered collection.
	*
	* could call it "Sequence"
	*
	* @generic V
	*/
	interface List extends Collection {

	<?php
	namespace Elgg\Schema;

	/**
	* A facade for tersely instantiating all the different types of columns
	*/
	class Column {
	public static function bool(): BoolColumn {}

	public static function blob(int $size): BlobColumn {}

	<?php
	class ElggQueryString {
	// TODO(evan): implement
	}