dioscouri / f3-lib Goto Github PK

PHP 95.43% JavaScript 4.57%

f3-lib's Introduction

f3-lib

A library for the F3 framework a link, The library is designed to use fatfree as a strong base, and add on top it the files and functions to quickly create applications. There is a strong community of apps, for solving common problems.

The Library is standalone and be quickly added to your repo using composer

Add this to your project's composer.json file:

{
    "require": {
        "dioscouri/f3-lib": "dev-master"
    }
}

Then add the following two lines to your index.php file, immediately before $app->run();

// bootstap each mini-app
\Dsc\Apps::instance()->bootstrap();

// trigger the preflight event
\Dsc\System::instance()->preflight();

Example index.php file

<?php
//AUTOLOAD all your composer libraries now.
(@include_once (__dir__ . '/../vendor/autoload.php')) OR die("You need to run php composer.phar install for your application to run.");
//Require FatFree Base Library https://github.com/bcosca/fatfree
$app = Base::instance();
//Set the PATH so we can use it in our apps
$app->set('PATH_ROOT', __dir__ . '/../');
//This autoload loads everything in apps/* and 
$app->set('AUTOLOAD',  $app->get('PATH_ROOT') . 'apps/;');
//load the config files for enviroment
require $app->get('PATH_ROOT') . 'config/config.php';
//SET the "app_name" or basically the instance so we can server the admin or site from same url with different loaded classes
$app->set('APP_NAME', 'site');
if (strpos(strtolower($app->get('URI')), $app->get('BASE') . '/admin') !== false)
{
    $app->set('APP_NAME', 'admin');
    //stupid javascript bugs with debug off
    $app->set('DEBUG', 1);
}
// bootstap each mini-app  these are in apps folder, as well as in vender/dioscouri
\Dsc\Apps::instance()->bootstrap();
// load routes; Routes are defined by their own apps in the Routes.php files
\Dsc\System::instance()->get('router')->registerRoutes();
// trigger the preflight event PreSite, PostSite etc
\Dsc\System::instance()->preflight();
//excute everything.
$app->run();

apps

The library is designed to bootstrap "apps" apps are just a group of code that bundles features, example, f3-blog will give you a simple blogging platform to your application.

Your, Theme, and custom site would be built to your needs as custom apps.

a default folder structure is like this

/apps /config /public /tmp

your index.php files lives in public, as public is the only web accessible folder.

[TODO ] detail how to build custom apps

THEME

DETAIL CUSTOM THEMES

WEB SERVERS

add configs to NGINX AND APACHE

f3-lib's People

Contributors

Stargazers

Watchers

Forkers

chrisfrench eazuka drakh bosoy83 rgrgx salomalo mindfulvector

f3-lib's Issues

Images with a parenthesis in the name fail to upload

Trigger before & after events in the base model's save() function

Move Assets to a standalone mini-app

Right now it's loosely coupled with the Blog

Feature: Look into a default structure for docments controlled by the model

SO either,

We define the document fields in the model or some other class for the document.

example would be the menu items, and the quick add. you post the url and the name and the default fields are saved from the pre defined structure.

metadta.created is always updated

Value in created field is always updated (even upon update)

Assets: Allowing changing the upload directory via f3 uploads dir

F3 has and uploads global, set like this

$f3->set('UPLOADS','uploads/');

It would be best I think to make assets get the loads dir, from here.

You can have it set in the config file, and get can get received like \F3::get('UPLOADS');

Rename methods in Traits\Controllers\AdminList to avoid conflicts, especially with \Traits\Crud

Make \Dsc\System\addMessage use \Dsc\Session

Right now, error messages on the front-end will display in the admin since the messages aren't being namespaced by site...

Don't trigger Listener events on certain model saves

Maybe create a store() method for use when no listeners should be triggered, e.g. when logging

Template: render() needs to support a base path to avoid conflicts

Need some way to designate which view path should be used. e.g. multiple mini-apps may have a categories/list.php view, so how is the template supposed to know which to render

Add chunk support to file uploader

http://blog.fineuploader.com/2012/12/28/file-chunkingpartitioning-is-now-available-in-3-2/
http://docs.fineuploader.com/features/chunking.html

Is a workaround for uploading really large files when the max upload size on a server is small

Add groups to Users mini-app

Just groups, not permissions

Make \Dsc\Models::set() return $this

Add \Dsc\Request for simple HMVC requests

Update the Nested model so it's not using the mapper class

triple loading apps again

the apps seem to be triple loading again, adding a message to runAdmin, etc runs 3 times

separate model states based on Global_app_name

