Drush integration of views. More...
Go to the source code of this file.
Functions | |
| views_drush_help ($section) | |
| Implement hook_drush_help(). | |
| views_drush_command () | |
| Implement hook_drush_command(). | |
| views_revert_views () | |
| Callback function for views-revert command. | |
| views_revert_allviews ($views) | |
| Reverts all views. | |
| views_revert_view ($view) | |
| Revert a specified view. | |
| views_development_settings () | |
| Change the settings to a more developer oriented value. | |
| drush_views_list () | |
| Callback function for views-list command. | |
| drush_views_analyze () | |
| drush_views_enable () | |
| Enables views. | |
| drush_views_disable () | |
| Disables views. | |
| _views_drush_changestatus ($viewnames=array(), $status=NULL) | |
| views_drush_cache_clear (&$types) | |
| Adds a cache clear option for views. | |
Drush integration of views.
* drush cache-clear views - Clears the views specific caches. * views-revert - Drush command to revert views overridden in the system.
Definition in file views.drush.inc.
| drush_views_disable | ( | ) |
Disables views.
Definition at line 449 of file views.drush.inc.
{
$viewnames = _convert_csv_to_array(func_get_args());
// Return early if no view names were specified.
if (empty($viewnames)) {
return drush_set_error(dt('Please specify a space delimited list of view names to disable'));
}
_views_drush_changestatus($viewnames, TRUE);
}
| drush_views_enable | ( | ) |
Enables views.
Definition at line 437 of file views.drush.inc.
{
$viewnames = _convert_csv_to_array(func_get_args());
// Return early if no view names were specified.
if (empty($viewnames)) {
return drush_set_error(dt('Please specify a space delimited list of view names to enable'));
}
_views_drush_changestatus($viewnames, FALSE);
}
| drush_views_list | ( | ) |
Callback function for views-list command.
Definition at line 255 of file views.drush.inc.
References views_get_all_views().
{
// Initialize stuf
$rows = array();
$disabled_views = array();
$enabled_views = array();
$overridden = 0;
$indb = 0;
$incode = 0;
$disabled = 0;
$total = 0;
$views = views_get_all_views();
// get the --name option
// TODO : take into account the case off a comma-separated list of names
$name = drush_get_option_list('name');
$with_name = !empty($name) ? TRUE : FALSE;
// get the --tags option
$tags = drush_get_option_list('tags');
$with_tags = !empty($tags) ? TRUE : FALSE;
// get the --status option
// store user input appart to reuse it after
$status_opt = drush_get_option_list('status');
// use the same logic than $view->disabled
if (in_array('disabled', $status_opt)) {
$status = TRUE;
$with_status = TRUE;
}
elseif (in_array('enabled', $status_opt)) {
$status = FALSE;
$with_status = TRUE;
}
else {
$status = NULL;
// wrong or empty --status option
$with_status = FALSE;
}
// get the --type option
$type = drush_get_option_list('type');
// use the same logic than $view->type
$with_type = FALSE;
if (in_array('normal', $type) || in_array('default', $type)|| in_array('overridden', $type)) {
$with_type = TRUE;
}
// set the table headers
$header = array(
dt('Machine name'),
dt('Description'),
dt('Type'),
dt('Status'),
dt('Tag'),
);
// setup a row for each view
foreach($views as $id => $view){
// if options were specified, check that first
// mismatch push the loop to the next view
if ($with_tags && !in_array($view->tag, $tags)) {
continue;
}
if ($with_status && !$view->disabled == $status) {
continue;
}
if ($with_type && strtolower($view->type) !== $type[0]) {
continue;
}
if ($with_name && !stristr($view->name, $name[0])) {
continue;
}
$row = array();
// each row entry should be in the same order as the header
$row[] = $view->name;
$row[] = $view->description;
$row[] = $view->type;
$row[] = $view->disabled ? dt('Disabled') : dt('Enabled');
$row[] = $view->tag;
// place the row in the appropiate array,
// so we can have disabled views at the bottom
if($view->disabled) {
$disabled_views[] = $row;
}
else{
$enabled_views[] = $row;
}
unset($row);
// gather some statistics
switch($view->type) {
case dt('Normal'):
$indb++;
break;
case dt('Overridden'):
$overridden++;
break;
case dt('Default'):
$incode++;
break;
}
$total++;
}
$disabled = count($disabled_views);
// sort alphabeticaly
asort($disabled_views);
asort($enabled_views);
// if options were used
$summary = "";
if ($with_name || $with_tags || $with_status || $with_type) {
$summary = "Views";
if ($with_name) {
$summary .= " named $name[0]";
}
if ($with_tags) {
$tags = implode(" or ", $tags);
$summary .= " tagged $tags";
}
if ($with_status) {
$status_opt = implode("", $status_opt);
$summary .= " which status is '$status_opt'";
}
if ($with_type) {
$type = ucfirst($type[0]);
$summary .= " of type '$type'";
}
}
if (!empty($summary)) {
drush_print($summary . "\n");
}
// print all rows as a table
if ($total > 0) {
$rows = array_merge($enabled_views, $disabled_views);
// put the headers as first row
array_unshift($rows, $header);
drush_print_table($rows, TRUE);
}
// print the statistics messages
drush_print(dt("A total of @total views were found in this Drupal installation:", array('@total' => $total)));
drush_print(dt(" @indb views reside only in the database", array('@indb' => $indb )));
drush_print(dt(" @over views are overridden", array('@over' => $overridden)));
drush_print(dt(" @incode views are in their default state", array('@incode' => $incode)));
drush_print(dt(" @dis views are disabled\n", array('@dis' => $disabled)));
}
| views_development_settings | ( | ) |
Change the settings to a more developer oriented value.
Definition at line 235 of file views.drush.inc.
{
variable_set('views_ui_show_listing_filters', TRUE);
variable_set('views_ui_show_master_display', TRUE);
variable_set('views_ui_show_advanced_column', TRUE);
variable_set('views_ui_always_live_preview_button', TRUE);
variable_set('views_ui_show_preview_information', TRUE);
variable_set('views_ui_show_sql_query', TRUE);
variable_set('views_ui_show_performance_statistics', TRUE);
variable_set('views_show_additional_queries', TRUE);
variable_set('views_devel_output', TRUE);
variable_set('views_devel_region', 'message');
variable_set('views_ui_display_embed', TRUE);
$message = dt("Setup the new views settings.");
drush_log($message, 'success');
}
| views_drush_cache_clear | ( | &$ | types | ) |
Adds a cache clear option for views.
Definition at line 493 of file views.drush.inc.
{
$types['views'] = 'views_invalidate_cache';
}
| views_drush_command | ( | ) |
Implement hook_drush_command().
Definition at line 32 of file views.drush.inc.
{
$items = array();
$items['views-revert'] = array(
'callback' => 'views_revert_views',
'drupal dependencies' => array('views'),
'description' => 'Revert overridden views to their default state. Make sure to backup first.',
'arguments' => array(
'views' => 'A space delimited list of view names.',
),
'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
'aliases' => array('vr'),
'examples' => array(
'drush vr archive' => 'Reverts the "archive" view.',
'drush rln archive frontpage' => 'Reverts the "archive" and "frontpage" view.',
'drush vr' => 'Will present you with a list of overridden views to choose from, and an option to revert all overridden views.',
),
);
$items['views-dev'] = array(
'callback' => 'views_development_settings',
'drupal dependencies' => array('views'),
'description' => 'Setup the views settings to a more developer oriented value..',
'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
'aliases' => array('vd'),
);
$items['views-list'] = array(
'drupal dependencies' => array('views'),
'description' => 'Get a list of all views in the system.',
'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
'aliases' => array('vl'),
'options' => array(
'name' => 'String contained in view\'s name by which filter the results.',
'tags' => 'A comma-separated list of views tags by which to filter the results.',
'status' => 'Status of the views by which to filter the results. Choices: enabled, disabled.',
'type' => 'Type of the views by which to filter the results. Choices: normal, default or overridden.',
),
'examples' => array(
'drush vl' => 'Show a list of all available views.',
'drush vl --name=blog' => 'Show a list of views which names contain "blog".',
'drush vl --tags=tag1,tag2' => 'Show a list of views tagged with "tag1" or "tag2".',
'drush vl --status=enabled' => 'Show a list of enabled views.',
'drush vl --type=overridden' => 'Show a list of overridden views.',
),
);
$items['views-analyze'] = array(
'drupal dependencies' => array('views', 'views_ui'),
'description' => 'Get a list of all Views analyze warnings',
'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
'aliases' => array('va'),
);
$items['views-enable'] = array(
'drupal dependencies' => array('views'),
'description' => 'Enable the specified views.',
'arguments' => array(
'views' => 'A space delimited list of view names.',
),
'aliases' => array('ven'),
'examples' => array(
'drush ven frontpage taxonomy_term' => 'Enable the frontpage and taxonomy_term views.',
),
);
$items['views-disable'] = array(
'drupal dependencies' => array('views'),
'description' => 'Disable the specified views.',
'arguments' => array(
'views' => 'A space delimited list of view names.',
),
'aliases' => array('vdis'),
'examples' => array(
'drush vdis frontpage taxonomy_term' => 'Disable the frontpage and taxonomy_term views.',
),
);
return $items;
}
| views_drush_help | ( | $ | section | ) |
Implement hook_drush_help().
Definition at line 13 of file views.drush.inc.
{
switch ($section) {
case 'drush:views-revert':
$help = dt('Reverts views in the drupal installation that have been overriden. ');
$help .= dt('If no view names are specified, you will be presented with a list of overridden views to choose from. ');
$help .= dt('To revert all views, do not specify any view names, and choose the option "All" from the options presented.');
return $help;
case 'drush:views-list':
return dt('Show a list of available views with information about them.');
case 'drush:views-enable':
return dt('Enable the specified views. Follow the command with a space delimited list of view names');
case 'drush:views-disable':
return dt('Disable the specified views. Follow the command with a space delimited list of view names');
}
}
| views_revert_allviews | ( | $ | views | ) |
Reverts all views.
| $views | All views in the system as provided by views_get_all_views(). |
Definition at line 191 of file views.drush.inc.
References views_revert_view().
Referenced by views_revert_views().
{
$i = 0;
foreach ($views as $view) {
if ($view->disabled) {
continue;
}
if ($view->type == t('Overridden')) {
views_revert_view($view);
$i++;
}
}
return $i;
}
| views_revert_view | ( | $ | view | ) |
Revert a specified view.
| $view | The view object to be reverted |
Checks on wether or not the view is overridden is handled in views_revert_views_revert() We perform a check here anyway in case someone somehow calls this function on their own...
Definition at line 214 of file views.drush.inc.
Referenced by views_revert_allviews(), and views_revert_views().
{
// check anyway just in case
if ($view->type == t('Overridden')) {
// Revert the view.
$view->delete();
// Clear its cache.
ctools_include('object-cache');
ctools_object_cache_clear('view', $view->name);
// Give feedback.
$message = dt("Reverted the view '@viewname'", array('@viewname' => $view->name));
drush_log($message, 'success');
// Reverted one more view.
}
else {
drush_set_error(dt("The view '@viewname' is not overridden.", array('@viewname' => $view->name)));
}
}
| views_revert_views | ( | ) |
Callback function for views-revert command.
Definition at line 112 of file views.drush.inc.
References views_get_all_views(), views_revert_allviews(), and views_revert_view().
{
$views = views_get_all_views();
$i = 0;
// The provided views names specified in the command.
$viewnames = _convert_csv_to_array(func_get_args());
// Find all overridden views.
foreach ($views as $view) {
if ($view->disabled) {
continue;
}
if ($view->type == dt('Overridden')) {
$overridden[$view->name] = $view->name;
}
}
// Return early if there are no overridden views in the system.
if (empty($overridden)) {
return drush_set_error(dt('There are no overridden views in the system.'));
}
// If the user specified in the command the views to be overridden.
if (!empty($viewnames)) {
foreach ($viewnames as $key => $viewname) {
$is_overridden = key_exists($viewname, $overridden);
// Check if the provided view name is in the system
if ($viewname && !key_exists($viewname, $views)) {
drush_set_error(dt("'@viewname' view is not present in the system.", array('@viewname' => $viewname)));
}
// Check if the provided view is overridden.
elseif (!$is_overridden) {
drush_set_error(dt("The view specified '@viewname' is not overridden.", array('@viewname' => $viewname)));
}
// If the view is overriden, revert it.
elseif ($is_overridden){
views_revert_view($views[$viewname]);
$i++;
}
// We should never get here but well...
else {
drush_set_error(dt("The view specified '@viewname' is not provided in code, and thus cannot be reverted.", array('@viewname' => $viewname)));
}
}
}
// The user did not specify any views in the command, prompt the user
else {
// list of choices for the user
$overridden['all'] = dt('Revert all overridden views'); // add a choice at the end
$choice = drush_choice($overridden, 'Enter a number to choose which view to revert.', '!key'); // prompt the user
if ($choice !== FALSE) {
// revert all views option
if ($choice == 'all') {
$i = views_revert_allviews($views);
}
// else the user specified a single view
else {
views_revert_view($views[$choice]);
$i++;
}
}
}
// final results output
if ($i == 0) {
drush_log(dt('No views were reverted.'), 'ok');
}
else {
drush_log(dt('Reverted a total of @count views.', array('@count' => $i)), 'ok');
}
}
1.7.1