rtcamp / rt-lib

rt-lib is (intended to be) collection of reusable PHP classes useful for WordPress plugin/theme projects

rtLib

Contributors: rtcamp, rahul286, dipeshkakadiya, utkarshpatel, faishal, desaiuditd
Tags: library, autoloader, [database model](https://wordpress.org/plugins/tags/database model), [database updater](https://wordpress.org/plugins/tags/database updater), attributes, [user groups](https://wordpress.org/plugins/tags/user groups)
Requires at least: 3.6
Tested up to: 4.1
Stable tag: master
License: GPLv2 or later

Description

rtLib is library of class that are required in development of any WordPress plugins.

Following are some classes:

• RT_DB_Model
• RT_DB_Update
• RT_Plugin_Info
• RT_Plugin_Update_Checker
• RT_WP_Autoloader
• RT_Theme_Update_Checker
• RT_Email_Template
• RT_Attributes

NOTE: Development in progress

Inspired from https://github.com/zendframework/zf2/tree/master/library/Zend/

To add it in your plugin/theme

git subtree add --prefix app/lib https://github.com/rtCamp/rt-lib.git master --squash

To update the library

git subtree pull --prefix app/lib https://github.com/rtCamp/rt-lib.git master --squash

Add following line in plugin loader file

include_once 'app/lib/rt-lib.php';

Alternatively you can add as a plugin also

** License **

Same [GPL] (http://www.gnu.org/licenses/gpl-2.0.txt) that WordPress uses!

Coming soon:

• Private Attributes Support

See room for improvement?

Great! There are several ways you can get involved to help make Stream better:

1. Report Bugs: If you find a bug, error or other problem, please report it! You can do this by creating a new topic in the issue tracker.
2. Suggest New Features: Have an awesome idea? Please share it! Simply create a new topic in the issure tracker to express your thoughts on why the feature should be included and get a discussion going around your idea.

Changelog

1.5

• Mailbox filters added
• Logging error updated
• Term meta migration added and function updated for WordPress 4.4 support
• Cron updated
• Email Message id and reference id logic added for mailbox thread

1.4

• Mailbox bug fixes
• Mailbox inline images fix

1.3

• Mailbox Library Refactor
• Importer Library Refactor

1.2

• Mailbox Library

0.9

• Rt_Products Refactor & Bug Fixes

0.8

• RT Product Sync Library Added
• Travis Config updated for WordPress Coding Standards
• User Group Bug Fixes & additional method added to get users by term id.

0.7

• A Few bug fixes for RT_LIB_FILE constant
• DB Update Key changed for User Groups

0.6

• Test Cases updated & Code Sniffer Config updated & pre-commit hook updated

0.5

• Initial Basic Libraries.

Does this interest you?

rt-lib's Issues

PHP 5.5 and WordPress Beta Test

https://travis-ci.org/rtCamp/rt-lib

If Travis supports PHP 5.5 test and WordPress beta releases (3.9 beta for example), it would be nice.

Email Reply Parser

Some good examples here: http://stackoverflow.com/a/2193937/156336
Also https://github.com/willdurand/EmailReplyParser

We can polish our internal CRM library as well and make it available for reuse.

Composer support

We need to use composer - https://rtcamp.com/tutorials/composer-wordpress/

It will be good to have every class as separate composer package in future.

Remove/Replace __DIR__ magic constants

Ref : https://github.com/rtCamp/rt-lib/blob/develop/rt-user-groups/class-rt-user-group.php#L22

No need to use realpath(__DIR__.'/../').'/ because we can use relative path and __DIR__ introduced in php 5.4, WordPress support php 5.2.4 - So it is throwing error for user who are on php 5.3 or older version

__DIR__ is actually equivalent to realpath(dirname(__FILE__)) , To ensure the DIR constant is defined for PHP 4.0.6 and newer use following snippet
(@__DIR__ == '__DIR__') && define('__DIR__', realpath(dirname(__FILE__)));

RT_Attribute Module : Support for Private Attributes (Only for Back-End Use)

• Private Attributes : This remains only in WordPress Back-end for admin use purpose only
• Public Attributes : By default all attributes will be public.

Mailbox Changes

• Change Label to Mailbox : Ref
• Enqueue script/style on proper hooks : Ref
• Add filter for tabs. Someone would want to add custom tabs : Ref
• Add action for tab content in reference to above custom tabs : Ref
• Move all such independent functions to single file. You may name it rt-mailbox-functions.php : Ref
• Move out this class. It is no longer a helper class in rtMailbox context : Ref
• Remove this debug line : Ref
• Rename this folder to settings. Those classes are not templates : Ref

Don't use &$this

From PHP 5 onwards, all objects are passed by reference, so &$this is redundant. This is a common pattern with add_action/add_filter calls (since the callback is an array), but should just the bare $this instead. Read More

Relative Dates

See: http://momentjs.com/

In many project we need relative dates.

I am not sure if this will make sense as a PHP class!

PHP Notice : Constant WP_HELPER_FILE already defined

https://github.com/rtCamp/rt-lib/blob/master/wp-helpers.php#L27

Here the constant is defined without the check of defined() which is resulting in a PHP Notice.