Skip to content

Janis / btflags

Go to a project
Toggle navigation
Toggle navigation pinning
5989b17c by Joshua Tundag
Options

add examples

1 parent 48468437
Inline Side-by-side
Showing 6 changed files with 739 additions and 0 deletions
README.md
......@@ -113,3 +113,5 @@ flag('mode');
flag('source');
flag('pmt', 'rec');
```
[See example for more snippets.](/examples)
\ No newline at end of file
......
examples/Api.php 0 → 100644
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
class Api extends MY_Controller{
public function __construct() {
parent::__construct();
$this->authenticate_admin_user(false);
$admin_data = admin_data();
if(!$this->authenticate_administrator_role($admin_data)){
/*** Guest redirect ***/
$this->admin_user_guest($admin_data);
/*** Support redirect ***/
$this->admin_user_support($admin_data);
}
$this->load->library('form_validation');
}
public function get_flags_for_table(){
$tableOptions = $this->input->get();
$flagManager = new \BTFlags\FlagManager();
$table = array();
$tableOptions['sortBy'] = 'DESC';
if($tableOptions['sortOrder'] && strpos($tableOptions['sortOrder'], '+') === 0){
$tableOptions['sortOrder'] = substr($tableOptions['sortOrder'], 1);
$tableOptions['sortBy'] = 'ASC';
}
$tableOptions['filter'] = isset($tableOptions['filter']) ? $tableOptions['filter'] : '';
$tableOptions['mode'] = isset($_COOKIE['mode']) ? $_COOKIE['mode'] : 'live';
$table['data'] = $flagManager->getAllForTable($tableOptions);
$scope = $this;
$table['total'] = $flagManager->getAllCountForTable($tableOptions);
$table['per_page'] = (int)$tableOptions['perPage'];
$table['current_page'] = (int)$tableOptions['page'];
$table['sort'] = $tableOptions['sortOrder'];
$table['last_page'] = ceil($table['total'] / $table['per_page']);
$table['next_page_url'] = 'api/get_permissions_for_table?page=' . ($tableOptions['page'] + 1);
$table['prev_page_url'] = null;
$table['from'] = (((int)$tableOptions['page'] - 1) * $table['per_page']) + 1;
$table['to'] = ((((int)$tableOptions['page']) * $table['per_page']) < $table['total']) ? ((int)$tableOptions['page']) * $table['per_page'] : $table['total'];
$this->output->set_content_type('application/json');
echo json_encode($table);
die;
}
public function create_flag(){
$requestData = json_decode(file_get_contents('php://input'), true);
$this->form_validation->set_data($requestData);
$this->form_validation->set_rules('name', 'Flag Name', 'required');
$this->form_validation->set_rules('encrypted_name', 'Encrypted Name', 'required');
if($this->form_validation->run() == false){
echo json_encode(['success' => false, 'errors' => array_values($this->form_validation->error_array())]);
die;
}
$flagManager = new \BTFlags\FlagManager();
$created = $flagManager->create($requestData);
if(!$created) die(json_encode(['success' => false, 'errors' => $flagManager->errors()]));
$log_data = array(
'date_created' => ph_time(),
'event' => 'Create Flag',
'description' => 'Flag Name: ' . $requestData['name'],
);
$add_log = insert_admin_log($log_data);
echo json_encode(['success' => true, 'message' => 'Flag successfully created!']);
die;
}
/**
* Update a flag
* @return void
*/
public function update_flag(){
$requestData =json_decode(file_get_contents('php://input'), true);
$this->form_validation->set_data($requestData);
$this->form_validation->set_rules('name', 'Flag Name', 'required');
$this->form_validation->set_rules('encrypted_name', 'Encrypted Name', 'required');
if($this->form_validation->run() == false){
echo json_encode(['success' => false, 'errors' => array_values($this->form_validation->error_array())]);
die;
}
$flagManager = new \BTFlags\FlagManager();
$updated = $flagManager->update($requestData);
if(!$updated) die(json_encode(['success' => false, 'errors' => $flagManager->errors()]));
$log_data = array(
'date_created' => ph_time(),
'event' => 'Update Flag',
'description' => 'Flag Name: ' . $requestData['name'],
);
$add_log = insert_admin_log($log_data);
echo json_encode(['success' => true, 'message' => 'Flag successfully updated!']);
die;
}
/**
* Delete a flag
* @return void
*/
public function delete_flag(){
$requestData = json_decode(file_get_contents('php://input'), true);
$flagManager = new \BTFlags\FlagManager();
$deleted = $flagManager->delete($requestData);
if(!$deleted) die(json_encode(['success' => false, 'errors' => $flagManager->errors()]));
$log_data = array(
'date_created' => ph_time(),
'event' => 'Delete Flag',
'description' => 'Flag Name: ' . $requestData['name'],
);
$add_log = insert_admin_log($log_data);
echo json_encode(['success' => true, 'message' => 'Flag successfully deleted!']);
die;
}
}
\ No newline at end of file
examples/Flag.php 0 → 100644
<?php
class Flag{
public function register(){
$flagManager = new \LawFormsUSA\Flags\FlagManager();
$flagManager->register();
}
}
\ No newline at end of file
examples/Table.vue 0 → 100644
<script>
import FlagsService from './../services/Flags';
export default {
props: {
errorPosition: {
default: 'static'
}
},
created(){
},
data(){
return {
isEditing: false,
dialogPostFormVisible: false,
selected: null,
flag: {
name: null,
is_encrypted: true,
is_filtered: true,
encrypted_name: null,
has_default: false,
default: null,
accepted_values: [
{
value: null,
encrypted_value: null
}
]
},
errors: [],
tableOptions: {
perPage: 10,
columns: [
{
name: 'name',
sortField: 'flags.name',
title: 'Flag Name',
titleClass: 'text-center',
dataClass: 'text-left'
},
{
name: 'encrypted_name',
sortField: 'flags.encrypted_name',
title: 'Encrypted Flag Name',
titleClass: 'text-center',
dataClass: 'text-left'
},
{
name: 'combined_values',
sortField: 'flags.combined_values',
title: 'Accepted Values',
titleClass: 'text-center',
dataClass: 'text-left'
},
{
name: 'default',
sortField: 'flags.default',
title: 'Default Value',
titleClass: 'text-center',
dataClass: 'text-left'
},
{
name: '__slot:actions',
title: 'Actions',
titleClass: 'text-center',
dataClass: 'text-center table-padding'
}
],
css: {
tableClass: 'table table-bordered table-hover table-striped',
loadingClass: 'loading',
ascendingIcon: 'fa fa-caret-up',
descendingIcon: 'fa fa-caret-down',
detailRowClass: 'vuetable-detail-row',
sortHandleIcon: 'grey sidebar icon'
}
},
loading: false,
sortOrder: [
{
field: 'flags.name',
direction: 'desc'
}
],
moreParams: {
filter: null,
date_range: '',
date_from: null,
date_to: null,
},
paginationCss: {
wrapperClass: 'col-md-6 text-right',
activeClass: 'active large',
disabledClass: 'disabled',
pageClass: 'item',
linkClass: 'icon item',
paginationClass: 'pagination-box pagination',
paginationInfoClass: 'col-md-6',
icons: {
first: 'fa fa-angle-double-left',
prev: 'fa fa-chevron-left',
next: 'fa fa-chevron-right',
last: 'fa fa-angle-double-right'
}
},
paginationInfoClass: 'col-md-6',
tmpDateTo: null,
tmpDateFrom: null,
total: 0
};
},
methods: {
__capitalize(str){
return str.replace(/\b\w/g, (l) => l.toUpperCase());
},
onPaginationData(paginationData){
this.$refs.pagination.setPaginationData(paginationData);
this.$refs.paginationInfo.setPaginationData(paginationData);
},
onChangePage(page){
this.$refs.vuetable.changePage(page);
},
setFilter(){
this.moreParams = {
filter: this.moreParams.filter
};
this.$nextTick(() => {
this.$refs.vuetable.refresh();
});
},
resetFilter(){
this.moreParams.filter = '';
this.setFilter();
},
getSortParam: function(sortOrder) {
return sortOrder.map(function(sort) {
return (sort.direction === 'desc' ? '+' : '') + sort.field
}).join(',')
},
togglePostFormModal(){
this.resetFields();
this.isEditing = false;
this.dialogPostFormVisible = true;
},
_checkIfFlagIsEncrypted(){
if(!this.flag.is_encrypted){
this.flag.encrypted_name = this.flag.name
_.map(this.flag.accepted_values, (value) => {
value.encrypted_value = value.value
})
}
},
_checkIfFlagIsFiltered(){
if(!this.flag.is_filtered) this.flag.accepted_values = [
{
value: null,
encrypted_value: null
}
]
},
_checkIfFlagHasDefaultValue(){
if(this.flag.is_filtered) return false
if(!this.flag.has_default) this.flag.default = null;
},
createFlag(){
this.loading = true;
this.errors = [];
this._checkIfFlagIsFiltered();
this._checkIfFlagIsEncrypted();
this._checkIfFlagHasDefaultValue();
FlagsService.create(this.flag)
.then(({data}) => {
data = typeof data == 'string' || data instanceof String ? JSON.parse(data) : data;
if(!data.success){
this.loading = false;
this.errors = data.errors;
return false;
}
this.resetFields();
this.dialogPostFormVisible = false;
this.loading = false;
this.errors = [];
this.$notify({
title: 'Success',
message: data.message,
type: 'success'
});
this.$nextTick(() => {
this.$refs.vuetable.reload();
});
});
},
toggleEdit(flag){
this.showWarningMessage();
this.isEditing = true;
this.resetFields();
this.dialogPostFormVisible = true;
this.flag = Object.assign(
JSON.parse(JSON.stringify(flag)),
{
old_name: flag.name,
old_encrypted_name: flag.encrypted_name
}
);
},
update(){
this.loading = true;
this.errors = [];
this._checkIfFlagIsFiltered();
this._checkIfFlagIsEncrypted();
this._checkIfFlagHasDefaultValue();
FlagsService.update(this.flag)
.then(({data}) => {
if(!data.success){
this.loading = false;
this.errors = data.errors;
return false;
}
this.resetFields();
this.dialogPostFormVisible = false;
this.isEditing = false;
this.loading = false;
this.errors = [];
this.$notify({
title: 'Success',
message: data.message,
type: 'success'
});
this.$nextTick(() => {
this.$refs.vuetable.reload();
});
});
},
toggleDelete(flag){
this.showWarningMessage();
this.selected = flag;
this.$refs.deleteConfirmationModal.open();
},
cancelDelete(){
this.selected = null;
this.$refs.deleteConfirmationModal.close();
},
remove(){
this.loading = true;
FlagsService.delete(this.selected)
.then(({data}) => {
this.loading = false;
this.selected = null;
this.$refs.deleteConfirmationModal.close();
if(!data.success){
this.$notify({
title: 'Error',
message: data.message,
type: 'error'
});
return false;
}
this.$notify({
title: 'Success',
message: data.message,
type: 'success'
});
this.$nextTick(() => {
this.$refs.vuetable.reload();
});
});
},
resetFields(){
this.flag = {
name: null,
is_encrypted: true,
is_filtered: true,
encrypted_name: null,
has_default: false,
default: null,
accepted_values: [
{
value: null,
encrypted_value: null
}
]
}
},
addFlagValue(){
this.flag.accepted_values.push({
value: null,
encrypted_value: null
})
},
removeFlagValue(index){
this.flag.accepted_values.splice(index, 1)
},
copyNameIfNotEncrypted(){
if(!this.flag.is_encrypted) this.flag.encrypted_name = this.flag.name
},
copyValueOfIfNotEncrypted(acceptedValue){
if(!this.flag.is_encrypted) acceptedValue.encrypted_value = acceptedValue.value
},
showWarningMessage(){
this.$refs.moreWarningModal.open();
}
},
watch: {
dialogPostFormVisible(to){
if(!to) this.errors = [];
},
'flag.is_filtered'(to, from){
this.flag.has_default = false
if(!from) this.flag.default = null;
},
'flag.default'(to, from){
if(to) this.flag.has_default = true
},
'flag.has_default'(to, from){
if(!to) this.flag.default = null;
}
}
}
</script>
<template>
<div id="lfusa-flag-table">
<lfusa-loading-overlay :loading="loading"></lfusa-loading-overlay>
<div class="row">
<div class="col-md-8">
<!-- label / search -->
<div class="filter-field">
<div class="input-group input-group-sm">
<span class="input-group-addon" id="sizing-addon3"><i class="fa fa-search"></i></span>
<input type="text" placeholder="Search" class="form-control" id="search" @keypress.enter="setFilter" v-model="moreParams.filter">
</div>
</div>
<!-- /label / search -->
<div class="clearfix"></div>
</div>
<div class="col-md-4">
<button type="button" class="btn btn-default btn-success btn-md pull-right" @click="togglePostFormModal">Create</button>
</div>
</div>
<vuetable ref="vuetable"
api-url="/admin/api/get_flags_for_table"
:fields="tableOptions.columns"
:query-params="{ sort: 'sortOrder', page: 'page', perPage: 'perPage' }"
:css="tableOptions.css"
:sort-order="sortOrder"
:per-page="tableOptions.perPage"
:append-params="moreParams"
pagination-path=""
@vuetable:loading="loading = true"
@vuetable:load-success="loading = false"
@vuetable:pagination-data="onPaginationData">
<template slot="actions" scope="props">
<div class="table-button-container" v-if="!parseInt(props.rowData.is_default)">
<div class="btn-group">
<button
type="button"
class="btn btn-xs btn-success dropdown-toggle"
data-toggle="dropdown"
aria-haspopup="true"
aria-expanded="false">
More
<span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li>
<a href="#" @click="toggleEdit(props.rowData)">
<i class="fa fa-pencil"></i>
Edit
</a>
</li>
<li>
<a href="#" @click="toggleDelete(props.rowData)">
<i class="fa fa-trash"></i>
Delete
</a>
</li>
</ul>
</div>
</div>
</template>
</vuetable>
<div class="table-pagination">
<vuetable-pagination-info ref="paginationInfo" :css="{ infoClass: 'col-md-6' }"></vuetable-pagination-info>
<vuetable-pagination
ref="pagination"
@vuetable-pagination:change-page="onChangePage"
:css="paginationCss"></vuetable-pagination>
<div class="clearfix"></div>
</div>
<el-dialog :title="isEditing ? 'Edit Flag' : 'Create New Flag'" :close-on-click-modal="false" class="field-options-dialog" v-model="dialogPostFormVisible">
<form @submit.prevent action="#">
<div class="panel panel-danger" :class="errorPosition" v-if="errors && errors.length">
<div class="panel-body">
<ul>
<li class="text-left text-danger error-text" v-for="(error, index) in errors" :key="index">
{{ error }}
</li>
</ul>
</div>
</div>
<div class="form-group">
<div class="row">
<div class="col-xs-12">
<label for="is_encrypted">
Encrypted? <el-switch
v-model="flag.is_encrypted"
on-color="#13ce66"
off-color="#ff4949"
on-text="Yes"
off-text="No"
:width="68">
</el-switch>
</label>
<label for="is_encrypted">
Filtered? <el-switch
v-model="flag.is_filtered"
on-color="#13ce66"
off-color="#ff4949"
on-text="Yes"
off-text="No"
:width="68">
</el-switch>
</label>
<label for="is_encrypted" v-if="!flag.is_filtered">
Has Default Value? <el-switch
v-model="flag.has_default"
on-color="#13ce66"
off-color="#ff4949"
on-text="Yes"
off-text="No"
:width="68">
</el-switch>
</label>
</div>
</div>
</div>
<div class="form-group">
<div class="row">
<div :class="{ 'col-xs-10': !flag.is_encrypted , 'col-xs-5': flag.is_encrypted, 'col-xs-12': !flag.is_encrypted && !flag.is_filtered}">
<label for="flag_name" class="control-label">Flag Name:</label>
<input type="text"
name="flag_name" id="flag_name"
class="form-control interview-control -text round-field"
v-model="flag.name"
@input="copyNameIfNotEncrypted"
autocomplete="off">
</div>
<div class="encryption-arrows" v-if="flag.is_encrypted">
<div class="text-center" style="margin-top: 36px;">
<i class="fa fa-arrows-h" style="font-size: 1.5em;font-weight: 300;"></i>
</div>
</div>
<div class="col-xs-5" v-if="flag.is_encrypted">
<label for="encrypted_name" class="control-label">Encrypted Flag Name:</label>
<input type="text" name="encrypted_name" id="encrypted_name" class="form-control interview-control -text round-field" v-model="flag.encrypted_name" autocomplete="off">
</div>
</div>
</div>
<div class="form-group" v-if="flag.has_default && !flag.is_filtered">
<div class="row">
<div class="col-xs-12">
<label for="accepted_value" class="control-label">Default Value:</label>
<input type="text"
name="accepted_value"
id="accepted_value"
class="form-control interview-control -text round-field"
v-model="flag.default"
autocomplete="off">
</div>
</div>
</div>
<div class="form-group"
v-for="(accepted_value, index) in flag.accepted_values"
:key="index"
v-if="flag.is_filtered">
<div class="row">
<div :class="{ 'col-xs-10': !flag.is_encrypted , 'col-xs-5': flag.is_encrypted}">
<label for="accepted_value" class="control-label">Value:</label>
<label :for="`as_default_${index}`" class="pull-right">
Set as Default
<input type="checkbox"
v-model="flag.default"
:true-value="accepted_value.encrypted_value"
:false-value="null"
:name="`as_default_${index}`"
:id="`as_default_${index}`">
</label>
<input type="text"
name="accepted_value"
id="accepted_value"
class="form-control interview-control -text round-field"
v-model="accepted_value.value"
@input="copyValueOfIfNotEncrypted(accepted_value)"
autocomplete="off">
</div>
<div class="encryption-arrows" v-if="flag.is_encrypted">
<div class="text-center" style="margin-top: 36px;">
<i class="fa fa-arrows-h" style="font-size: 1.5em;font-weight: 300;"></i>
</div>
</div>
<div class="col-xs-5" v-if="flag.is_encrypted">
<label for="encrypted_accepted_value" class="control-label">Encrypted Value:</label>
<input type="text" name="encrypted_accepted_value" id="encrypted_accepted_value" class="form-control interview-control -text round-field" v-model="accepted_value.encrypted_value" autocomplete="off">
</div>
<div style="margin-top: 26px;">
<button type="button"
class="btn btn-md btn-success"
@click="addFlagValue"
v-if="index == (flag.accepted_values.length - 1)">
<i class="fa fa-plus"></i>
</button>
<button type="button"
class="btn btn-md btn-danger"
@click="removeFlagValue(index)"
v-if="index > 0">
<i class="fa fa-minus"></i>
</button>
</div>
</div>
</div>
</form>
<span slot="footer" class="dialog-footer">
<el-button @click="dialogPostFormVisible = false">Cancel</el-button>
<el-button type="primary" @click="createFlag" v-if="!isEditing">Create</el-button>
<el-button type="primary" @click="update" v-else>Save</el-button>
</span>
</el-dialog>
<sweet-modal icon="warning" ref="deleteConfirmationModal" hide-close-button blocking overlay-theme="dark" modal-theme="dark">
Are you sure you want to delete this flag?
<div slot="button">
<button type="button" class="btn btn-md modal-btn -default" @click="cancelDelete" v-if="!loading">No</button>
<button type="button" class="btn btn-md modal-btn -danger" @click="remove">Yes</button>
</div>
</sweet-modal>
<sweet-modal icon="warning" ref="moreWarningModal" hide-close-button overlay-theme="dark" modal-theme="dark">
This may have impact on existing campaigns.
</sweet-modal>
</div>
</template>
<style lang="sass">
#lfusa-flag-table {
.interview-control.-text {
height: 40px;
font-size: 14px;
}
.dropdown-menu{
min-width: 90px;
}
.vuetable-pagination-info{
.btn-nav.icon.item.disabled:first-child,
.btn-nav.icon.item.disabled:nth-child(2){
margin-right: -5px;
}
.btn-nav.icon.item.disabled:last-child,
.btn-nav.icon.item.disabled:nth-last-child(2){
margin-left: -5px;
}
}
.encryption-arrows{
display: inline-block;
float: left;
}
}
</style>
\ No newline at end of file
examples/hooks.php 0 → 100644
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
/*
| -------------------------------------------------------------------------
| Hooks
| -------------------------------------------------------------------------
| This file lets you define "hooks" to extend CI without hacking the core
| files. Please see the user guide for info:
|
| https://codeigniter.com/user_guide/general/hooks.html
|
*/
$hook['post_controller_constructor'][] = array(
'class' => 'Flag',
'function' => 'register',
'filename' => 'Flag.php',
'filepath' => 'hooks',
);
\ No newline at end of file
examples/utility_helper.php 0 → 100644
<?php
if (!function_exists('flag')){
function flag($flag, $default = null, $encrypted = false){
return \LawFormsUSA\Flags\Flags::get($flag, $encrypted, $default);
}
}
\ No newline at end of file
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!