svyatov/yii-shortcut

Shortcuts for Yii framework

Y

Shortcuts for Yii framework v1.1, _(*1)

Install

via Composer (recommended)

php composer.phar require svyatov/yii-shortcut '~2.0', _(*2)

via download

Get the latest release and put Y.php file in your application protected/components folder., _(*3)

Usage

Creating URL by route in a widget

// Standart code
Yii::app()->controller->createUrl('user/login');

// Y code
Y::url('user/login');

Get/set some cache value

// Standart code
Yii::app()->cache->get('user_settings');
Yii::app()->cache->set('user_settings', $userSettings);

// Y code
Y::getCache('user_settings');
Y::setCache('user_settings', $userSettings);

The same with cookies

// Y code
Y::getCookie('user_settings');
Y::setCookie('user_settings', $userSettings);

Getting the value of CSRF token

// Standart code
Yii::app()->request->csrfToken;

// Y code
Y::csrf();

Inserting CSRF name and token in some jQuery request

// Standart code






// Y code

Quick variable dump with code highlighting

// Standart code
echo '

<

pre>';
CVarDumper::dump($testVariable, 10, true);
Yii::app()->end();

// Y code
Y::dump($testVariable);

Short action ending without template rendering (e.g. for AJAX requests)

// Standart code
echo $result;
Yii::app()->end();
// or
echo json_encode($result);
Yii::app()->end();

// Y code
Y::end($result);
// or
Y::endJson($result);

Redirects

// Standart code
$this->redirect($this->createUrl('user/settings')); // the shortest example
Yii::app()->request->redirect(Yii::app()->controller->createUrl('user/settings')); // if we inside some widget

// Y code
Y::redirect('user/settings'); // you can use wherever you want, controller/widget, it doesn't matter

Detecting current user status (is he a guest or is he authenticated)

// Standart code
if (Yii::app()->user->isGuest) {} // is user a guest?
// or
if (!Yii::app()->user->isGuest) {} // is user authenticated?

// Y code
if (Y::isGuest()) {} // is user a guest?
// or
if (Y::isAuthenticated()) {} // is user authenticated?
// the code speaks for himself, it's more expressive and readable

As you can see, the amount of code becomes at least 2 times smaller. So you need to type at least 2 times less and you can read it and understand it at least 2 times faster., _(*4)

Changelog

• v2.0.0 / 26.08.2014, _(*5)

  new Added new methods: module() and component()., _(*6)

  chg Removed protected method _getComponent()., _(*7)

  chg Removed method getRequest()., _(*8)

  chg Protected method _getValueByComplexKeyFromArray() renamed to getValueByComplexKeyFromArray() and changed to public., _(*9)

  chg Methods getGet(), getPost() and getFiles() renamed to GET(), POST() and FILES() respectively., _(*10)

  chg Method isAuthed() renamed to isAuthenticated()., _(*11)

  chg Method redir() renamed to redirect()., _(*12)

  chg Method flashRedir() renamed to flashAndRedirect()., _(*13)

  chg Methods redirAuthed() and redirGuest() renamed to redirectIfAuthenticated() and redirectIfGuest() respectively., _(*14)

  chg Method hasAccess() renamed to checkAccess()., _(*15)

  chg Setters, getters and deleters for cache, cookie and session renamed to comply common pattern, e.g.: cacheSet() -> setCache()., _(*16)

• v1.3.2 / 05.05.2014, _(*17)

  fix Composer autoloading fixed., _(*18)

  chg Scope of _getComponent() and _getValueByComplexKeyFromArray() methods changed to protected., _(*19)

  chg README.md enhanced and style updated., _(*20)

  chg phpDoc comments light reformat., _(*21)

• v1.3.1 / 28.09.2013, _(*22)

  fix Fixed urls to repo. No code changed., _(*23)

• v1.3.0 / 12.07.2013, _(*24)

  new Everything is translated to English., _(*25)

  new Added LICENSE file., _(*26)

  chg Updated composer.json file., _(*27)

  chg Added second argument $options to cookieDelete() method., _(*28)

  chg Added $secure and $httpOnly arguments to cookieSet() method. Besides, $value argument could be an instance of CHttpCookie class now., _(*29)

  chg CSRF token name in method csrfJsParam() now quoted., _(*30)

  chg Default $message argument value in flash() method changed to 'false' so now there is a way to remove flash message by passing 'null' as $message argument., _(*31)

  chg Added $params and $allowCaching arguments to hasAccess() method. It doesn't change previous behaviour but extending method abilities., _(*32)

  chg Code refactoring., _(*33)

• v1.2.1 / 25.01.2012, _(*34)

  new Added method getFile()., _(*35)

• v1.2.0 / 20.10.2011, _(*36)

  new Added methods: format, script, session, sessionGet, sessionSet, sessionDelete., _(*37)

  new Added internal caching of application components., _(*38)

  chg cookieDelete() method now returns the object of removed cookie (like the original method)., _(*39)

• v1.1.5 / 29.09.2011, _(*40)

  new Added method dbCmd()., _(*41)

  fix Fixed errors in @since phpDoc tags., _(*42)

• v1.1.4 / 27.09.2011, _(*43)

  fix Fixed bug in cookieSet() method, which prevents setting cookie if there was no $expire argument., _(*44)

  chg Cookie methods now use native methods of the CCookieCollection class., _(*45)

• v1.1.3 / 19.07.2011, _(*46)

  new Added methods: getGet, getPost, getRequest, getPdo, hasFlash., _(*47)

  chg cache(), cacheDelete(), cacheGet(), cacheSet() methods now have $cacheId argument, which gives the ability to select different cache backends., _(*48)

  chg Added $options argument to endJson() method, which gives the ability to pass options to native json_encode() function., _(*49)

  chg More "magic" removed. Code refactoring., _(*50)

• v1.1.0 / 29.05.2011, _(*51)

  new Added methods: isAjaxRequest, isPutRequest, isDeleteRequest, isPostRequest, isSecureConnection., _(*52)

  new Added changelog to README. README.markdown renamed to README.md, _(*53)

  chg Removed almost every "magic" inside methods., _(*54)

  chg Added $absolute argument to baseUrl() method, which gives the ability to get absolute URL instead of relative one., _(*55)

  chg Added $default argument to cookieGet() method, which gives the ability to return value of $default variable if cookie with specified name doesn't exist., _(*56)

  chg Added $default argument to param() method, which gives the ability to return value of $default variable if parameter with specified name doesn't exist. Also, method code refactored., _(*57)

  chg Fixed and enhanced phpDoc comments., _(*58)

• v1.0.4 / 05.01.2011, _(*59)

  chg Code refactoring. Class uploaded to GitHub., _(*60)

• v1.0.3 / 16.12.2010, _(*61)

  fix Fixed bug in param() method., _(*62)

• v1.0.2 / 16.12.2010, _(*63)

  new Added method hasAccess()., _(*64)

  new Enhanced method param(). Now key could contain dot delimited string to access nested variables. For example: 'site.title' returns value at param['site']['title']. Thanks for idea to sergebezborodov., _(*65)

  chg Code refactoring., _(*66)