Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[1.0] sfSympalPlugin: Initial entry of README, LICENSE and package.xm…

…l.tmpl

git-svn-id: http://svn.symfony-project.org/plugins/sfSympalPlugin/trunk@16044 ee427ae8-e902-0410-961c-c3ed070cd9f9
  • Loading branch information...
commit f19a8d44029368df95d77ec0dd5da667135fc967 1 parent edb91ff
@jwage jwage authored
Showing with 106 additions and 0 deletions.
  1. +7 −0 LICENSE
  2. +53 −0 README
  3. +46 −0 package.xml.tmpl
View
7 LICENSE
@@ -0,0 +1,7 @@
+Copyright (c) 2006-2009 Jonathan H. Wage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
53 README
@@ -0,0 +1,53 @@
+# sfSympalPlugin
+
+Sympal is an extension of symfony that provides a content management framework layer on top of all the greatness you get with symfony. It is a nice plug n' play architecture so other Sympal plugins can interact with the core and manipulate things with events.
+
+> **NOTE**
+> This plugin requires `sfDoctrinePlugin` so it assumes you have setup your `databases.yml` to work for Doctrine.
+
+## Installing sfSympalPlugin
+
+First you need to install Sympal by installing the `sfSympalPlugin`.
+
+ $ svn co http://svn.symfony-project.com/plugins/sfSympalPlugin/trunk plugins/sfSympalPlugin
+
+## Enabling sfSympalPlugin
+
+The `sfSympalPlugin` is the core plugin that makes up the Sympal core. It contains several other plugins inside that are a part of the core. Because of this enabling `sfSympalPlugin` requires a little extra work by you in your `ProjectConfiguration` class. Open `config/ProjectConfiguration.class.php` in your favorite editor and place the following code in the `setup()` method.
+
+ [php]
+ $sympalPluginPath = realpath(dirname(__FILE__).'/../plugins/sfSympalPlugin');
+ $this->setPluginPath('sfSympalPlugin', $sympalPluginPath);
+
+ $embeddedPluginPath = $sympalPluginPath.'/lib/plugins';
+ $embeddedPlugins = sfFinder::type('dir')->relative()->maxdepth(0)->in($embeddedPluginPath);
+ foreach ($embeddedPlugins as $plugin)
+ {
+ $this->setPluginPath($plugin, $embeddedPluginPath.'/'.$plugin);
+ }
+
+> **NOTE**
+> The above code assumes you placed `sfSympalPlugin` in your plugins folder. If you placed it somewhere else then you will need to adjust the paths above.
+
+## Finish Installation
+
+In order for Sympal to work properly you must have at least one application created. So, if you do not already have an application then create one named `frontend`.
+
+ $ ./symfony generate:app frontend
+
+One small thing we need to do is edit `project/apps/frontend/lib/myUser.class.php` and change the class it extends to be `sfSympalUser`. It should like the following now:
+
+ [php]
+ class myUser extends sfSympalUser
+ {
+ }
+
+After doing all of the above be sure to publish your plugin assets:
+
+ $ ./symfony plugin:publish-assets
+
+Now we are ready to finish up and run the install task for Sympal:
+
+ $ ./symfony sympal:install
+
+The above task will initialize your database for Sympal and setup a basic site. Now you should be able to pull the frontend application up in your web browser and you will see the default Sympal site.
View
46 package.xml.tmpl
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://pear.php.net/dtd/package-2.0" xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" packagerversion="1.4.1" version="2.0" xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0 http://pear.php.net/dtd/tasks-1.0.xsd http://pear.php.net/dtd/package-2.0 http://pear.php.net/dtd/package-2.0.xsd">
+ <name>sfSympalPlugin</name>
+ <channel>pear.symfony-project.com</channel>
+ <summary>Test</summary>
+ <description>Test</description>
+ <lead>
+ <name>Jonathan H. Wage</name>
+ <user>jwage</user>
+ <email>jonwage@gmail.com</email>
+ <active>yes</active>
+ </lead>
+ <date>##CURRENT_DATE##</date>
+ <version>
+ <release>##PLUGIN_VERSION##</release>
+ <api>##API_VERSION##</api>
+ </version>
+ <stability>
+ <release>##STABILITY##</release>
+ <api>##STABILITY##</api>
+ </stability>
+ <license uri="http://www.symfony-project.org/license">MIT license</license>
+ <notes>-</notes>
+ <contents>
+ ##CONTENTS##
+ </contents>
+ <dependencies>
+ <required>
+ <php>
+ <min>5.2.4</min>
+ </php>
+ <pearinstaller>
+ <min>1.4.1</min>
+ </pearinstaller>
+ <package>
+ <name>symfony</name>
+ <channel>pear.symfony-project.com</channel>
+ <min>1.2.0</min>
+ <max>1.3.0</max>
+ <exclude>1.3.0</exclude>
+ </package>
+ </required>
+ </dependencies>
+ <phprelease></phprelease>
+ <changelog></changelog>
+</package>
Please sign in to comment.
Something went wrong with that request. Please try again.