Giter Site home page Giter Site logo

flatfile's Introduction

Flatfile

A simple Flatfile ORM

How to use it

This is a example with a Welcome controller.

Create your model

Create a page model:

| application
	| classes
		| Model
			Page.php

In your model:

class Model_Page extend Flatfile {
	
	/**
	* Somes filters
	*
	* @return array
	**/

	public function filters()
	{
		return array(
			array(
				'content' => array('Flatfile::Markdown'),
			),
		);
	}
}

Create your content

In your root project:

| content
	| pages
		hello-world.md

In your hello-world file:

title: Hi!
---
Hello **World**

Grab your content

Create your controller

| application
	| classes
		| Controller
			Welcome.php

In your controller, in classic Kohana MVC design pattern

class Controller_Welcome extends Controller {
	
	/**
	* Action call by defaults
	*
	* @return void
	**/
	
	public function action_index()
	{
		$view = View::factory('welcome/index')
			->bind('page', $page);
		$page = new Model_Page('hello-world');
		$this->response->body($view);
	}
}

Show your content

Create your View

| application 
	| views
		| welcome
			index.php

In your view index

<html>
	<head>
		<title>
			<?php echo $page->title; ?>
		</title>
	</head>
	<body>
		<?php echo $page->content; ?>
	</body>
</html>

The result

<html>
	<head>
		<title>Hi!</title>
	</head>
	<body>
		Hello <strong>World</strong>	
	</body>
</html>

Filters

Similar usage to Kohana ORM.

Flatfile embed a specifics filters :

Markdown

Process a Markdown transformation.

str_to_list

Convert a comma separate list to an array of term and slug.

For example :

tags: Laitue, Choux rouge

Be converted to

array(
	array(
		'name'	=> 'Laitue',
		'slug'	=> 'laitue',
	),
	array(
		'name'	=> 'Choux rouge',
		'slug'	=> 'choux-rouge',
	),
)

Usefull, for example, to create a list of tags; in your view :

<uL>
<?php foreach($page->tags as $tag): ?>
	<li>
		<a href="http://my_awesome_blog.com/posts/tag/<?php echo $tag['slug']; ?>">
			<?php echo $tag['name']; ?>
		</a>
	</li>
<?php endforeach; ?>
</ul>

json_api

Give him a json API service address, it will return a result ready to use.

For example :

bloginfo: https://api.tumblr.com/v2/blog/blogdamientran.tumblr.com/info?api_key=fuiKNFp9vQFvjLNvx4sUwti4Yb5yGutBN4Xh10LXZhhRKjWlV4

Resulting to

stdClass Object
(
	[blog] => stdClass Object
	(
		[title] => Damien Tran
		[name] => blogdamientran
		[posts] => 66
		[url] => http://blogdamientran.tumblr.com/
		[updated] => 1434963170
		[description] => damientran.com - palefroi.net
		[is_nsfw] => 
		[ask] => 
		[ask_page_title] => Ask me anything
		[ask_anon] => 
		[share_likes] => 1
		[likes] => 6
	)
)

You can use the result in your view

<a href="<?php echo $page->bloginfo->blog->url; ?>">
	See the blog <?php echo $page->bloginfo->blog->title; ?>
</a>

Flatfile methods

Flatfile contain somes usefull methods

order

query

Operators

like

Multiple queries

date and slug

offset

limit

find

find_all

flatfile's People

Contributors

ziopod avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

flatfile's Issues

Filters

Add somes metas filters for metas.

Class like that :

Filter (extend Flatfile_Filter)
Flatfile
 - Filter.php

Examples filters :

  • Filter::list (return array of items list)
  • Filter::tags (return array of terms with slug and default URL)
  • Filter::items (return array of property/value terms)
  • Filter::api (run API url and return result)
  • Filter::parts (load and return Flatfile)
  • Filter::markdown (return a Markdown formated text)

Enhance queries

Enhance Flafile queries. FF can't process multiple queries, ex. :

 Flatfile::factory('event')
    ->query('date', '>=', date('Y-m-d'))
    ->query('featured', '=', TRUE) // This one does not work
    ->find_all();

Redudant methods

_extract_slug method do similar job as _extract_date. Do only one method for parsing filename and store results on properties (date, slug and extension).

Properties can be use by others methods (like _valid_flatfile)

Add configuration loader

We need to have possibility to change some configuration values.

Like :

  • content directory path ;
  • add front matter before separator. We need a --- before and after front matter ;
  • front matter separator. Actually --- ;
  • filename meta separator. Actually _ (YYYY-MM-DD_slug.md) ;
  • Markdown file extension.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.