admin-side states are impacting front-end searches...

Traits\CrudItem: USING REQUEST causing saving of non important information.

Example. $data = \Base::instance()->get('REQUEST');

Confirmed changing to POST fixes the problem but maybe we want to use the

BASE::instance()->hive['VERB'] in a way to allow GET|POST|PUT whatever into that

Traits\CrudItem: Add support for a custom redirect after save

a base64_encoded() variable in the request would serve as the redirect url

Add a way to extend all views via plugins

CATEGORIES: update function should update children recursively

both for a move and a title change

Assets: Amazon S3 should only display if all required config settings exist

Add Settings to each mini-app

Since each mini-app has its own bootstrap file, the bootstrap file can be responsible for adding the app's config settings to the \Base::instance()

So where necessary, add a Settings menu item to each mini-app, write the settings to the app's own config file (or store in jig, i don't care), and make the bootstrap file load the settings

Make categories use the publishable trait

Pagination in footer does not reflect filtering

If you filter list of items (filter keyword "test" in list of users), you can still see:
"1 - 3 of 3"

at the footer of table

Add ACL/Permissions to users mini-app

Make the collections extend the new base Models class

Add ability to override view/layouts

This one's for you, @ChrisFrench !

CATEGORIES and NESTED: store objectid references as an objectid, not a string

http://stackoverflow.com/questions/11795136/mongodb-objectid-references

A string takes up 2x as much space as an objectid

Finish the editing form for assets

Display the image
Add caption/alt-text/description input fields

Update the Queue Model so it uses Collection

Blog: If a category is deleted, remove it from any nested 'categories' documents

See the categories model

Check pagination on nginx

Chris says its adding another page/ to the urls

Move the /public/dsc folder into the lib's Assets folder and create a symlink

Also, move any f3-admin JS functions into the f3-admin and out of the common.js file

Decouple \Dsc\Flash from the SESSION

It prevents the storage of database items that may contain binary data when you're using Mongo (and perhaps other engines) as the session store

Assets: After an asset is deleted or updated, update all referring documents

Maybe just trigger an event in the update and delete methods of the base model? Let each app handle the updates/deletes via their listener rather than via extending the base model

Get rid of old traits

There is a few old traits for old models and controllers using them. I think we should delete them during another clean up phase.

Trigger an event after all apps have loaded

Or alternatively, create a super-simple way to trigger system events. At the very least, I can think of a need for an event right before the application is run

Run custom script after composer install

I was thinking of the install situation and I found that composer can run a static php function

so we could do something like

"post-install-cmd": "Dsc\installer::install"

which could create all the folders and stuff that might be needed.

Fix \Mongo\Collections\Categories

the slug isn't generated correctly.

Blog: If the title of the category has changed, update all posts using this category

See the categories model

Add generic reordering method

Maybe make it part of traits\adminlist and the base model

Add ability to specify custom additional paths for bootstrapping apps

Convert $f3->route() to $this->setRedirect() in all Crud and CrudItem functions

These functions need to be extendable such that child methods can reference them and override the redirect targets better

Add ability to assign featured image to blog posts

debug \Dsc\Bootstrap::preSite (and maybe other methods)

It looks like at least the preSite() method is triggered more than once for each app. Here's how you can replicate the issue:

Edit any of the bootstrap files for any of the apps.
add a preSite() method if it doesn't already have one
set the content of preSite() to output something, such as

\Dsc\System::addMessage( \Dsc\Debug::dump( 'this is the XXXX app') );

refresh your front-end

You will see the message multiple times. Why is that happening? If we're bootstrapping the apps multiple times each page load and/or triggering these methods multiple times per page load, we're creating useless overhead...

Reordering seems broken

Internal Server Error

Argument 1 passed to Admin\Controllers\Menu::doMoveUp() must be of the type array, object given, called in /var/www/buildingbermsgroup.com/vendor/dioscouri/f3-lib/src/Dsc/Traits/Controllers/OrderableItemCollection.php on line 21 and defined

• /var/www/buildingbermsgroup.com/vendor/dioscouri/f3-admin/src/Admin/Controllers/Menu.php:84 Base->{closure}()
• /var/www/buildingbermsgroup.com/vendor/dioscouri/f3-lib/src/Dsc/Traits/Controllers/OrderableItemCollection.php:21 Admin\Controllers\Menu->doMoveUp()
• /var/www/buildingbermsgroup.com/vendor/bcosca/fatfree/lib/base.php:1294 Base->call()
• index.php:37 Base->run()

atleast in navigation but since it is a trait I am putting the ticket here

Busy on something else now will come back to this