orkhan/laraphrases

Inline phrase editing for Laravel apps

Laraphrases!

, _(*1)

, _(*2)

Laraphrases is a package for live editing phrases on websites., _(*3)

Installation

Require the package in your composer.json file, _(*4)

{
    "require": {
        "orkhan/laraphrases": "dev-master"
    },
}

Afterwards, run composer update from your command line., _(*5)

Then, add following to the list of service providers in app/config/app.php, _(*6)

'Orkhan\Laraphrases\LaraphrasesServiceProvider',

and followings to the list of aliases, _(*7)

'Laraphrase' => 'Orkhan\Laraphrases\Facades\Laraphrase',
'Phrase' => 'Orkhan\Laraphrases\Facades\Phrase',

Run the install command which will migrate database and publishes configs, views and assets., _(*8)

artisan laraphrases:install

Setup

The artisan command will generate phrase.php configuration file in app/config/packages/orkhan/laraphrases folder. Here you will need to implement the can_edit filter. Use this to hook-up your existing user authentication system to work with Laraphrases., _(*9)

For example:, _(*10)

    'can_edit' => function() {
        return Sentry::check() && Sentry::getUser()->hasAccess('laraphrases') ? true : false
    },

Include the token meta at the head of your application layout file., _(*11)

<meta name="_token" content="{{ Session::token() }}">

Include the laraphrase blade file at the top of your application layout file., _(*12)

@if(Laraphrase::canEditPhrase())
    @include('laraphrases::laraphrase')
@endif

Include the required jQuery library and Laraphrases javascript file:, _(*13)

{{ Laraphrase::js() }}

Include the required stylesheet file:, _(*14)

{{ Laraphrase::css() }}

How to use Laraphrases?

You can start adding new phrases by simply adding them in your view file:, _(*15)

{{ Laraphrase::get('phrase-key', 'phrase-value-optional-otherwise-value-same-with-key') }}

Aside from editing phrases (basically, Laravel translations) you can also edit model attributes inline. Use the same Laraphrase::get method, with the first attribute being the record in question, and the second one the attribute you wish to make editable:, _(*16)

{{ Laraphrase::get($post, 'title') }}

In the above example, $post is the record with a title attribute., _(*17)

Security

Since Laraphrases can be used to update any attribute in any table, special care must be taken into consideration from a security standpoint., _(*18)

By default, Laraphrases doesn't allow updating of any attribute apart from 'Phrase' => ['value']. To be able to work with other attributes, you need to whitelist them., _(*19)

In the app/config/packages/orkhan/laraphrases/phrase.php file you can whitelist your model attributes like this:, _(*20)

    'white_list' => [
        'Phrase' => ['value'],
        'Post' => ['title', 'summary'],
    ],

Credits

Laraphrases is maintained and sponsored by ORIGAMI AGENCY., _(*21)

, _(*22)

Laraphrases leverages part ZenPen., _(*23)

License

Laraphrases © 2014 ORIGAMI AGENCY. It is free software, and may be redistributed under the terms specified in the LICENSE file., _(*24)